interface EndpointConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnDomainNameV2PropsMixin.EndpointConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnDomainNameV2PropsMixin_EndpointConfigurationProperty |
 Java | software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnDomainNameV2PropsMixin.EndpointConfigurationProperty |
 Python | aws_cdk.mixins_preview.aws_apigateway.mixins.CfnDomainNameV2PropsMixin.EndpointConfigurationProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_apigateway » mixins » CfnDomainNameV2PropsMixin » EndpointConfigurationProperty |
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.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const endpointConfigurationProperty: apigateway_mixins.CfnDomainNameV2PropsMixin.EndpointConfigurationProperty = {
ipAddressType: 'ipAddressType',
types: ['types'],
};
Properties
| Name | Type | Description |
|---|---|---|
| ip | string | The IP address types that can invoke an API (RestApi) or a 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 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?
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 .