Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon API Gateway Resource Types Reference » AWS::ApiGateway::RestApi » Amazon API Gateway RestApi EndpointConfiguration

Amazon API Gateway RestApi EndpointConfiguration

The EndpointConfiguration property type specifies the endpoint types of an Amazon API Gateway 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

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

YAML

Types: 
  - String

Properties

Types

A list of endpoint types of an API or its custom domain name. Valid values include:

  • EDGE: For an edge-optimized API and its custom domain name.

  • REGIONAL: For a regional API and its custom domain name.

  • PRIVATE : For a private API and its custom domain name.

Required: No

Type: List of String values

Update requires: No interruption

See Also

On this page: