Class EndpointConfiguration

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

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()

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EndpointConfiguration : IEndpointConfiguration

Syntax (vb)

Public Class EndpointConfiguration Implements IEndpointConfiguration

Remarks

EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.

ExampleMetadata: infused

Examples

IVpcEndpoint someEndpoint;


             var api = new RestApi(this, "api", new RestApiProps {
                 EndpointConfiguration = new EndpointConfiguration {
                     Types = new [] { EndpointType.PRIVATE },
                     VpcEndpoints = new [] { someEndpoint }
                 }
             });

Synopsis

Constructors

EndpointConfiguration()

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

Properties

IpAddressType	The IP address types that can invoke the API.
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()

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

public EndpointConfiguration()

Remarks

EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.

ExampleMetadata: infused

Examples

IVpcEndpoint someEndpoint;


             var api = new RestApi(this, "api", new RestApiProps {
                 EndpointConfiguration = new EndpointConfiguration {
                     Types = new [] { EndpointType.PRIVATE },
                     VpcEndpoints = new [] { someEndpoint }
                 }
             });

Properties

IpAddressType

The IP address types that can invoke the API.

public IpAddressType? IpAddressType { get; set; }

Property Value

IpAddressType?

Remarks

Default: undefined - AWS default is DUAL_STACK for private API, IPV4 for all other APIs.

See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-ip-address-type.html

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.

Implements

IEndpointConfiguration