EndpointConfiguration - AWS Serverless Application Model
構文プロパティ例

EndpointConfiguration

REST API のエンドポイントタイプです。

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。

YAML

  Type: String
  VPCEndpointIds: List

プロパティ

Type

REST API のエンドポイントタイプです。

有効な値: EDGE、REGIONAL、または PRIVATE

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::ApiGateway::RestApi EndpointConfiguration データ型の Types プロパティに直接渡されます。

VPCEndpointIds

Route53 エイリアスを作成する REST API の VPC エンドポイント ID のリストです。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::ApiGateway::RestApi EndpointConfiguration データ型の VpcEndpointIds プロパティに直接渡されます。

例

EndpointConfiguration

エンドポイント設定の例

YAML

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