HttpApiDefinition - AWS Serverless Application Model

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

HttpApiDefinition

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

Syntax

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

YAML

Bucket: String Key: String Version: String

Properties

Bucket

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

タイプ: 文字列

必須: はい

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

Key

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

タイプ: 文字列

必須: はい

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

Version

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

タイプ: 文字列

必須: いいえ

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

Examples

定義 URI の例

API 定義の例

YAML

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