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

# AWS::Serverless::StateMachine
<a name="sam-resource-statemachine"></a>

Membuat mesin AWS Step Functions status, yang dapat Anda gunakan untuk mengatur AWS Lambda fungsi dan AWS sumber daya lainnya untuk membentuk alur kerja yang kompleks dan kuat.

Untuk informasi selengkapnya, lihat Step Functions dalam [Panduan Developer AWS Step Functions](https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html).

**catatan**  
Ketika Anda menyebarkan ke AWS CloudFormation, AWS SAM mengubah AWS SAM sumber daya Anda menjadi CloudFormation sumber daya. Untuk informasi selengkapnya, lihat [CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).

## Sintaks
<a name="sam-resource-statemachine-syntax"></a>

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

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

```
Type: AWS::Serverless::StateMachine
Properties:
  AutoPublishAlias: String
  UseAliasAsEventTarget: Boolean
  [Definition](#sam-statemachine-definition): Map
  [DefinitionSubstitutions](#sam-statemachine-definitionsubstitutions): Map
  [DefinitionUri](#sam-statemachine-definitionuri): String | [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)
  DeploymentPreference: [DeploymentPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html)
  [Events](#sam-statemachine-events): EventSource
  [Logging](#sam-statemachine-logging): [LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)
  [Name](#sam-statemachine-name): String
  [PermissionsBoundary](#sam-statemachine-permissionsboundary): String
  [Policies](#sam-statemachine-policies): String | List | Map
  PropagateTags: Boolean
  [RolePath](#sam-statemachine-rolepath): String
  [Role](#sam-statemachine-role): String
  [Tags](#sam-statemachine-tags): Map
  [Tracing](#sam-statemachine-tracing): [TracingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)
  [Type](#sam-statemachine-type): String
```

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

 `AutoPublishAlias`   <a name="sam-statemachine-autopublishalias"></a>
Nama alias mesin negara. *Untuk mempelajari selengkapnya tentang penggunaan alias mesin status Step Functions, lihat [Mengelola penerapan berkelanjutan dengan versi dan alias](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-cd-aliasing-versioning.html) di Panduan Pengembang.AWS Step Functions *  
Gunakan `DeploymentPreference` untuk mengonfigurasi preferensi penerapan untuk alias Anda. Jika Anda tidak menentukan`DeploymentPreference`, AWS SAM akan mengkonfigurasi lalu lintas untuk beralih ke versi mesin status yang lebih baru sekaligus.  
AWS SAM menetapkan versi `DeletionPolicy` dan `UpdateReplacePolicy` ke secara `Retain` default. Versi sebelumnya tidak akan dihapus secara otomatis.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke ` [ Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-name)` properti `AWS::StepFunctions::StateMachineAlias` sumber daya.

 `UseAliasAsEventTarget`   <a name="sam-statemachine-usealiasaseventtarget"></a>
