AWS::ApiGateway::RestApi EndpointConfiguration - AWS CloudFormation

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, ... ], "VpcEndpointIds" : [ String, ... ] }

YAML

Types: - String VpcEndpointIds: - String

Properties

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