CognitoAuthorizer

Menentukan otorisasi Kolam Pengguna Amazon Cognito.

Untuk informasi selengkapnya dan contoh tambahan, lihat Kontrol akses API dengan AWS SAM template Anda.

Sintaks

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

YAML

  AuthorizationScopes: List
  Identity: CognitoAuthorizationIdentity
  UserPoolArn: String

Properti

AuthorizationScopes

Daftar cakupan otorisasi untuk pemberi kuasa ini.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Identity

Properti ini dapat digunakan untuk menentukan IdentitySource dalam permintaan masuk untuk otorisasi.

Jenis: CognitoAuthorizationIdentity

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

UserPoolArn

Dapat merujuk ke kolam pengguna/menentukan arn kolam pengguna tempat Anda ingin menambahkan pengotorisasi cognito ini

Tipe: String

Wajib: Ya

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Contoh

CognitoAuth

Contoh Cognito Auth

YAML

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