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

# Api
<a name="sam-property-statemachine-statemachineapi"></a>

Objek yang menggambarkan tipe sumber peristiwa `Api`. Jika sumber daya [AWS::Serverless::Api](sam-resource-api.md) didefinisikan, nilai jalur dan metode harus sesuai dengan operasi dalam ketentuan OpenAPI API. 

## Sintaksis
<a name="sam-property-statemachine-statemachineapi-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachineapi-syntax.yaml"></a>

```
  [Auth](#sam-statemachine-statemachineapi-auth): ApiStateMachineAuth
  [Method](#sam-statemachine-statemachineapi-method): String
  [Path](#sam-statemachine-statemachineapi-path): String
  [RestApiId](#sam-statemachine-statemachineapi-restapiid): String
  UnescapeMappingTemplate: Boolean
```

## Sifat-sifat
<a name="sam-property-statemachine-statemachineapi-properties"></a>

 `Auth`   <a name="sam-statemachine-statemachineapi-auth"></a>
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](sam-property-statemachine-apistatemachineauth.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Method`   <a name="sam-statemachine-statemachineapi-method"></a>
Metode HTTP yang membuat fungsi ini dipanggil.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Path`   <a name="sam-statemachine-statemachineapi-path"></a>
Jalur URI yang membuat fungsi ini dipanggil. Nilai harus dimulai dengan `/`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RestApiId`   <a name="sam-statemachine-statemachineapi-restapiid"></a>
Pengenal sumber daya `RestApi`, yang harus berisi operasi dengan jalur dan metode yang diberikan. Biasanya, ini diatur untuk merujuk sumber daya [AWS::Serverless::Api](sam-resource-api.md) yang ditentukan dalam templat ini.  
Jika Anda tidak mendefinisikan properti ini, AWS SAM buat [AWS::Serverless::Api](sam-resource-api.md) 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](sam-resource-api.md) yang ditentukan dalam templat lain.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `UnescapeMappingTemplate`   <a name="sam-statemachine-statemachineapi-unescapemappingtemplate"></a>
Menghapus tanda kutip tunggal, dengan mengganti `\'` dengan`'`, pada input yang diteruskan ke mesin status. Gunakan saat masukan Anda berisi tanda kutip tunggal.  
Jika disetel ke `False` dan input Anda berisi tanda kutip tunggal, kesalahan akan terjadi.
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: Salah  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-statemachine-statemachineapi--examples"></a>

### ApiEvent
<a name="sam-property-statemachine-statemachineapi--examples--apievent"></a>

Berikut adalah contoh peristiwa dari tipe `Api` ini.

#### YAML
<a name="sam-property-statemachine-statemachineapi--examples--apievent--yaml"></a>

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