Skip to content

EndpointConfiguration

Used by
Source code in docs_src/capo_api_gateway/types/endpoint_configuration.py 
13
14
15
16
17
18
19
20
21
class EndpointConfiguration(TypedDict, closed=True):
    types: NotRequired[
        "capo_api_gateway.types.list_of_endpoint_type.ListOfEndpointType"
    ]
    """<p>A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is <code>"EDGE"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>.</p>"""
    ip_address_type: NotRequired["capo_api_gateway.types.ip_address_type.IpAddressType"]
    """<p>The IP address types that can invoke an API (RestApi) or a DomainName. Use <code>ipv4</code> to allow only IPv4 addresses to invoke an API or DomainName, or use <code>dualstack</code> to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the <code>PRIVATE</code> endpoint type, only <code>dualstack</code> is supported.</p>"""
    vpc_endpoint_ids: NotRequired["capo_api_gateway.types.list_of_string.ListOfString"]
    """<p>A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for <code>PRIVATE</code> endpoint type.</p>"""

ip_address_type instance-attribute 

ip_address_type: NotRequired[IpAddressType]

The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.

types instance-attribute 

types: NotRequired[ListOfEndpointType]

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

vpc_endpoint_ids instance-attribute 

vpc_endpoint_ids: NotRequired[ListOfString]

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.