aws-cdk-lib.aws_apigateway.CfnDomainName.EndpointConfigurationProperty

interface EndpointConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnDomainName.EndpointConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDomainName_EndpointConfigurationProperty
Javasoftware.amazon.awscdk.services.apigateway.CfnDomainName.EndpointConfigurationProperty
Pythonaws_cdk.aws_apigateway.CfnDomainName.EndpointConfigurationProperty
TypeScript aws-cdk-lib » aws_apigateway » CfnDomainName » EndpointConfigurationProperty

The EndpointConfiguration property type specifies the endpoint 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 = {
  types: ['types'],
};

Properties

NameTypeDescription
types?string[]A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

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 .