interface EndpointConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGateway.CfnDomainName.EndpointConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDomainName_EndpointConfigurationProperty |
 Java | software.amazon.awscdk.services.apigateway.CfnDomainName.EndpointConfigurationProperty |
 Python | aws_cdk.aws_apigateway.CfnDomainName.EndpointConfigurationProperty |
 TypeScript | aws-cdk-lib » aws_apigateway » CfnDomainName » EndpointConfigurationProperty |
The EndpointConfiguration property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.
EndpointConfiguration is a property of the AWS::ApiGateway::DomainName resource.
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.CfnDomainName.EndpointConfigurationProperty = {
ipAddressType: 'ipAddressType',
types: ['types'],
};
Properties
| Name | Type | Description |
|---|---|---|
| ip | string | The IP address types that can invoke this DomainName. |
| types? | string[] | A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). |
ipAddressType?
Type:
string
(optional)
The IP address types that can invoke this DomainName.
Use ipv4 to allow only IPv4 addresses to invoke this DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke this DomainName. For the PRIVATE endpoint type, only dualstack is supported.
types?
Type:
string[]
(optional)
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 .