EndpointConfiguration - AWS Serverless Application Model
SyntaxPropertiesExamples

EndpointConfiguration

The endpoint type of a REST API.

Syntax

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

YAML

  IpAddressType: String
  Type: String
  VPCEndpointIds: List

Properties

IpAddressType

The IP address types that can invoke an API (RestApi).

Valid values: ipv4 or dualstack

Type: String

Required: No

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

Type

The endpoint type of a REST API.

Valid values: EDGE or REGIONAL or PRIVATE

Type: String

Required: No

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

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