Api

Objek yang menggambarkan tipe sumber peristiwa Api. Jika sumber daya AWS::Serverless::Api didefinisikan, nilai jalur dan metode harus sesuai dengan operasi dalam ketentuan OpenAPI API.

Sintaks

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

YAML

  Auth: ApiStateMachineAuth
  Method: String
  Path: String
  RestApiId: String
  UnescapeMappingTemplate: Boolean

Properti

Auth

Konfigurasi otorisasi untuk API, jalur, dan metode ini.

Gunakan properti ini untuk membatalkan pengaturan DefaultAuthorizer API untuk jalur individu, ketika DefaultAuthorizer tidak ditentukan, atau untuk membatalkan pengaturan ApiKeyRequired default.

Jenis: ApiStateMachineAuth

Wajib: Tidak

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

Method

Metode HTTP yang membuat fungsi ini dipanggil.

Tipe: String

Wajib: Ya

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

Path

Jalur URI yang membuat fungsi ini dipanggil. Nilai harus dimulai dengan /.

Tipe: String

Wajib: Ya

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

RestApiId

Pengenal sumber daya RestApi, yang harus berisi operasi dengan jalur dan metode yang diberikan. Biasanya, ini diatur untuk merujuk sumber daya AWS::Serverless::Api yang ditentukan dalam templat ini.

Jika Anda tidak mendefinisikan properti ini, AWS SAM buat AWS::Serverless::Api sumber daya default menggunakan OpenApi dokumen yang dihasilkan. Sumber daya tersebut berisi penyatuan dari semua jalur dan metode yang ditentukan oleh peristiwa Api dalam templat yang sama yang tidak menentukan RestApiId.

Properti ini tidak dapat merujuk sumber daya AWS::Serverless::Api yang ditentukan dalam templat lain.

Tipe: String

Wajib: Tidak

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

UnescapeMappingTemplate

Menghapus tanda kutip tunggal, dengan mengganti \' dengan', pada input yang diteruskan ke mesin status. Gunakan saat masukan Anda berisi tanda kutip tunggal.

catatan

Jika disetel ke False dan input Anda berisi tanda kutip tunggal, kesalahan akan terjadi.

Tipe: Boolean

Wajib: Tidak

Default: Salah

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

Contoh

ApiEvent

Berikut adalah contoh peristiwa dari tipe Api ini.

YAML

Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get