Skip to content

EndpointConfigurationDict

Dictionary Type

EndpointConfigurationDict

Bases: TypedDict

Dictionary form of EndpointConfiguration.

Attributes

ip_address_type instance-attribute
ip_address_type: str | None

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: Sequence[str] | None

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: Sequence[str] | None

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