Class CfnRestApi.EndpointConfigurationProperty

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

The EndpointConfiguration property type specifies the endpoint types of a REST API.

public class CfnRestApi.EndpointConfigurationProperty : CfnRestApi.IEndpointConfigurationProperty

Inheritance

object

CfnRestApi.EndpointConfigurationProperty

Implements

CfnRestApi.IEndpointConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var endpointConfigurationProperty = new EndpointConfigurationProperty {
                 Types = new [] { "types" },
                 VpcEndpointIds = new [] { "vpcEndpointIds" }
             };

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html

ExampleMetadata: fixture=_generated

Constructors

EndpointConfigurationProperty()

public EndpointConfigurationProperty()

Properties

Types

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

public string[]? Types { get; set; }

Property Value

string[]

Remarks

For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types

VpcEndpointIds

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.

public string[]? VpcEndpointIds { get; set; }

Property Value

string[]

Remarks

It is only supported for PRIVATE endpoint type.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids