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 上指定了全局授权方并希望将特定的 函数设为公开,请通过将 Authorizer 设置为 NONE 来覆盖。

类型: 字符串

必需: 否

兼容性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 上为此路径配置资源策略。

类型: ResourcePolicyStatement

必需: 否

兼容性AWS CloudFormation: 此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

示例

函数身份验证

以下示例指定函数级授权。

YAML

Auth: ApiKeyRequired: true Authorizer: NONE