Class CfnRestApiPropsMixin.EndpointConfigurationProperty

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

Inheritance

object

CfnRestApiPropsMixin.EndpointConfigurationProperty

Implements

CfnRestApiPropsMixin.IEndpointConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ApiGateway

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnRestApiPropsMixin.EndpointConfigurationProperty : CfnRestApiPropsMixin.IEndpointConfigurationProperty

Syntax (vb)

Public Class CfnRestApiPropsMixin.EndpointConfigurationProperty Implements CfnRestApiPropsMixin.IEndpointConfigurationProperty

Remarks

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

See: 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.CfnPropertyMixins.AWS.ApiGateway;

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

Synopsis

Constructors

EndpointConfigurationProperty()

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

Properties

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

Constructors

EndpointConfigurationProperty()

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

public EndpointConfigurationProperty()

Remarks

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

See: 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.CfnPropertyMixins.AWS.ApiGateway;

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

Properties

IpAddressType

The IP address types that can invoke an API (RestApi).

public string? IpAddressType { get; set; }

Property Value

string

Remarks

Use ipv4 to allow only IPv4 addresses to invoke an API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API. For the PRIVATE endpoint type, only dualstack is supported.

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

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 .

See: 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 object[]? VpcEndpointIds { get; set; }

Property Value

object[]

Remarks

It is only supported for PRIVATE endpoint type.

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

Type union: (either string or IVPCEndpointRef)[]

Implements

CfnRestApiPropsMixin.IEndpointConfigurationProperty