Tunjukkan apakah akan meneruskan alias, yang dibuat dengan menggunakan `AutoPublishAlias` properti, ke target sumber peristiwa yang ditentukan dengan [Peristiwa](#sam-statemachine-events).  
Tentukan `True` untuk menggunakan alias sebagai target acara.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `False`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Definition`   <a name="sam-statemachine-definition"></a>
Definisi mesin status adalah objek, di mana format objek cocok dengan format file AWS SAM template Anda, misalnya, JSON atau YAMAL. Ketentuan mesin status mematuhi [Bahasa Status Amazon](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).  
Untuk contoh ketentuan mesin status inline, lihat [Contoh](#sam-resource-statemachine--examples).  
Anda harus menyediakan `Definition` atau `DefinitionUri`.  
*Tipe*: Peta  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `DefinitionSubstitutions`   <a name="sam-statemachine-definitionsubstitutions"></a>
 string-to-stringPeta yang menentukan pemetaan untuk variabel placeholder dalam definisi mesin status. Hal ini memungkinkan Anda untuk memasukkan nilai-nilai yang diperoleh pada saat waktu aktif (misalnya, dari fungsi intrinsik) ke dalam ketentuan mesin status.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DefinitionSubstitutions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionsubstitutions)` properti `AWS::StepFunctions::StateMachine` sumber daya. Jika ada fungsi intrinsik yang ditentukan dalam definisi mesin status inline, AWS SAM tambahkan entri ke properti ini untuk menyuntikkannya ke dalam definisi mesin status.

 `DefinitionUri`   <a name="sam-statemachine-definitionuri"></a>
URI Amazon Simple Storage Service (Amazon S3) atau jalur file lokal dari ketentuan mesin status yang ditulis di [Bahasa Status Amazon](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).  
Jika Anda memberikan jalur file lokal, templat harus melalui alur kerja yang mencakup perintah `sam deploy` atau `sam package` untuk mengubah ketentuan dengan benar. Untuk melakukannya, Anda harus menggunakan CLI AWS SAM versi 0.52.0 atau yang lebih baru.  
Anda harus memberikan `Definition` atau `DefinitionUri`.  
*Tipe*: String \$1 [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DefinitionS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)` properti `AWS::StepFunctions::StateMachine` sumber daya.

 `DeploymentPreference`   <a name="sam-statemachine-deploymentpreference"></a>
Pengaturan yang mengaktifkan dan mengonfigurasi penerapan mesin status bertahap. *Untuk mempelajari selengkapnya tentang penerapan bertahap Step Functions, lihat [Mengelola penerapan berkelanjutan dengan versi dan alias](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-cd-aliasing-versioning.html) di Panduan Pengembang.AWS Step Functions *  
Tentukan `AutoPublishAlias` sebelum mengkonfigurasi properti ini. `DeploymentPreference`Pengaturan Anda akan diterapkan ke alias yang ditentukan dengan`AutoPublishAlias`.  
Saat Anda menentukan`DeploymentPreference`, AWS SAM menghasilkan nilai `StateMachineVersionArn` sub-properti secara otomatis.  
*Jenis*: [DeploymentPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: AWS SAM menghasilkan dan melampirkan nilai `StateMachineVersionArn` properti ke `DeploymentPreference` dan meneruskan `DeploymentPreference` ke `[DeploymentPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-deploymentpreference)` properti `AWS::StepFunctions::StateMachineAlias` sumber daya. 

 `Events`   <a name="sam-statemachine-events"></a>
Menentukan peristiwa yang memicu mesin status ini. Peristiwa terdiri dari tipe dan satu set properti yang bergantung pada tipenya.  
*Jenis*: [EventSource](sam-property-statemachine-statemachineeventsource.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Logging`   <a name="sam-statemachine-logging"></a>
Menentukan peristiwa riwayat eksekusi mana yang dicatat dan tempatnya dicatat.  
*Jenis*: [LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)` properti `AWS::StepFunctions::StateMachine` sumber daya.

 `Name`   <a name="sam-statemachine-name"></a>
Nama mesin status.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StateMachineName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename)` properti `AWS::StepFunctions::StateMachine` sumber daya.

 `PermissionsBoundary`   <a name="sam-statemachine-permissionsboundary"></a>
ARN batas izin untuk digunakan untuk peran eksekusi mesin status ini. Properti ini hanya bekerja jika peran tersebut dibuat untuk Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` properti `AWS::IAM::Role` sumber daya.

 `Policies`   <a name="sam-statemachine-policies"></a>
Kebijakan izin untuk mesin negara bagian ini. Kebijakan akan ditambahkan ke peran eksekusi default mesin negara AWS Identity and Access Management (IAM).  
Properti ini menerima satu nilai atau daftar nilai. Nilai yang diizinkan meliputi:  
+ [AWS SAM templat kebijakan](serverless-policy-templates.md).
+ Kebijakan ARN [AWS terkelola atau kebijakan](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) yang [dikelola pelanggan](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#customer-managed-policies).
+ Nama kebijakan AWS terkelola dari [daftar](https://github.com/aws/serverless-application-model/blob/develop/samtranslator/internal/data/aws_managed_policies.json) berikut.
+ [Kebijakan IAM sebaris](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#inline-policies) yang diformat YAML sebagai peta.
Jika Anda menyetel `Role` properti, properti ini diabaikan.
*Tipe*: String \$1 Daftar \$1 Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

`PropagateTags`  <a name="sam-statemachine-propagatetags"></a>
Tunjukkan apakah akan meneruskan tag dari `Tags` properti ke sumber daya yang Anda [AWS::Serverless::StateMachine](sam-specification-generated-resources-statemachine.md) hasilkan atau tidak. Tentukan `True` untuk menyebarkan tag di sumber daya yang Anda hasilkan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `False`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Role`   <a name="sam-statemachine-role"></a>
ARN IAM role untuk digunakan sebagai peran eksekusi mesin status ini.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn)` properti `AWS::StepFunctions::StateMachine` sumber daya.

 `RolePath`   <a name="sam-statemachine-rolepath"></a>
Jalur ke peran eksekusi IAM mesin negara.  
Gunakan properti ini saat peran dibuat untuk Anda. Jangan gunakan saat peran ditentukan dengan `Role` properti.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Path](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path)` properti `AWS::IAM::Role` sumber daya.

 `Tags`   <a name="sam-statemachine-tags"></a>
 string-to-stringPeta yang menentukan tag yang ditambahkan ke mesin status dan peran eksekusi yang sesuai. Untuk informasi tentang kunci dan nilai tag yang valid, lihat properti [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags) dari [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html)sumber daya.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags)` properti `AWS::StepFunctions::StateMachine` sumber daya. AWS SAM secara otomatis menambahkan `stateMachine:createdBy:SAM` tag ke sumber daya ini, dan ke peran default yang dihasilkan untuknya.

 `Tracing`   <a name="sam-statemachine-tracing"></a>
Memilih apakah diaktifkan atau AWS X-Ray tidak untuk mesin status. Untuk informasi lebih lanjut tentang menggunakan X-Ray dengan Step Function, lihat [AWS X-Ray dan Step Functions](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-xray-tracing.html) di *Panduan Developer AWS Step Functions *.  
*Jenis*: [TracingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TracingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)` properti `AWS::StepFunctions::StateMachine` sumber daya.

 `Type`   <a name="sam-statemachine-type"></a>
Tipe mesin status.  
*Nilai yang valid*: `STANDARD` atau `EXPRESS`  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `STANDARD`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StateMachineType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype)` properti `AWS::StepFunctions::StateMachine` sumber daya.

## Nilai Pengembalian
<a name="sam-resource-statemachine-return-values"></a>

### Ref
<a name="sam-resource-statemachine-return-values-ref"></a>

Bila Anda memberikan ID logis dari sumber daya ini ke fungsi intrinsik Ref, Ref mengembalikan Amazon Resource Name (ARN) dari sumber daya `AWS::StepFunctions::StateMachine`utama.

Untuk informasi lebih lanjut tentang penggunaan fungsi `Ref`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) di *Panduan Pengguna AWS CloudFormation *. 

### Fn:: GetAtt
<a name="sam-resource-statemachine-return-values-fn--getatt"></a>

`Fn::GetAtt` mengembalikan nilai untuk atribut yang ditentukan dari jenis ini. Berikut ini adalah atribut yang tersedia dan nilai-nilai kembali sampel. 

Untuk informasi lebih lanjut cara menggunakan `Fn::GetAtt`, lihat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) di *Panduan Pengguna AWS CloudFormation * 

`Name`  <a name="Name-fn::getatt"></a>
Mengembalikan nama mesin status, seperti `HelloWorld-StateMachine`.

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

### File Ketentuan Mesin Status
<a name="sam-resource-statemachine--examples--state-machine-definition-file"></a>

Berikut ini adalah contoh definisi mesin status inline yang memungkinkan fungsi lambda untuk memanggil mesin status. Perhatikan bahwa contoh ini mengharapkan `Role` properti untuk mengonfigurasi kebijakan yang tepat untuk mengizinkan pemanggilan. File `my_state_machine.asl.json` harus ditulis dalam [Bahasa Status Amazon](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).

Dalam contoh ini, `DefinitionSubstitution` entri memungkinkan mesin negara untuk menyertakan sumber daya yang dideklarasikan dalam file AWS SAM template.

#### YAML
<a name="sam-resource-statemachine--examples--state-machine-definition-file--yaml"></a>

```
MySampleStateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    DefinitionUri: statemachine/my_state_machine.asl.json
    Role: arn:aws:iam::123456123456:role/service-role/my-sample-role
    Tracing:
      Enabled: true
    DefinitionSubstitutions:
      MyFunctionArn: !GetAtt MyFunction.Arn
      MyDDBTable: !Ref TransactionTable
