Auth - AWS Serverless Application Model
SintaksPropertiContoh

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Auth

Konfigurasikan otorisasi untuk GraphQL API.

Sintaks

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

YAML

Additional:
- AuthProvider
LambdaAuthorizer: LambdaAuthorizerConfig
OpenIDConnect: OpenIDConnectConfig
Type: String
UserPool: UserPoolConfig

Properti

Additional

Daftar jenis otorisasi tambahan untuk GraphQL API.

Jenis: Daftar AuthProvider

Wajib: Tidak

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

LambdaAuthorizer

Tentukan konfigurasi otorisasi opsional untuk otorisasi fungsi Lambda Anda. Anda dapat mengkonfigurasi properti opsional ini ketika Type ditentukan sebagaiAWS_LAMBDA.

Jenis: LambdaAuthorizerConfig

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke LambdaAuthorizerConfig properti AWS::AppSync::GraphQLApi sumber daya.

OpenIDConnect

Tentukan konfigurasi otorisasi opsional untuk OpenID Connect layanan yang sesuai. Anda dapat mengkonfigurasi properti opsional ini ketika Type ditentukan sebagaiOPENID_CONNECT.

Jenis: Buka IDConnect Config

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke OpenIDConnectConfig properti AWS::AppSync::GraphQLApi sumber daya.

Type

Jenis otorisasi default antara aplikasi dan AWS AppSync GraphQL API.

Untuk daftar dan deskripsi nilai yang diizinkan, lihat Otorisasi dan otentikasi di Panduan AWS AppSync Pengembang.

Saat Anda menentukan Lambda authorizer (AWS_LAMBDA), AWS SAM buat kebijakan AWS Identity and Access Management (IAM) untuk memberikan izin di antara GraphQL Fungsi API dan Lambda.

Tipe: String

Wajib: Ya

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke AuthenticationType properti AWS::AppSync::GraphQLApi sumber daya.

UserPool

Tentukan konfigurasi otorisasi opsional untuk menggunakan kumpulan pengguna Amazon Cognito. Anda dapat mengkonfigurasi properti opsional ini ketika Type ditentukan sebagaiAMAZON_COGNITO_USER_POOLS.

Jenis: UserPoolConfig

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke UserPoolConfig properti AWS::AppSync::GraphQLApi sumber daya.

Contoh

Konfigurasikan jenis otorisasi default dan tambahan

Dalam contoh ini, kita mulai dengan mengonfigurasi otorisasi Lambda sebagai jenis otorisasi default untuk GraphQL API.

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Auth:
        Type: AWS_LAMBDA
        LambdaAuthorizer:
          AuthorizerUri: !GetAtt Authorizer1.Arn
          AuthorizerResultTtlInSeconds: 10
          IdentityValidationExpression: hello

Selanjutnya, kami mengonfigurasi jenis otorisasi tambahan untuk GraphQL API dengan menambahkan yang berikut ini ke AWS SAM template kami:

        Additional:
        - Type: AWS_IAM
        - Type: API_KEY
        - Type: OPENID_CONNECT
          OpenIDConnect:
            AuthTTL: 10
            ClientId: myId
            IatTTL: 10
            Issuer: prod

Ini menghasilkan AWS SAM template berikut:

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Auth:
        Type: AWS_LAMBDA
        LambdaAuthorizer:
          AuthorizerUri: !GetAtt Authorizer1.Arn
          AuthorizerResultTtlInSeconds: 10
          IdentityValidationExpression: hello
        Additional:
        - Type: AWS_IAM
        - Type: API_KEY
        - Type: OPENID_CONNECT
          OpenIDConnect:
            AuthTTL: 10
            ClientId: myId
            IatTTL: 10
            Issuer: prod