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

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

ApiDefinition

定义 API 的 OpenAPI 文档。

语法

要在您的Amazon Serverless Application Model(Amazon SAM) 模板，请使用以下语法。

YAML

  Bucket: String
  Key: String
  Version: String

属性

Bucket

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

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性将直接传递给Bucket的财产AWS::ApiGateway::RestApi S3Location数据类型。

Key

OpenAPI 文件的 Amazon S3 密钥。

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性将直接传递给Key的财产AWS::ApiGateway::RestApi S3Location数据类型。

Version

对于版本控制的对象，则为 OpenAPI 文件的版本。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性将直接传递给Version的财产AWS::ApiGateway::RestApi S3Location数据类型。

示例

示例定义

API 定义示例

YAML

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