AWS CloudFormation
User Guide (Version )

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::ApiGateway::RestApi EndpointConfiguration

The EndpointConfiguration property type specifies the endpoint 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

{ "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.

Required: No

Type: List of String

Update requires: No interruption

See Also

  • RestApi in the Amazon API Gateway REST API Reference

On this page: