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

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

Api

描述 Api 事件源类型。如果 AWS::Serverless::Api 资源,路径和方法值必须对应于 OpenAPI API的定义。

语法

若要在您的 AWS 无服务器应用程序模型 (AWS SAM)模板,请使用以下语法。

YAML

Auth: ApiStateMachineAuth Method: String Path: String RestApiId: String

属性

Auth

此API、路径和方法的授权配置。

使用此属性覆盖API的 DefaultAuthorizer 单个路径的设置,当 DefaultAuthorizer 或改写默认值 ApiKeyRequired 设置。

类型: ApiStateMachineAuth

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

Method

调用此功能的HTTP方法。

类型:字符串

必需: 是

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

Path

调用此函数的URI路径。该值必须以 /.

类型:字符串

必需: 是

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

RestApiId

的标识符 RestApi 资源,其中必须包含具有给定路径和方法的操作。通常,这设置为引用 AWS::Serverless::Api 在此模板中定义的资源。

如果不定义这个属性, AWS SAM 创建默认 AWS::Serverless::Api 使用生成的 OpenApi 文档。该资源包含所有路径和方法的联合,这些路径和方法由 Api 不指定 RestApiId.

此属性无法引用 AWS::Serverless::Api 在其他模板中定义的资源。

类型:字符串

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

示例

ApiEvent

以下是 Api 类型。

YAML

Events: ApiEvent: Type: Api Properties: Path: /path Method: get RequestParameters: - method.request.header.Authorization