HttpApi

Filter Tampilan

All

Objek yang menggambarkan sumber peristiwa dengan tipe HttpApi.

Jika OpenApi definisi untuk jalur dan metode yang ditentukan ada di API, SAM akan menambahkan bagian integrasi dan keamanan Lambda (jika ada) untuk Anda.

Jika tidak ada OpenApi definisi untuk jalur dan metode yang ditentukan di API, SAM akan membuat definisi ini untuk Anda.

Sintaks

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

YAML

  ApiId: String
  Auth: HttpApiFunctionAuth
  Method: String
  Path: String
  PayloadFormatVersion: String
  RouteSettings: RouteSettings
  TimeoutInMillis: Integer

Properti

ApiId

Pengenal dari sumber daya AWS::Serverless::HttpApi yang ditentukan dalam templat ini.

Jika tidak ditentukan, AWS::Serverless::HttpApi sumber daya default dibuat dengan ServerlessHttpApi menggunakan OpenApi dokumen yang dihasilkan yang berisi gabungan semua jalur dan metode yang ditentukan oleh peristiwa Api yang ditentukan dalam templat ini yang tidak menentukanApiId.

Ini tidak dapat merujuk sumber daya AWS::Serverless::HttpApi yang ditentukan dalam templat lain.

Tipe: String

Wajib: Tidak

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

Auth

Konfigurasi auth untuk Api+Path+Metode tertentu ini.

Berguna untuk membatalkan DefaultAuthorizer API atau mengatur auth config pada jalur individu ketika DefaultAuthorizer tidak ditentukan.

Jenis: HttpApiFunctionAuth

Wajib: Tidak

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

Method

Metode HTTP yang membuat fungsi ini dipanggil.

Jika Path dan Method tidak ditentukan, SAM akan membuat jalur API default yang merutekan setiap permintaan yang tidak memetakan ke titik akhir yang berbeda untuk fungsi Lambda ini. Hanya satu dari jalur default ini yang boleh ada per API.

Tipe: String

Wajib: Tidak

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

Path

Jalur Uri yang membuat fungsi ini dipanggil. Harus dimulai dengan /.

Jika Path dan Method tidak ditentukan, SAM akan membuat jalur API default yang merutekan setiap permintaan yang tidak memetakan ke titik akhir yang berbeda untuk fungsi Lambda ini. Hanya satu dari jalur default ini yang boleh ada per API.

Tipe: String

Wajib: Tidak

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

PayloadFormatVersion

Menentukan format muatan yang dikirim ke integrasi.

CATATAN: PayloadFormatVersion mengharuskan SAM untuk memodifikasi definisi OpenAPI Anda, sehingga hanya berfungsi dengan definisi sebaris di OpenApi properti. DefinitionBody

Tipe: String

Wajib: Tidak

Default: 2.0

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

RouteSettings

Pengaturan rute per rute untuk API HTTP ini. Untuk informasi selengkapnya tentang setelan rute, lihat AWS::ApiGatewayV2::Stage RouteSettingsdi Panduan Pengembang API Gateway.

Catatan: Jika RouteSettings ditentukan dalam HttpApi sumber daya dan sumber peristiwa, AWS SAM gabungkan mereka dengan properti sumber peristiwa yang diutamakan.

Jenis: RouteSettings

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke RouteSettings properti AWS::ApiGatewayV2::Stage sumber daya.

TimeoutInMillis

Waktu habis khusus antara 50 dan 29.000 milidetik.

CATATAN: TimeoutInMillis mengharuskan SAM untuk memodifikasi definisi OpenAPI Anda, sehingga hanya berfungsi dengan definisi sebaris di OpenApi properti. DefinitionBody

Tipe: Integer

Wajib: Tidak

Default: 5000

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

Contoh

HttpApi Acara Default

HttpApi Peristiwa yang menggunakan jalur default. Semua jalur dan metode yang belum dipetakan pada API ini akan merutekan ke titik akhir ini.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi

HttpApi

HttpApi Peristiwa yang menggunakan jalur dan metode tertentu.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /
      Method: GET

HttpApi Otorisasi

HttpApi Event yang menggunakan Authorizer.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /authenticated
      Method: GET
      Auth:
        Authorizer: OpenIdAuth
        AuthorizationScopes:
          - scope1
          - scope2