Interface IEndpointConfiguration
- Namespace
- Amazon.CDK.AWS.APIGateway
- Assembly
- Amazon.CDK.AWS.APIGateway.dll
The endpoint configuration of a REST API, including VPCs and endpoint types.
public interface IEndpointConfiguration
Examples
var api = new RestApi(this, "api", new RestApiProps {
EndpointConfiguration = new EndpointConfiguration {
Types = new [] { EndpointType.EDGE }
}
});
Remarks
EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
ExampleMetadata: infused
Properties
Types
A list of endpoint types of an API or its custom domain name.
EndpointType[] Types { get; }
Property Value
Remarks
Default: EndpointType.EDGE
VpcEndpoints
A list of VPC Endpoints against which to create Route53 ALIASes.
IVpcEndpoint[]? VpcEndpoints { get; }
Property Value
- IVpcEndpoint[]
Remarks
Default: - no ALIASes are created for the endpoint.