Interface CfnRestApi.IEndpointConfigurationProperty

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

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IEndpointConfigurationProperty

Syntax (vb)

Public Interface IEndpointConfigurationProperty

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

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" }
};

Synopsis

Properties

Types	A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
VpcEndpointIds	A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.

Properties

Types

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

virtual string[] Types { get; }

Property Value

System.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.

virtual string[] VpcEndpointIds { get; }

Property Value

System.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