interface EndpointConfiguration
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGateway.EndpointConfiguration |
 Java | software.amazon.awscdk.services.apigateway.EndpointConfiguration |
 Python | aws_cdk.aws_apigateway.EndpointConfiguration |
 TypeScript (source) | @aws-cdk/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
| Name | Type | Description |
|---|---|---|
| types | Endpoint[] | A list of endpoint types of an API or its custom domain name. |
| vpc | IVpc[] | A list of VPC Endpoints against which to create Route53 ALIASes. |
types
Type:
Endpoint[]
A list of endpoint types of an API or its custom domain name.
vpcEndpoints?
Type:
IVpc[]
(optional, default: no ALIASes are created for the endpoint.)
A list of VPC Endpoints against which to create Route53 ALIASes.