HttpApiDefinition

API を定義する OpenAPI ドキュメントです。

構文

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

YAML

  Bucket: String
  Key: String
  Version: String

プロパティ

Bucket

OpenAPI ファイルが保存されている Amazon S3 バケットの名前です。

タイプ: 文字列

必須: はい

AWS CloudFormation 互換性： このプロパティは、 AWS::ApiGatewayV2::Api BodyS3Location データ型の Bucketプロパティに直接渡されます。

Key

OpenAPI ファイルの Amazon S3 キーです。

タイプ: 文字列

必須: はい

AWS CloudFormation 互換性： このプロパティは、 AWS::ApiGatewayV2::Api BodyS3Location データ型の Keyプロパティに直接渡されます。

Version

バージョン管理されたオブジェクトの場合は、OpenAPI ファイルのバージョンです。

タイプ: 文字列

必須: いいえ

AWS CloudFormation 互換性： このプロパティは、 AWS::ApiGatewayV2::Api BodyS3Location データ型の Versionプロパティに直接渡されます。

例

定義 URI の例

API 定義の例

YAML

DefinitionUri:
  Bucket: mybucket-name
  Key: mykey-name
  Version: 121212