HttpApiAuth - 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.

HttpApiAuth

Mengonfigurasi otorisasi untuk mengendalikan akses ke API HTTP dari Amazon API Gateway Anda.

Untuk informasi selengkapnya tentang mengonfigurasi akses ke HTTP APIs, lihat Mengontrol dan mengelola akses ke API HTTP di API Gateway di Panduan Pengembang API Gateway.

Sintaks

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

Properti

Authorizers

Pengotorisasi yang digunakan untuk mengendalikan akses ke API dari API Gateway Anda.

Jenis: OAuth2Authorizer | LambdaAuthorizer

Wajib: Tidak

Default: Tidak ada

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

Catatan tambahan: AWS SAM menambahkan otorisasi ke definisi OpenAPI.

DefaultAuthorizer

Tentukan otorisasi default yang digunakan untuk mengotorisasi panggilan API ke API dari API Gateway Anda. Anda dapat menentukan AWS_IAM sebagai otorisasi default jika EnableIamAuthorizer diatur ketrue. Jika tidak, tentukan otorisasi yang telah Anda tentukan. Authorizers

Tipe: String

Wajib: Tidak

Default: Tidak ada

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

EnableIamAuthorizer

Tentukan apakah akan menggunakan otorisasi IAM untuk rute API.

Tipe: Boolean

Wajib: Tidak

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

Contoh

OAuth 2.0 Pengotorisasi

OAuth 2.0 contoh otorisasi

YAML

Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
        - scope2
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer

Pengotorisasi IAM

Contoh otorisasi IAM

YAML

Auth:
  EnableIamAuthorizer: true
  DefaultAuthorizer: AWS_IAM