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.
Contents
- ipAddressType
-
The IP address types that can invoke an API (RestApi) or a DomainName. Use
ipv4to allow only IPv4 addresses to invoke an API or DomainName, or usedualstackto allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For thePRIVATEendpoint type, onlydualstackis supported.Type: String
Valid Values:
ipv4 | dualstackRequired: No
- types
-
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 isREGIONAL. For a private API, the endpoint type isPRIVATE.Type: Array of strings
Valid Values:
REGIONAL | EDGE | PRIVATERequired: No
- vpcEndpointIds
-
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for
PRIVATEendpoint type.Type: Array of strings
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
