AWS::ApiGateway::RestApi EndpointConfiguration - AWS CloudFormation
SyntaxPropertiesSee also

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ApiGateway::RestApi EndpointConfiguration

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

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "IpAddressType" : String,
  "Types" : [ String, ... ],
  "VpcEndpointIds" : [ String, ... ]
}

YAML

  IpAddressType: String
  Types: 
    - String
  VpcEndpointIds: 
    - String

Properties

IpAddressType

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

Required: No

Type: String

Allowed values: ipv4 | dualstack

Update requires: No interruption

Types

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). 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.

Required: No

Type: Array of String

Update requires: No interruption

VpcEndpointIds

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

Required: No

Type: Array of String

Update requires: No interruption

See also

  • RestApi in the Amazon API Gateway REST API Reference