本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
ApiFunctionAuth
在事件级别为特定 API、路径和方法配置授权。
语法
要在您的中声明此实体Amazon Serverless Application Model(Amazon SAM)模板,请使用以下语法。
YAML
ApiKeyRequired:BooleanAuthorizationScopes:ListAuthorizer:StringInvokeRole:StringResourcePolicy:ResourcePolicyStatement
属性
-
ApiKeyRequired -
需要此 API、路径和方法的 API 密钥。
类型:Boolean
必需:否
Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
-
AuthorizationScopes -
要应用于此 API、路径和方法的授权范围。
您指定的作用域将覆盖由
DefaultAuthorizer属性(如果你已经指定了它)。类型:List
必需:否
Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
-
Authorizer -
这些区域有:
Authorizer对于特定函数如果您已在 API 上指定了全局授权者并希望公开特定的函数,请通过设置
Authorizer到NONE.类型:字符串
必需:否
Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
-
InvokeRole -
指定
InvokeRole用于AWS_IAM授权。类型:字符串
必需:否
默认值:
CALLER_CREDENTIALSAmazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
附加说明:
CALLER_CREDENTIALS映射到arn:aws:iam::*:user/*,它使用调用者凭据来调用终端节点。 -
ResourcePolicy -
在 API 上为此路径配置资源策略。
类型:资源策略声明
必需:否
Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
示例
函数身份验证
下面的示例指定了函数级别的授权。
YAML
Auth: ApiKeyRequired: true Authorizer: NONE