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

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

ApiFunctionAuth

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

语法

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

属性

ApiKeyRequired

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

类型:布尔值

必需: 否

AWS CloudFormation 相容性: 此属性对于 AWS SAM 并且没有 AWS CloudFormation 同等产品。

AuthorizationScopes

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

您指定的范围将覆盖由 DefaultAuthorizer 属性。

类型:列表

必需: 否

AWS CloudFormation 相容性: 此属性对于 AWS SAM 并且没有 AWS CloudFormation 同等产品。

Authorizer

Authorizer 特定职能部门的

如果您已在API上指定了全局授权程序,并希望将特定功能设为公开,则可通过设置覆盖 AuthorizerNONE.

类型:字符串

必需: 否

AWS CloudFormation 相容性: 此属性对于 AWS SAM 并且没有 AWS CloudFormation 同等产品。

InvokeRole

指定 InvokeRole 用于 AWS_IAM 授权。

类型:字符串

必需: 否

默认值CALLER_CREDENTIALS

AWS CloudFormation 相容性: 此属性对于 AWS SAM 并且没有 AWS CloudFormation 同等产品。

其他备注: CALLER_CREDENTIALS 映射至 arn:aws:iam::*:user/*,使用呼叫者凭证调用终端。

ResourcePolicy

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

类型: 资源政策声明

必需: 否

AWS CloudFormation 相容性: 此属性对于 AWS SAM 并且没有 AWS CloudFormation 同等产品。

示例

功能验证

以下示例指定功能级别的授权。

YAML

Auth: ApiKeyRequired: true Authorizer: NONE