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 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
-
VpcEndpointIds
-
A list of VPC endpoint IDs of an API (AWS::ApiGateway::RestApi) against which to create Route53 ALIASes. It is only supported for
PRIVATE
endpoint type.Required: No
Type: List of String
Update requires: No interruption
See also
-
RestApi in the Amazon API Gateway REST API Reference