AWS::ApiGateway::DomainName EndpointConfiguration

The EndpointConfiguration property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.

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

Syntax

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

JSON


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

YAML


  IpAddressType: String
  Types: 
    - String

Properties

IpAddressType

The IP address types that can invoke this DomainName. Use ipv4 to allow only IPv4 addresses to invoke this DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke this DomainName. For the PRIVATE endpoint type, only dualstack is supported.

Required: No

Type: String

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.