本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
Api
描述 Api
事件源类型的对象。如果定义了 AWS::Serverless::Api 资源,则路径和方法值必须与 API 的 OpenAPI 定义中的操作相对应。
语法
要在 Amazon Serverless Application Model (Amazon SAM) 模板中声明此实体,请使用以下语法。
YAML
Auth:
ApiStateMachineAuth
Method:String
Path:String
RestApiId:String
UnescapeMappingTemplate:Boolean
属性
-
Auth
-
此 API、路径和方法的授权配置。
如果未指定
DefaultAuthorizer
,则使用此属性覆盖单个路径的 APIDefaultAuthorizer
设置,或者覆盖默认ApiKeyRequired
设置。必需:否
Amazon CloudFormation 兼容性:此属性是独有的 Amazon SAM ,没有 Amazon CloudFormation 等效属性。
-
Method
-
调用此函数的 HTTP 方法。
类型:字符串
必需:是
Amazon CloudFormation 兼容性:此属性是独有的 Amazon SAM ,没有 Amazon CloudFormation 等效属性。
-
Path
-
调用此函数的 URI 路径。值必须以
/
开头。类型:字符串
必需:是
Amazon CloudFormation 兼容性:此属性是独有的 Amazon SAM ,没有 Amazon CloudFormation 等效属性。
-
RestApiId
-
RestApi
资源的标识符,必须包含具有给定路径和方法的操作。通常,将其设置为引用此模板中定义的 AWS::Serverless::Api 资源。如果未定义此属性,则使用生成的
OpenApi
文档 Amazon SAM 创建默认AWS::Serverless::Api资源。该资源包含所有路径和方法的并集,这些路径和方法由同一模板中的Api
事件定义,但未指定RestApiId
。此属性无法引用在其他模板中定义的 AWS::Serverless::Api 资源。
类型:字符串
必需:否
Amazon CloudFormation 兼容性:此属性是独有的 Amazon SAM ,没有 Amazon CloudFormation 等效属性。
-
UnescapeMappingTemplate
-
在传递给状态机的输入上,通过将
\'
替换为'
来取消转义单引号。当输入包含单引号时使用。注意
如果设置为
False
并且输入包含单引号,则会发生错误。类型:布尔值
必需:否
默认值:False
Amazon CloudFormation 兼容性:此属性是独有的 Amazon SAM ,没有 Amazon CloudFormation 等效属性。
示例
ApiEvent
以下是 Api
类型事件的示例。
YAML
Events: ApiEvent: Type: Api Properties: Path: /path Method: get