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

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

ApiStateMachineAuth

在事件级别为特定 API、路径和方法配置授权。

语法

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

属性

ApiKeyRequired

需要此 API、路径和方法的 API 密钥。

类型:Boolean

必需:否

Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项

AuthorizationScopes

要应用于此 API、路径和方法的授权范围。

您指定的作用域将覆盖DefaultAuthorizer属性(如果你已经指定了它)。

类型:List

必需:否

Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项

Authorizer

这些区域有:Authorizer对于特定的状态机。

如果您已经为 API 指定了全局授权者并希望将此状态机公开,请通过设置设置覆盖全局授权者AuthorizerNONE.

类型:字符串

必需:否

Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项

ResourcePolicy

为此 API 和路径配置资源策略。

类型资源策略声明

必需:否

Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项

示例

State Machine Auth

以下示例指定状态机级别的授权。

YAML

Auth: ApiKeyRequired: true Authorizer: NONE