aws-cdk-lib.aws_apigateway.CfnDomainNameV2.EndpointConfigurationProperty

EndpointConfigurationProperty Struct

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.

Source

Generated code

Type last changed

v2.191.0 · 23 Apr 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const endpointConfigurationProperty: apigateway.CfnDomainNameV2.EndpointConfigurationProperty = {
  ipAddressType: 'ipAddressType',
  types: ['types'],
};

Properties

ipAddressTypestringip_address_typestripAddressTypeStringIpAddressTypestringIpAddressType*string#

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.

typesstring[]typestyping.List[str]typesList<String>Typesstring[]Types*[]*string#

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 .