EndpointConfiguration - Amazon Serverless Application Model
SyntaxPropertiesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

EndpointConfiguration

The endpoint type of a REST API.

Syntax

To declare this entity in your Amazon Serverless Application Model (Amazon SAM) template, use the following syntax.

YAML

  Type: String
  VPCEndpointIds: List

Properties

Type

The endpoint type of a REST API.

Valid values: EDGE or REGIONAL or PRIVATE

Type: String

Required: No

Amazon CloudFormation compatibility: This property is passed directly to the Types property of the AWS::ApiGateway::RestApi EndpointConfiguration data type.

VPCEndpointIds

A list of VPC endpoint IDs of a REST API against which to create Route53 aliases.

Type: List

Required: No

Amazon CloudFormation compatibility: This property is passed directly to the VpcEndpointIds property of the AWS::ApiGateway::RestApi EndpointConfiguration data type.

Examples

EndpointConfiguration

Endpoint Configuration example

YAML

EndpointConfiguration:
  Type: PRIVATE
  VPCEndpointIds:
    - vpce-123a123a
    - vpce-321a321a