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

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

ApiFunctionAuth

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

Syntax

要在您的Amazon Serverless Application Model(Amazon SAM) 模板,请使用以下语法。

Properties

ApiKeyRequired

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

类型:Boolean

必需:否

Amazon CloudFormation兼容性:对是唯一的Amazon SAM没有Amazon CloudFormation等效函数

AuthorizationScopes

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

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

类型:List

必需:否

Amazon CloudFormation兼容性:对是唯一的Amazon SAM没有Amazon CloudFormation等效函数

Authorizer

这些区域有:Authorizer对于特定函数

如果您已在 API 上指定了全局授权者并希望公开特定的函数,请通过设置AuthorizerNONE.

类型:String

必需:否

Amazon CloudFormation兼容性:对是唯一的Amazon SAM没有Amazon CloudFormation等效函数

InvokeRole

指定InvokeRole用于AWS_IAM授权。

类型:String

必需:否

默认值CALLER_CREDENTIALS

Amazon CloudFormation兼容性:对是唯一的Amazon SAM没有Amazon CloudFormation等效函数

附加说明CALLER_CREDENTIALS映射到arn:aws:iam::*:user/*,它使用调用者凭据来调用终端节点。

ResourcePolicy

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

类型资源策略声明

必需:否

Amazon CloudFormation兼容性:对是唯一的Amazon SAM没有Amazon CloudFormation等效函数

Examples

函数身份验证

下面的示例指定了函数级别的授权。

YAML

Auth: ApiKeyRequired: true Authorizer: NONE