```

### Ketentuan Mesin Status Inline
<a name="sam-resource-statemachine--examples--inline-state-machine-definition"></a>

Berikut ini adalah contoh dari ketentuan mesin status inline.

Dalam contoh ini, file AWS SAM template ditulis dalam YAMAL, sehingga definisi mesin status juga dalam YAMAL. Untuk mendeklarasikan definisi mesin status inline di JSON, tulis file AWS SAM template Anda di JSON.

#### YAML
<a name="sam-resource-statemachine--examples--inline-state-machine-definition--yaml"></a>

```
MySampleStateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    Definition:
      StartAt: MyLambdaState
      States:
        MyLambdaState:
          Type: Task
          Resource: arn:aws:lambda:us-east-1:123456123456:function:my-sample-lambda-app
          End: true
    Role: arn:aws:iam::123456123456:role/service-role/my-sample-role
    Tracing:
      Enabled: true
```

# EventSource
<a name="sam-property-statemachine-statemachineeventsource"></a>

Objek yang menggambarkan sumber peristiwa yang memicu mesin status. Setiap peristiwa terdiri dari tipe dan satu set properti yang bergantung pada tipe itu. Untuk informasi lebih lanjut tentang properti dari setiap sumber peristiwa, lihat subtopik yang sesuai dengan tipe tersebut.

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

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

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

```
  [Properties](#sam-statemachine-statemachineeventsource-properties): Schedule | ScheduleV2 | CloudWatchEvent | EventBridgeRule | Api
  [Type](#sam-statemachine-statemachineeventsource-type): String
```

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

 `Properties`   <a name="sam-statemachine-statemachineeventsource-properties"></a>
Sebuah objek yang menggambarkan properti pemetaan peristiwa ini. Set properti harus sesuai dengan `Type` yang ditentukan.  
*Jenis*[: [Jadwal](sam-property-statemachine-statemachineschedule.md) \$1 [ScheduleV2 \$1](sam-property-statemachine-statemachineschedulev2.md) \$1 \$1 Api [CloudWatchEvent[EventBridgeRule](sam-property-statemachine-statemachineeventbridgerule.md)](sam-property-statemachine-statemachinecloudwatchevent.md)](sam-property-statemachine-statemachineapi.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-statemachine-statemachineeventsource-type"></a>
Jenis peristiwa.  
*Nilai yang valid*:`Api`,`Schedule`,`ScheduleV2`,`CloudWatchEvent`, `EventBridgeRule`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

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

### API
<a name="sam-property-statemachine-statemachineeventsource--examples--api"></a>

Berikut adalah contoh peristiwa dari tipe `API` ini.

#### YAML
<a name="sam-property-statemachine-statemachineeventsource--examples--api--yaml"></a>

```
ApiEvent:
  Type: Api
  Properties:
    Method: get
    Path: /group/{user}
    RestApiId: 
      Ref: MyApi
```

# 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
```

# ApiStateMachineAuth
<a name="sam-property-statemachine-apistatemachineauth"></a>

Mengonfigurasi otorisasi di tingkat peristiwa, untuk API, jalur, dan metode tertentu.

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

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

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

```
  [ApiKeyRequired](#sam-statemachine-apistatemachineauth-apikeyrequired): Boolean
  [AuthorizationScopes](#sam-statemachine-apistatemachineauth-authorizationscopes): List
  [Authorizer](#sam-statemachine-apistatemachineauth-authorizer): String
  [ResourcePolicy](#sam-statemachine-apistatemachineauth-resourcepolicy): ResourcePolicyStatement
```

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

 `ApiKeyRequired`   <a name="sam-statemachine-apistatemachineauth-apikeyrequired"></a>
Memerlukan kunci API untuk API, jalur, dan metode ini.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AuthorizationScopes`   <a name="sam-statemachine-apistatemachineauth-authorizationscopes"></a>
Cakupan otorisasi yang akan diterapkan ke API, path, dan metode ini.  
Cakupan yang Anda tentukan akan membatalkan setiap cakupan yang diterapkan oleh properti `DefaultAuthorizer` jika Anda telah menentukannya.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Authorizer`   <a name="sam-statemachine-apistatemachineauth-authorizer"></a>
`Authorizer` untuk mesin status tertentu.  
Jika Anda telah menentukan otorisasi global untuk API dan ingin membuat mesin status ini menjadi publik, batalkan otoritas global dengan menetapkan `Authorizer` ke `NONE`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ResourcePolicy`   <a name="sam-statemachine-apistatemachineauth-resourcepolicy"></a>
Konfigurasikan kebijakan sumber daya untuk API dan jalur ini.  
*Jenis*: [ResourcePolicyStatement](sam-property-statemachine-resourcepolicystatement.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

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

### StateMachine-Auth
<a name="sam-property-statemachine-apistatemachineauth--examples--statemachine-auth"></a>

Contoh berikut menentukan otorisasi di tingkat mesin status.

#### YAML
<a name="sam-property-statemachine-apistatemachineauth--examples--statemachine-auth--yaml"></a>

```
Auth:
  ApiKeyRequired: true
  Authorizer: NONE
```

# ResourcePolicyStatement
<a name="sam-property-statemachine-resourcepolicystatement"></a>

Mengonfigurasi kebijakan sumber daya untuk semua metode dan jalur API. Untuk informasi selengkapnya tentang kebijakan sumber daya, lihat [Mengendalikan akses ke API dengan kebijakan sumber daya API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) di *Panduan Developer API Gateway*.

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

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

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

```
  [AwsAccountBlacklist](#sam-statemachine-resourcepolicystatement-awsaccountblacklist): List
  [AwsAccountWhitelist](#sam-statemachine-resourcepolicystatement-awsaccountwhitelist): List
  [CustomStatements](#sam-statemachine-resourcepolicystatement-customstatements): List
  [IntrinsicVpcBlacklist](#sam-statemachine-resourcepolicystatement-intrinsicvpcblacklist): List
  [IntrinsicVpcWhitelist](#sam-statemachine-resourcepolicystatement-intrinsicvpcwhitelist): List
  [IntrinsicVpceBlacklist](#sam-statemachine-resourcepolicystatement-intrinsicvpceblacklist): List
  [IntrinsicVpceWhitelist](#sam-statemachine-resourcepolicystatement-intrinsicvpcewhitelist): List
  [IpRangeBlacklist](#sam-statemachine-resourcepolicystatement-iprangeblacklist): List
  [IpRangeWhitelist](#sam-statemachine-resourcepolicystatement-iprangewhitelist): List
  [SourceVpcBlacklist](#sam-statemachine-resourcepolicystatement-sourcevpcblacklist): List
  [SourceVpcWhitelist](#sam-statemachine-resourcepolicystatement-sourcevpcwhitelist): List
```

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

 `AwsAccountBlacklist`   <a name="sam-statemachine-resourcepolicystatement-awsaccountblacklist"></a>
 AWS Akun yang akan diblokir.  
*Jenis*: Daftar String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AwsAccountWhitelist`   <a name="sam-statemachine-resourcepolicystatement-awsaccountwhitelist"></a>
 AWS Akun untuk memungkinkan. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Jenis*: Daftar String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `CustomStatements`   <a name="sam-statemachine-resourcepolicystatement-customstatements"></a>
Daftar pernyataan kebijakan sumber daya kustom untuk diterapkan ke API ini. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpcBlacklist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpcblacklist"></a>
Daftar virtual private cloud (VPCs) yang akan diblokir, di mana setiap VPC ditentukan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau fungsi `Ref` [intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpcWhitelist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpcwhitelist"></a>
Daftar VPCs to allow, di mana setiap VPC ditentukan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau fungsi `Ref` [intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpceBlacklist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpceblacklist"></a>
Daftar VPC endpoint yang akan diblokir, dengan setiap VPC endpoint ditetapkan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau [fungsi intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) `Ref`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IntrinsicVpceWhitelist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpcewhitelist"></a>
Daftar VPC endpoint yang akan diizinkan, dengan setiap VPC endpoint ditetapkan sebagai referensi seperti [referensi dinamis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) atau [fungsi intrinsik](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) `Ref`. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IpRangeBlacklist`   <a name="sam-statemachine-resourcepolicystatement-iprangeblacklist"></a>
Alamat IP atau jangkauan alamat yang akan diblokir. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `IpRangeWhitelist`   <a name="sam-statemachine-resourcepolicystatement-iprangewhitelist"></a>
Alamat IP atau jangkauan alamat yang akan diizinkan.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceVpcBlacklist`   <a name="sam-statemachine-resourcepolicystatement-sourcevpcblacklist"></a>
Sumber VPC atau VPC endpoint yang akan diblokir. Nama VPC sumber harus dimulai dengan `"vpc-"` dan nama VPC endpoint sumber harus dimulai dengan `"vpce-"`. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceVpcWhitelist`   <a name="sam-statemachine-resourcepolicystatement-sourcevpcwhitelist"></a>
VPC sumber atau VPC endpoint yang akan diizinkan. Nama VPC sumber harus dimulai dengan `"vpc-"` dan nama VPC endpoint sumber harus dimulai dengan `"vpce-"`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

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

### Contoh Kebijakan Sumber Daya
<a name="sam-property-statemachine-resourcepolicystatement--examples--resource-policy-example"></a>

Contoh berikut memblokir dua alamat IP dan VPC sumber, dan memungkinkan akun AWS .

#### YAML
<a name="sam-property-statemachine-resourcepolicystatement--examples--resource-policy-example--yaml"></a>

```
Auth:
  ResourcePolicy:
    CustomStatements: [{
                         "Effect": "Allow",
                         "Principal": "*",
                         "Action": "execute-api:Invoke",
                         "Resource": "execute-api:/Prod/GET/pets",
                         "Condition": {
                           "IpAddress": {
                             "aws:SourceIp": "1.2.3.4"
                           }
                         }
                       }]
    IpRangeBlacklist:
      - "10.20.30.40"
      - "1.2.3.4"
    SourceVpcBlacklist:
      - "vpce-1a2b3c4d"
    AwsAccountWhitelist:
      - "111122223333"
    IntrinsicVpcBlacklist:
      - "{{resolve:ssm:SomeVPCReference:1}}" 
      - !Ref MyVPC
    IntrinsicVpceWhitelist:
      - "{{resolve:ssm:SomeVPCEReference:1}}" 
      - !Ref MyVPCE
```

# CloudWatchEvent
<a name="sam-property-statemachine-statemachinecloudwatchevent"></a>

Objek yang menggambarkan tipe sumber peristiwa `CloudWatchEvent`.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)sumber daya saat jenis acara ini disetel.

**Catatan Penting**: [EventBridgeRule](sam-property-statemachine-statemachineeventbridgerule.md) adalah jenis sumber acara yang disukai untuk digunakan, bukan`CloudWatchEvent`. `EventBridgeRule`dan `CloudWatchEvent` menggunakan layanan, API, dan CloudFormation sumber daya dasar yang sama. Namun, AWS SAM akan menambahkan dukungan untuk fitur baru hanya untuk`EventBridgeRule`.

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

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

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

```
  [EventBusName](#sam-statemachine-statemachinecloudwatchevent-eventbusname): String
  [Input](#sam-statemachine-statemachinecloudwatchevent-input): String
  [InputPath](#sam-statemachine-statemachinecloudwatchevent-inputpath): String
  [Pattern](#sam-statemachine-statemachinecloudwatchevent-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
```

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

 `EventBusName`   <a name="sam-statemachine-statemachinecloudwatchevent-eventbusname"></a>
Bus peristiwa yang akan dihubungkan dengan aturan ini. Jika Anda menghilangkan properti ini, AWS SAM gunakan bus acara default.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Bus peristiwa default  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` properti `AWS::Events::Rule` sumber daya.

 `Input`   <a name="sam-statemachine-statemachinecloudwatchevent-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` properti `AWS::Events::Rule Target` sumber daya.

 `InputPath`   <a name="sam-statemachine-statemachinecloudwatchevent-inputpath"></a>
Bila Anda tidak ingin meneruskan seluruh peristiwa yang sesuai ke target, gunakan properti `InputPath` untuk menggambarkan bagian mana dari peristiwa yang akan diteruskan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` properti `AWS::Events::Rule Target` sumber daya.

 `Pattern`   <a name="sam-statemachine-statemachinecloudwatchevent-pattern"></a>
Menjelaskan peristiwa yang dirutekan ke target yang ditentukan. Untuk informasi selengkapnya, lihat [Peristiwa dan Pola Peristiwa EventBridge di](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) *Panduan EventBridge Pengguna Amazon*.  
*Jenis*: [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` properti `AWS::Events::Rule` sumber daya.

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

### CloudWatchEvent
<a name="sam-property-statemachine-statemachinecloudwatchevent--examples--cloudwatchevent"></a>

Berikut adalah contoh peristiwa dari tipe sumber peristiwa `CloudWatchEvent`.

#### YAML
<a name="sam-property-statemachine-statemachinecloudwatchevent--examples--cloudwatchevent--yaml"></a>

```
CWEvent:
  Type: CloudWatchEvent
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - running
```

# EventBridgeRule
<a name="sam-property-statemachine-statemachineeventbridgerule"></a>

Objek yang menjelaskan jenis sumber `EventBridgeRule` peristiwa, yang menetapkan mesin status Anda sebagai target untuk EventBridge aturan Amazon. Untuk informasi selengkapnya, lihat [Apa itu Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) di *Panduan EventBridge Pengguna Amazon*.

AWS SAM menghasilkan sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)daya saat jenis acara ini disetel.

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

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

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

```
  DeadLetterConfig: DeadLetterConfig
  EventBusName: String
  Input: String
  InputPath: String
  InputTransformer: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)
  Pattern: [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  RetryPolicy: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  RuleName: String
  State: String
  Target: Target
```

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

 `DeadLetterConfig`   <a name="sam-statemachine-statemachineeventbridgerule-deadletterconfig"></a>
Konfigurasikan antrian Amazon Simple Queue Service (Amazon SQS) EventBridge tempat pengiriman peristiwa setelah pemanggilan target gagal. Pemanggilan dapat gagal, misalnya, saat mengirim acara ke fungsi Lambda yang tidak ada, atau ketika tidak EventBridge memiliki izin yang cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
*Jenis*: [DeadLetterConfig](sam-property-statemachine-statemachinedeadletterconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` properti tipe `AWS::Events::Rule` `Target` data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf mati untuk Anda.

 `EventBusName`   <a name="sam-statemachine-statemachineeventbridgerule-eventbusname"></a>
Bus peristiwa yang akan dihubungkan dengan aturan ini. Jika Anda menghilangkan properti ini, AWS SAM gunakan bus acara default.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: Bus peristiwa default  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` properti `AWS::Events::Rule` sumber daya.

 `Input`   <a name="sam-statemachine-statemachineeventbridgerule-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` properti `AWS::Events::Rule Target` sumber daya.

 `InputPath`   <a name="sam-statemachine-statemachineeventbridgerule-inputpath"></a>
Bila Anda tidak ingin meneruskan seluruh peristiwa yang sesuai ke target, gunakan properti `InputPath` untuk menggambarkan bagian mana dari peristiwa yang akan diteruskan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` properti `AWS::Events::Rule Target` sumber daya.

`InputTransformer`  <a name="sam-statemachine-statemachineeventbridgerule-inputtransformer"></a>
Pengaturan untuk memungkinkan Anda memberikan input kustom ke target berdasarkan data peristiwa tertentu. Anda dapat mengekstrak satu atau beberapa pasangan nilai kunci dari peristiwa dan kemudian menggunakan data tersebut untuk mengirim input yang disesuaikan ke target. Untuk informasi selengkapnya, lihat [Transformasi EventBridge input Amazon](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html) *di Panduan EventBridge Pengguna Amazon*.  
*Jenis*: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html) ` properti tipe `AWS::Events::Rule` `Target` data.

 `Pattern`   <a name="sam-statemachine-statemachineeventbridgerule-pattern"></a>
Menjelaskan peristiwa yang dirutekan ke target yang ditentukan. Untuk informasi selengkapnya, lihat [Peristiwa dan Pola Peristiwa EventBridge di](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) *Panduan EventBridge Pengguna Amazon*.  
*Jenis*: [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` properti `AWS::Events::Rule` sumber daya.

 `RetryPolicy`   <a name="sam-statemachine-statemachineeventbridgerule-retrypolicy"></a>
Objek `RetryPolicy` yang menyertakan informasi tentang pengaturan kebijakan coba lagi. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
*Jenis*: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` properti tipe `AWS::Events::Rule` `Target` data.

 `RuleName`   <a name="sam-statemachine-statemachineeventbridgerule-rulename"></a>
Nama aturan .  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` properti `AWS::Events::Rule` sumber daya.

`State`  <a name="sam-statemachine-statemachineeventbridgerule-state"></a>
Keadaan aturan.  
*Nilai yang valid*: `[ DISABLED | ENABLED ]`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` properti `AWS::Events::Rule` sumber daya.

 `Target`   <a name="sam-statemachine-statemachineeventbridgerule-target"></a>
Sumber AWS daya yang EventBridge dipanggil ketika aturan dipicu. Anda dapat menggunakan properti ini untuk menentukan ID logis dari target. Jika properti ini tidak ditentukan, maka AWS SAM menghasilkan ID logis dari target.  
*Tipe*: [Target](sam-property-statemachine-statemachinetarget.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` properti `AWS::Events::Rule` sumber daya. Versi AWS SAM properti ini hanya mengizinkan Anda untuk menentukan ID logis dari satu target.

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

### EventBridgeRule
<a name="sam-property-statemachine-statemachineeventbridgerule--examples--eventbridgerule"></a>

Berikut adalah contoh tipe sumber peristiwa `EventBridgeRule`.

#### YAML
<a name="sam-property-statemachine-statemachineeventbridgerule--examples--eventbridgerule--yaml"></a>

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
```

# DeadLetterConfig
<a name="sam-property-statemachine-statemachinedeadletterconfig"></a>

Objek yang digunakan untuk menentukan antrean Amazon Simple Queue Service (Amazon SQS) EventBridge tempat mengirimkan peristiwa setelah pemanggilan target gagal. Ininvokasi dapat gagal, misalnya, ketika mengirim sebuah peristiwa ke status mesin yang tidak ada, izin yang tidak mencukupi untuk memanggil status mesin. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *

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

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

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

```
  [Arn](#sam-statemachine-statemachinedeadletterconfig-arn): String
  [QueueLogicalId](#sam-statemachine-statemachinedeadletterconfig-queuelogicalid): String
  [Type](#sam-statemachine-statemachinedeadletterconfig-type): String
```

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

 `Arn`   <a name="sam-statemachine-statemachinedeadletterconfig-arn"></a>
Amazon Resource Name (ARN) dari antrean Amazon SQS yang ditetapkan sebagai target antrean surat mati.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` properti tipe `AWS::Events::Rule` `DeadLetterConfig` data.

 `QueueLogicalId`   <a name="sam-statemachine-statemachinedeadletterconfig-queuelogicalid"></a>
Nama kustom antrian huruf mati yang AWS SAM menciptakan if `Type` ditentukan.  
Jika `Type` properti tidak disetel, properti ini diabaikan.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-statemachine-statemachinedeadletterconfig-type"></a>
Tipe antrean. Ketika properti ini disetel, AWS SAM secara otomatis membuat [antrean huruf mati dan melampirkan kebijakan berbasis sumber daya yang diperlukan untuk memberikan izin untuk mengatur sumber daya](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) untuk mengirim peristiwa ke antrian.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Nilai yang valid*: `SQS`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

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

### DeadLetterConfig
<a name="sam-property-statemachine-statemachinedeadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

#### YAML
<a name="sam-property-statemachine-statemachinedeadletterconfig--examples--deadletterconfig--yaml"></a>

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# Target
<a name="sam-property-statemachine-statemachinetarget"></a>

Mengkonfigurasi AWS sumber daya yang EventBridge dipanggil ketika aturan dipicu.

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

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

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

```
  [Id](#sam-statemachine-statemachinetarget-id): String
```

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

 `Id`   <a name="sam-statemachine-statemachinetarget-id"></a>
ID logis dari target.  
Nilai dari `Id` dapat mencakup karakter alfanumerik, titik (`.`), tanda hubung (`-`), dan garis bawah (`_`).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` properti tipe `AWS::Events::Rule` `Target` data.

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

### Target
<a name="sam-property-statemachine-statemachinetarget--examples--target"></a>

#### YAML
<a name="sam-property-statemachine-statemachinetarget--examples--target--yaml"></a>

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Target:
      Id: MyTarget
```

# Schedule
<a name="sam-property-statemachine-statemachineschedule"></a>

Objek yang menjelaskan jenis sumber `Schedule` peristiwa, yang menetapkan mesin status Anda sebagai target EventBridge aturan yang memicu jadwal. Untuk informasi selengkapnya, lihat [Apa itu Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) di *Panduan EventBridge Pengguna Amazon*.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)sumber daya saat jenis acara ini disetel.

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

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

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

```
  [DeadLetterConfig](#sam-statemachine-statemachineschedule-deadletterconfig): DeadLetterConfig
  [Description](#sam-statemachine-statemachineschedule-description): String
  [Enabled](#sam-statemachine-statemachineschedule-enabled): Boolean
  [Input](#sam-statemachine-statemachineschedule-input): String
  [Name](#sam-statemachine-statemachineschedule-name): String
  [RetryPolicy](#sam-statemachine-statemachineschedule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  [RoleArn](#sam-statemachine-statemachineschedulev-rolearn): String
  [Schedule](#sam-statemachine-statemachineschedule-schedule): String
  [State](#sam-statemachine-statemachineschedule-state): String
  Target: Target
```

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

 `DeadLetterConfig`   <a name="sam-statemachine-statemachineschedule-deadletterconfig"></a>
Konfigurasikan antrian Amazon Simple Queue Service (Amazon SQS) EventBridge tempat pengiriman peristiwa setelah pemanggilan target gagal. Pemanggilan dapat gagal, misalnya, saat mengirim acara ke fungsi Lambda yang tidak ada, atau ketika tidak EventBridge memiliki izin yang cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
*Jenis*: [DeadLetterConfig](sam-property-statemachine-statemachinescheduledeadletterconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` properti tipe `AWS::Events::Rule` `Target` data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf mati untuk Anda.

 `Description`   <a name="sam-statemachine-statemachineschedule-description"></a>
Deskripsi aturan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description)` properti `AWS::Events::Rule` sumber daya.

 `Enabled`   <a name="sam-statemachine-statemachineschedule-enabled"></a>
Menunjukkan apakah aturan diaktifkan.  
Untuk menonaktifkan aturan, tetapkan properti ini ke `false`.  
Tentukan salah satu `Enabled` atau `State` properti, tetapi tidak keduanya.
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` properti `AWS::Events::Rule` sumber daya. Jika properti ini diatur untuk `true` kemudian AWS SAM lolos`ENABLED`, jika tidak maka akan lewat`DISABLED`.

 `Input`   <a name="sam-statemachine-statemachineschedule-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` properti `AWS::Events::Rule Target` sumber daya.

 `Name`   <a name="sam-statemachine-statemachineschedule-name"></a>
Nama aturan . Jika Anda tidak menentukan nama, CloudFormation buat ID fisik unik dan gunakan ID tersebut untuk nama aturan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` properti `AWS::Events::Rule` sumber daya.

 `RetryPolicy`   <a name="sam-statemachine-statemachineschedule-retrypolicy"></a>
Objek `RetryPolicy` yang menyertakan informasi tentang pengaturan kebijakan coba lagi. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *  
*Jenis*: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` properti tipe `AWS::Events::Rule` `Target` data.

 `RoleArn`   <a name="sam-statemachine-statemachineschedulev-rolearn"></a>
ARN dari peran IAM yang akan digunakan EventBridge Scheduler untuk target saat jadwal dipanggil.  
*Jenis*: [RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)  
*Diperlukan*: Tidak. Jika tidak disediakan, peran baru akan dibuat dan digunakan.  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` properti tipe `AWS::Scheduler::Schedule` `Target` data.

 `Schedule`   <a name="sam-statemachine-statemachineschedule-schedule"></a>
Ekspresi penjadwalan yang menentukan kapan dan seberapa sering aturan dijalankan. Untuk informasi lebih lanjut, lihat [Ekspresi Jadwal untuk Aturan](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression)` properti `AWS::Events::Rule` sumber daya.

 `State`   <a name="sam-statemachine-statemachineschedule-state"></a>
Keadaan aturan.  
*Nilai yang diterima:* `DISABLED | ENABLED`  
Tentukan salah satu `Enabled` atau `State` properti, tetapi tidak keduanya.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` properti `AWS::Events::Rule` sumber daya.

 `Target`   <a name="sam-statemachine-statemachineschedule-target"></a>
Sumber AWS daya yang EventBridge dipanggil ketika aturan dipicu. Anda dapat menggunakan properti ini untuk menentukan ID logis dari target. Jika properti ini tidak ditentukan, maka AWS SAM menghasilkan ID logis dari target.  
*Tipe*: [Target](sam-property-statemachine-statemachinetarget.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` properti `AWS::Events::Rule` sumber daya. AWS SAM Versi properti ini hanya memungkinkan Anda untuk menentukan ID logis dari satu target.

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

### CloudWatch Jadwal Acara
<a name="sam-property-statemachine-statemachineschedule--examples--cloudwatch-schedule-event"></a>

CloudWatch Jadwal Contoh Acara

#### YAML
<a name="sam-property-statemachine-statemachineschedule--examples--cloudwatch-schedule-event--yaml"></a>

```
CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false
```

# DeadLetterConfig
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig"></a>

Objek yang digunakan untuk menentukan antrean Amazon Simple Queue Service (Amazon SQS) EventBridge tempat mengirimkan peristiwa setelah pemanggilan target gagal. Ininvokasi dapat gagal, misalnya, ketika mengirim sebuah peristiwa ke status mesin yang tidak ada, izin yang tidak mencukupi untuk memanggil status mesin. *Untuk informasi selengkapnya, lihat [Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) Amazon. EventBridge *

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

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

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

```
  [Arn](#sam-statemachine-statemachinescheduledeadletterconfig-arn): String
  [QueueLogicalId](#sam-statemachine-statemachinescheduledeadletterconfig-queuelogicalid): String
  [Type](#sam-statemachine-statemachinescheduledeadletterconfig-type): String
```

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

 `Arn`   <a name="sam-statemachine-statemachinescheduledeadletterconfig-arn"></a>
Amazon Resource Name (ARN) dari antrean Amazon SQS yang ditetapkan sebagai target antrean surat mati.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` properti tipe `AWS::Events::Rule` `DeadLetterConfig` data.

 `QueueLogicalId`   <a name="sam-statemachine-statemachinescheduledeadletterconfig-queuelogicalid"></a>
Nama kustom antrian huruf mati yang AWS SAM menciptakan if `Type` ditentukan.  
Jika `Type` properti tidak disetel, properti ini diabaikan.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-statemachine-statemachinescheduledeadletterconfig-type"></a>
Tipe antrean. Ketika properti ini disetel, AWS SAM secara otomatis membuat [antrean huruf mati dan melampirkan kebijakan berbasis sumber daya yang diperlukan untuk memberikan izin untuk mengatur sumber daya](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) untuk mengirim peristiwa ke antrian.  
Tentukan `Type` properti atau `Arn` properti, tetapi tidak keduanya.
*Nilai yang valid*: `SQS`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

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

### DeadLetterConfig
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

#### YAML
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig--examples--deadletterconfig--yaml"></a>

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# Target
<a name="sam-property-statemachine-statemachinescheduletarget"></a>

Mengkonfigurasi AWS sumber daya yang EventBridge dipanggil ketika aturan dipicu.

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

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

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

```
  [Id](#sam-statemachine-statemachinescheduletarget-id): String
```

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

 `Id`   <a name="sam-statemachine-statemachinescheduletarget-id"></a>
ID logis dari target.  
Nilai dari `Id` dapat mencakup karakter alfanumerik, titik (`.`), tanda hubung (`-`), dan garis bawah (`_`).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` properti tipe `AWS::Events::Rule` `Target` data.

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

### Target
<a name="sam-property-statemachine-statemachinescheduletarget--examples--target"></a>

#### YAML
<a name="sam-property-statemachine-statemachinescheduletarget--examples--target--yaml"></a>

```
EBRule:
  Type: Schedule
  Properties:
    Target:
      Id: MyTarget
```

# ScheduleV2
<a name="sam-property-statemachine-statemachineschedulev2"></a>

Objek yang menjelaskan jenis sumber `ScheduleV2` peristiwa, yang menetapkan mesin status Anda sebagai target peristiwa Amazon EventBridge Scheduler yang dipicu pada jadwal. Untuk informasi selengkapnya, lihat [Apa itu Amazon EventBridge Scheduler?](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html) di *Panduan Pengguna EventBridge Penjadwal*.

AWS Serverless Application Model (AWS SAM) menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html)sumber daya saat jenis acara ini disetel.

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

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

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

```
DeadLetterConfig: DeadLetterConfig
[Description](#sam-statemachine-statemachineschedulev2-description): String
[EndDate](#sam-statemachine-statemachineschedulev2-enddate): String
[FlexibleTimeWindow](#sam-statemachine-statemachineschedulev2-flexibletimewindow): FlexibleTimeWindow
[GroupName](#sam-statemachine-statemachineschedulev2-groupname): String
[Input](#sam-statemachine-statemachineschedulev2-input): String
[KmsKeyArn](#sam-statemachine-statemachineschedulev2-kmskeyarn): String
[Name](#sam-statemachine-statemachineschedulev2-name): String
OmitName: Boolean
[PermissionsBoundary](#sam-statemachine-statemachineschedulev2-permissionsboundary): String
[RetryPolicy](#sam-statemachine-statemachineschedulev2-retrypolicy): RetryPolicy
[RoleArn](#sam-statemachine-statemachineschedulev2-rolearn): String
[ScheduleExpression](#sam-statemachine-statemachineschedulev2-scheduleexpression): String
[ScheduleExpressionTimezone](#sam-statemachine-statemachineschedulev2-scheduleexpressiontimezone): String
[StartDate](#sam-statemachine-statemachineschedulev2-startdate): String
[State](#sam-statemachine-statemachineschedulev2-state): String
```

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

 `DeadLetterConfig`   <a name="sam-statemachine-statemachineschedulev2-deadletterconfig"></a>
Konfigurasikan antrian Amazon Simple Queue Service (Amazon SQS) EventBridge tempat pengiriman peristiwa setelah pemanggilan target gagal. Pemanggilan dapat gagal, misalnya, saat mengirim acara ke fungsi Lambda yang tidak ada, atau ketika tidak EventBridge memiliki izin yang cukup untuk memanggil fungsi Lambda. *Untuk informasi selengkapnya, lihat [Mengonfigurasi antrian huruf mati untuk EventBridge Penjadwal di Panduan Pengguna Penjadwal](https://docs.aws.amazon.com/scheduler/latest/UserGuide/configuring-schedule-dlq.html). EventBridge *  
*Jenis*: [DeadLetterConfig](sam-property-statemachine-statemachinescheduledeadletterconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-deadletterconfig)` properti tipe `AWS::Scheduler::Schedule` `Target` data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf mati untuk Anda.

 `Description`   <a name="sam-statemachine-statemachineschedulev2-description"></a>
Deskripsi jadwal.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-description)` properti `AWS::Scheduler::Schedule` sumber daya.

 `EndDate`   <a name="sam-statemachine-statemachineschedulev2-enddate"></a>
Tanggal, di UTC, sebelum jadwal dapat memanggil targetnya. Bergantung pada ekspresi pengulangan jadwal, pemanggilan mungkin berhenti, atau sebelum, yang Anda tentukan**EndDate**.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EndDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate)` properti `AWS::Scheduler::Schedule` sumber daya.

 `FlexibleTimeWindow`   <a name="sam-statemachine-statemachineschedulev2-flexibletimewindow"></a>
Mengizinkan konfigurasi jendela di mana jadwal dapat dipanggil.  
*Jenis*: [FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler.html#cfn-scheduler-schedule-flexibletimewindow)` properti `AWS::Scheduler::Schedule` sumber daya.

 `GroupName`   <a name="sam-statemachine-statemachineschedulev2-groupname"></a>
Nama grup jadwal untuk dikaitkan dengan jadwal ini. Jika tidak ditentukan, grup default digunakan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[GroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname)` properti `AWS::Scheduler::Schedule` sumber daya.

 `Input`   <a name="sam-statemachine-statemachineschedulev2-input"></a>
Teks JSON yang valid yang dilewatkan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input)` properti `AWS::Scheduler::Schedule Target` sumber daya.

 `KmsKeyArn`   <a name="sam-statemachine-statemachineschedulev2-kmskeyarn"></a>
ARN untuk Kunci KMS yang akan digunakan untuk mengenkripsi data pelanggan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn)` properti `AWS::Scheduler::Schedule` sumber daya.

 `Name`   <a name="sam-statemachine-statemachineschedulev2-name"></a>
Nama jadwal. Jika Anda tidak menentukan nama, AWS SAM buat nama dalam format `StateMachine-Logical-IDEvent-Source-Name` dan gunakan ID tersebut untuk nama jadwal.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name)` properti `AWS::Scheduler::Schedule` sumber daya.

`OmitName`  <a name="sam-statemachine-statemachineschedulev2-omitname"></a>
Secara default, AWS SAM menghasilkan dan menggunakan nama jadwal dalam format*<State-machine-logical-ID><event-source-name>*. Tetapkan properti ini `true` agar CloudFormation menghasilkan ID fisik yang unik dan gunakan itu untuk nama jadwal sebagai gantinya.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `false`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `PermissionsBoundary`   <a name="sam-statemachine-statemachineschedulev2-permissionsboundary"></a>
ARN kebijakan yang digunakan untuk mengatur batas izin untuk peran.  
Jika `PermissionsBoundary` didefinisikan, AWS SAM akan menerapkan batasan yang sama untuk peran IAM target jadwal penjadwal.
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` properti `AWS::IAM::Role` sumber daya.

 `RetryPolicy`   <a name="sam-statemachine-statemachineschedulev2-retrypolicy"></a>
Objek `RetryPolicy` yang menyertakan informasi tentang pengaturan kebijakan coba lagi.  
*Jenis*: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)` properti tipe `AWS::Scheduler::Schedule` `Target` data.

 `RoleArn`   <a name="sam-statemachine-statemachineschedulev2-rolearn"></a>
ARN dari peran IAM yang akan digunakan EventBridge Scheduler untuk target saat jadwal dipanggil.  
*Jenis*: [RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` properti tipe `AWS::Scheduler::Schedule` `Target` data.

 `ScheduleExpression`   <a name="sam-statemachine-statemachineschedulev2-scheduleexpression"></a>
Ekspresi penjadwalan yang menentukan kapan dan seberapa sering jadwal berjalan.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression)` properti `AWS::Scheduler::Schedule` sumber daya.

 `ScheduleExpressionTimezone`   <a name="sam-statemachine-statemachineschedulev2-scheduleexpressiontimezone"></a>
Zona waktu di mana ekspresi penjadwalan dievaluasi.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ScheduleExpressionTimezone](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone)` properti `AWS::Scheduler::Schedule` sumber daya.

 `StartDate`   <a name="sam-statemachine-statemachineschedulev2-startdate"></a>
Tanggal, di UTC, setelah itu jadwal dapat mulai memanggil target. Bergantung pada ekspresi pengulangan jadwal, pemanggilan mungkin terjadi pada, atau setelah, yang Anda tentukan**StartDate**.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate)` properti `AWS::Scheduler::Schedule` sumber daya.

 `State`   <a name="sam-statemachine-statemachineschedulev2-state"></a>
Status jadwal.  
*Nilai yang diterima:* `DISABLED | ENABLED`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-state)` properti `AWS::Scheduler::Schedule` sumber daya.

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

### Contoh dasar mendefinisikan sumber daya ScheduleV2
<a name="sam-property-statemachine-statemachineschedulev2--examples--example1"></a>

```
StateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    Name: MyStateMachine
    Events:
      ScheduleEvent:
        Type: ScheduleV2
        Properties:
          ScheduleExpression: "rate(1 minute)"
      ComplexScheduleEvent:
        Type: ScheduleV2
        Properties:
          ScheduleExpression: rate(1 minute)
          FlexibleTimeWindow:
            Mode: FLEXIBLE
            MaximumWindowInMinutes: 5
          StartDate: '2022-12-28T12:00:00.000Z'
          EndDate: '2023-01-28T12:00:00.000Z'
          ScheduleExpressionTimezone: UTC
          RetryPolicy:
            MaximumRetryAttempts: 5
            MaximumEventAgeInSeconds: 300
          DeadLetterConfig:
            Type: SQS
    DefinitionUri:
      Bucket: sam-sam-s3-demo-bucket
      Key: my-state-machine.asl.json
      Version: 3
    Policies:
      - LambdaInvokePolicy:
          FunctionName: !Ref MyFunction
```