Class EndpointConfiguration
The endpoint configuration of a REST API, including VPCs and endpoint types.
Inheritance
System.Object
EndpointConfiguration
Implements
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public class EndpointConfiguration : Object, IEndpointConfiguration
Syntax (vb)
Public Class EndpointConfiguration
Inherits Object
Implements 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
Constructors
EndpointConfiguration() |
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. |
Constructors
EndpointConfiguration()
public EndpointConfiguration()
Properties
Types
A list of endpoint types of an API or its custom domain name.
public EndpointType[] Types { get; set; }
Property Value
Remarks
Default: EndpointType.EDGE
VpcEndpoints
A list of VPC Endpoints against which to create Route53 ALIASes.
public IVpcEndpoint[] VpcEndpoints { get; set; }
Property Value
Remarks
Default: - no ALIASes are created for the endpoint.