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