CognitoAuthorizer - AWS Serverless Application Model

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

CognitoAuthorizer

定義 Amazon Cognito 用者集區授權者。

如需詳細資訊和範例,請參閱 使用 AWS SAM 範本控制API存取

語法

若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體,請使用下列語法。

屬性

AuthorizationScopes

此授權者的授權範圍清單。

類型:清單

必要:否

AWS CloudFormation 兼容性:此屬性是唯一的, AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

Identity

此屬性可用於在授權者IdentitySource的傳入請求中指定。

類型:CognitoAuthorizationIdentity

必要:否

AWS CloudFormation 兼容性:此屬性是唯一的, AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

UserPoolArn

可以參考使用者集區/指定要新增這個認知授權者的使用者集區 arn

類型:字串

必要:是

AWS CloudFormation 兼容性:此屬性是唯一的, AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

範例

CognitoAuth

Cognito 身份驗證示例

YAML

Auth: Authorizers: MyCognitoAuth: AuthorizationScopes: - scope1 - scope2 UserPoolArn: Fn::GetAtt: - MyCognitoUserPool - Arn Identity: Header: MyAuthorizationHeader ValidationExpression: myauthvalidationexpression