EndpointConfiguration¶
Structure Class¶
dataclass
¶
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
Attributes¶
class-attribute
instance-attribute
¶
ip_address_type: IpAddressType | None = 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.
class-attribute
instance-attribute
¶
types: list[EndpointType] | None = 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.
class-attribute
instance-attribute
¶
vpc_endpoint_ids: list[str] | None = None
A list of VpcEndpointIds of an API (RestApi) against which to create
Route53 ALIASes. It is only supported for PRIVATE endpoint type.