aws-cdk-lib.aws_apigateway.EndpointConfiguration

interface EndpointConfiguration

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.EndpointConfiguration
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#EndpointConfiguration
Javasoftware.amazon.awscdk.services.apigateway.EndpointConfiguration
Pythonaws_cdk.aws_apigateway.EndpointConfiguration
TypeScript (source)aws-cdk-lib » aws_apigateway » EndpointConfiguration

The endpoint configuration of a REST API, including VPCs and endpoint types.

EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.

Example

const api = new apigateway.RestApi(this, 'api', {
  endpointConfiguration: {
    types: [ apigateway.EndpointType.EDGE ]
  }
});

Properties

NameTypeDescription
typesEndpointType[]A list of endpoint types of an API or its custom domain name.
vpcEndpoints?IVpcEndpoint[]A list of VPC Endpoints against which to create Route53 ALIASes.

types

Type: EndpointType[]

A list of endpoint types of an API or its custom domain name.


vpcEndpoints?

Type: IVpcEndpoint[] (optional, default: no ALIASes are created for the endpoint.)

A list of VPC Endpoints against which to create Route53 ALIASes.