Class EndpointConfiguration

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

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

public class EndpointConfiguration : IEndpointConfiguration

Inheritance

object

EndpointConfiguration

Implements

IEndpointConfiguration

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

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

EndpointType[]

Remarks

Default: EndpointType.EDGE

VpcEndpoints

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

public IVpcEndpoint[]? VpcEndpoints { get; set; }

Property Value

IVpcEndpoint[]

Remarks

Default: - no ALIASes are created for the endpoint.