HttpApiDefinition - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

HttpApiDefinition

定义 API 的 OpenAPI 文档。

语法

要在您的 Amazon Serverless Application Model (Amazon SAM) 模板中声明此实体,请使用以下语法。

YAML

Bucket: String Key: String Version: String

属性

Bucket

存储了 OpenAPI 文件的 Amazon S3 桶的名称。

类型:字符串

必需:是

Amazon CloudFormation 兼容性:此属性直接传递给 AWS::ApiGatewayV2::Api BodyS3Location 数据类型的 Bucket 属性。

Key

OpenAPI 文件的 Amazon S3 密钥。

类型:字符串

必需:是

Amazon CloudFormation 兼容性:此属性直接传递给 AWS::ApiGatewayV2::Api BodyS3Location 数据类型的 Key 属性。

Version

对于受版本控制的对象,是 OpenAPI 文件的版本。

类型:字符串

必需:否

Amazon CloudFormation 兼容性:此属性直接传递给 AWS::ApiGatewayV2::Api BodyS3Location 数据类型的 Version 属性。

示例

定义 Uri 示例

API 定义示例

YAML

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