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 密钥。

类型:布尔值

必需:否

Amazon CloudFormation 兼容性:此属性是独有的 Amazon SAM ,没有 Amazon CloudFormation 等效属性。

AuthorizationScopes

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

如果您已指定 DefaultAuthorizer 属性,则您指定的范围将覆盖该属性应用的所有范围。

类型:列表

必需:否

Amazon CloudFormation 兼容性:此属性是独有的 Amazon SAM ,没有 Amazon CloudFormation 等效属性。

Authorizer

适用于特定状态机的 Authorizer

如果您已为 API 指定了全局授权方并希望公开此状态机,请通过将 Authorizer 设置为 NONE 来覆盖全局授权方。

类型:字符串

必需:否

Amazon CloudFormation 兼容性:此属性是独有的 Amazon SAM ,没有 Amazon CloudFormation 等效属性。

ResourcePolicy

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

类型ResourcePolicyStatement

必需:否

Amazon CloudFormation 兼容性:此属性是独有的 Amazon SAM ,没有 Amazon CloudFormation 等效属性。

示例

StateMachine-身份验证

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

YAML

Auth: ApiKeyRequired: true Authorizer: NONE