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

# AWS::Serverless::Function
<a name="sam-resource-function"></a>

Membuat AWS Lambda fungsi, peran eksekusi AWS Identity and Access Management (IAM), dan pemetaan sumber peristiwa yang memicu fungsi.

[AWS::Serverless::Function](#sam-resource-function)Resource juga mendukung atribut `Metadata` resource, sehingga Anda dapat menginstruksikan AWS SAM untuk membuat runtime kustom yang dibutuhkan aplikasi Anda. Untuk informasi selengkapnya tentang membangun waktu aktif kustom, lihat [Membangun fungsi Lambda dengan runtime khusus di AWS SAM](building-custom-runtimes.md).

**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).

## Sintaksis
<a name="sam-resource-function-syntax"></a>

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

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

```
Type: AWS::Serverless::Function
Properties:
  [Architectures](#sam-function-architectures): List
  [AssumeRolePolicyDocument](#sam-function-assumerolepolicydocument): JSON
  [AutoPublishAlias](#sam-function-autopublishalias): String
  AutoPublishAliasAllProperties: Boolean
  [AutoPublishCodeSha256](#sam-function-autopublishcodesha256): String
  [CapacityProviderConfig](#sam-function-capacityproviderconfig): CapacityProviderConfig
  [CodeSigningConfigArn](#sam-function-codesigningconfigarn): String
  [CodeUri](#sam-function-codeuri): String | FunctionCode
  [DeadLetterQueue](#sam-function-deadletterqueue): Map | DeadLetterQueue
  [DeploymentPreference](#sam-function-deploymentpreference): DeploymentPreference
  [Description](#sam-function-description): String
  [DurableConfig](#sam-function-durableconfig): DurableConfig
  [Environment](#sam-function-environment): [Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)
  [EphemeralStorage](#sam-function-ephemeralstorage): [EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)
  [EventInvokeConfig](#sam-function-eventinvokeconfig): EventInvokeConfiguration
  [Events](#sam-function-events): EventSource
  [FileSystemConfigs](#sam-function-filesystemconfigs): List
  [FunctionName](#sam-function-functionname): String
  [FunctionScalingConfig](#sam-function-functionscalingconfig): FunctionScalingConfig
  [FunctionUrlConfig](#sam-function-functionurlconfig): FunctionUrlConfig
  [Handler](#sam-function-handler): String
  [ImageConfig](#sam-function-imageconfig): [ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)
  [ImageUri](#sam-function-imageuri): String
  [InlineCode](#sam-function-inlinecode): String
  [KmsKeyArn](#sam-function-kmskeyarn): String
  [Layers](#sam-function-layers): List
  LoggingConfig: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html)
  [MemorySize](#sam-function-memorysize): Integer
  [PackageType](#sam-function-packagetype): String
  [PermissionsBoundary](#sam-function-permissionsboundary): String
  [Policies](#sam-function-policies): String | List | Map
  [PublishToLatestPublished](#sam-function-publishtolatestpublished): Boolean
  PropagateTags: Boolean
  [ProvisionedConcurrencyConfig](#sam-function-provisionedconcurrencyconfig): [ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)
  RecursiveLoop: String
  [ReservedConcurrentExecutions](#sam-function-reservedconcurrentexecutions): Integer
  [Role](#sam-function-role): String
  [RolePath](#sam-function-rolepath): String
  [Runtime](#sam-function-runtime): String
  RuntimeManagementConfig: [RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)
  SnapStart: [SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)
  [SourceKMSKeyArn](#sam-function-sourcekmskeyarn): String
  [Tags](#sam-function-tags): Map
  [TenancyConfig](#sam-function-tenancyconfig): TenancyConfig
  [Timeout](#sam-function-timeout): Integer
  [Tracing](#sam-function-tracing): String
  [VersionDescription](#sam-function-versiondescription): String
  [VersionDeletionPolicy](#sam-function-versiondeletionpolicy): String
  [VpcConfig](#sam-function-vpcconfig): [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)
```

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

 `Architectures`   <a name="sam-function-architectures"></a>
Arsitektur set instruksi untuk fungsi tersebut.  
*Untuk informasi selengkapnya tentang properti ini, lihat [Arsitektur set instruksi Lambda di Panduan](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) Pengembang.AWS Lambda *  
*Nilai yang valid*: Salah satu `x86_64` atau `arm64`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*Default*: `x86_64`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Architectures](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures)` properti `AWS::Lambda::Function` sumber daya.

 `AssumeRolePolicyDocument`   <a name="sam-function-assumerolepolicydocument"></a>
Menambahkan AssumeRolePolicyDocument untuk default yang dibuat `Role` untuk fungsi ini. Jika properti ini tidak ditentukan, AWS SAM menambahkan peran asumsi default untuk fungsi ini.  
*Tipe*: JSON  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[AssumeRolePolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-assumerolepolicydocument)` properti `AWS::IAM::Role` sumber daya. AWS SAM menambahkan properti ini ke peran IAM yang dihasilkan untuk fungsi ini. Jika Amazon Resource Name (ARN) peran tersedia untuk fungsi ini, properti ini tidak melakukan apa-apa.

 `AutoPublishAlias`   <a name="sam-function-autopublishalias"></a>
Nama alias Lambda. Untuk informasi selengkapnya tentang alias Lambda, lihat [Alias fungsi Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) di *Panduan Developer AWS Lambda *. Untuk contoh yang menggunakan properti ini, lihat [Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM](automating-updates-to-serverless-apps.md).  
AWS SAM menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html)dan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html)sumber daya saat properti ini disetel. Untuk informasi selengkapnya tentang skenario ini, lihat [AutoPublishAlias properti ditentukan](sam-specification-generated-resources-function.md#sam-specification-generated-resources-function-autopublishalias). Untuk informasi umum tentang CloudFormation sumber daya yang dihasilkan, lihat[CloudFormation Sumber daya yang dihasilkan untuk AWS SAM](sam-specification-generated-resources.md).  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AutoPublishAliasAllProperties`   <a name="sam-function-autopublishaliasallproperties"></a>
Menentukan ketika baru [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html)dibuat. Kapan`true`, versi Lambda baru dibuat ketika properti apa pun dalam fungsi Lambda diubah. Kapan`false`, versi Lambda baru dibuat hanya jika salah satu properti berikut dimodifikasi:  
+ `Environment`, `MemorySize`, atau `SnapStart`.
+ Setiap perubahan yang menghasilkan pembaruan ke `Code` properti, seperti`CodeDict`,`ImageUri`, atau`InlineCode`.
Properti ini `AutoPublishAlias` harus didefinisikan.  
Jika juga `AutoPublishCodeSha256` ditentukan, perilakunya lebih diutamakan. `AutoPublishAliasAllProperties: true`  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Nilai default*: `false`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `AutoPublishCodeSha256`   <a name="sam-function-autopublishcodesha256"></a>
Saat digunakan, string ini bekerja dengan `CodeUri` nilai untuk menentukan apakah versi Lambda baru perlu dipublikasikan. Properti ini sering digunakan untuk mengatasi masalah penerapan berikut: Paket penerapan disimpan di lokasi Amazon S3 dan digantikan oleh paket penerapan baru dengan kode fungsi Lambda yang diperbarui tetapi properti tetap tidak berubah (sebagai lawan `CodeUri` dari paket penerapan baru yang diunggah ke lokasi Amazon S3 baru dan diubah ke lokasi baru). `CodeUri`  
Masalah ini ditandai dengan AWS SAM template yang memiliki karakteristik sebagai berikut:  
+ `DeploymentPreference`Objek dikonfigurasi untuk penerapan bertahap (seperti yang dijelaskan dalam) [Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM](automating-updates-to-serverless-apps.md)
+ `AutoPublishAlias`Properti disetel dan tidak berubah di antara penerapan
+ `CodeUri`Properti disetel dan tidak berubah di antara penerapan.
Dalam skenario ini, memperbarui `AutoPublishCodeSha256` menghasilkan versi Lambda baru yang berhasil dibuat. Namun, kode fungsi baru yang diterapkan ke Amazon S3 tidak akan dikenali. Untuk mengenali kode fungsi baru, pertimbangkan untuk menggunakan pembuatan versi di bucket Amazon S3 Anda. Tentukan `Version` properti untuk fungsi Lambda Anda dan konfigurasikan bucket Anda agar selalu menggunakan paket penerapan terbaru.  
Dalam skenario ini, agar berhasil memicu deployment bertahap, Anda harus memberikan nilai unik untuk `AutoPublishCodeSha256`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `CapacityProviderConfig`   <a name="sam-function-capacityproviderconfig"></a>
Mengkonfigurasi penyedia kapasitas tempat versi fungsi yang diterbitkan akan dilampirkan. Ini memungkinkan fungsi berjalan pada instans EC2 milik pelanggan yang dikelola oleh Instans Terkelola Lambda.  
*Jenis*: [CapacityProviderConfig](sam-property-function-capacityproviderconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: SAM meratakan properti yang diteruskan ke `[CapacityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-capacityproviderconfig)` properti `AWS::Lambda::Function` sumber daya dan merekonstruksi struktur bersarang.

 `CodeSigningConfigArn`   <a name="sam-function-codesigningconfigarn"></a>
ARN [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html)sumber daya, digunakan untuk mengaktifkan penandatanganan kode untuk fungsi ini. Untuk informasi selengkapnya tentang penandatanganan kode, lihat [Siapkan penandatanganan kode untuk AWS SAM aplikasi Anda](authoring-codesigning.md).  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[CodeSigningConfigArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn)` properti `AWS::Lambda::Function` sumber daya.

 `CodeUri`   <a name="sam-function-codeuri"></a>
Kode untuk fungsi. Nilai yang diterima meliputi:  
+ Fungsi Amazon S3 URI. Misalnya, `s3://bucket-123456789/sam-app/1234567890abcdefg`.
+ Jalur lokal ke fungsi. Misalnya, `hello_world/`.
+ Sebuah objek [FunctionCode](sam-property-function-functioncode.md).
Jika Anda menyediakan URI atau [FunctionCode](sam-property-function-functioncode.md) objek Amazon S3 fungsi, Anda harus mereferensikan paket penerapan [Lambda](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) yang valid.  
Jika Anda menyediakan jalur file lokal, gunakan AWS SAMCLI untuk mengunggah file lokal saat penerapan. Untuk mempelajari selengkapnya, lihat [Cara AWS SAM mengunggah file lokal saat penerapan](deploy-upload-local-files.md).  
Jika Anda menggunakan fungsi intrinsik di `CodeUri` properti, tidak AWS SAM akan dapat mengurai nilai dengan benar. Pertimbangkan untuk menggunakan [AWS::LanguageExtensions transform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-languageextensions.html) sebagai gantinya.
*Jenis*: [String \$1[FunctionCode](sam-property-function-functioncode.md)]  
*Diperlukan*: Bersyarat. Kapan `PackageType` diatur ke`Zip`, salah satu `CodeUri` atau `InlineCode` diperlukan.  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[ Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code)` properti `AWS::Lambda::Function` sumber daya. Properti Amazon S3 yang di-nest diberi nama berbeda.

 `DeadLetterQueue`   <a name="sam-function-deadletterqueue"></a>
Mengonfigurasi topik Amazon Simple Notification Service (Amazon SNS) atau antrean Amazon Simple Queue Service (Amazon SQS) tempat Lambda mengirimkan peristiwa yang tidak dapat diproses. *Untuk informasi selengkapnya tentang fungsionalitas antrian huruf mati, lihat Antrian [huruf mati di Panduan](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq) Pengembang.AWS Lambda *  
Jika sumber peristiwa fungsi Lambda Anda adalah antrean Amazon SQS, konfigurasikan antrian huruf mati untuk antrean sumber, bukan untuk fungsi Lambda. Antrean surat mati yang dikonfigurasikan untuk fungsi digunakan untuk [antrean invokasi tidak sinkron](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) fungsi, bukan untuk antrean sumber peristiwa.
*Jenis*: Peta \$1 [DeadLetterQueue](sam-property-function-deadletterqueue.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html)` properti `AWS::Lambda::Function` sumber daya. Dalam CloudFormation jenis ini berasal dari`TargetArn`, sedangkan di AWS SAM Anda harus melewati tipe bersama dengan`TargetArn`.

 `DeploymentPreference`   <a name="sam-function-deploymentpreference"></a>
Pengaturan untuk mengaktifkan deployment Lambda bertahap.  
Jika `DeploymentPreference` objek ditentukan, AWS SAM membuat [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html)dipanggil `ServerlessDeploymentApplication` (satu per tumpukan), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html)dipanggil`<function-logical-id>DeploymentGroup`, dan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)dipanggil`CodeDeployServiceRole`.  
*Jenis*: [DeploymentPreference](sam-property-function-deploymentpreference.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Lihat juga*: Untuk informasi selengkapnya tentang properti ini, lihat [Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM](automating-updates-to-serverless-apps.md).

 `Description`   <a name="sam-function-description"></a>
Deskripsi fungsi.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description)` properti `AWS::Lambda::Function` sumber daya.

 `DurableConfig`   <a name="sam-function-durableconfig"></a>
Konfigurasi untuk fungsi yang tahan lama. Mengaktifkan eksekusi stateful dengan kemampuan checkpointing dan replay otomatis.  
*Jenis*: [DurableConfig](sam-property-function-durableconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Environment`   <a name="sam-function-environment"></a>
Konfigurasi untuk lingkungan waktu aktif.  
*Tipe*: [Lingkungan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)` properti `AWS::Lambda::Function` sumber daya.

 `EphemeralStorage`   <a name="sam-function-ephemeralstorage"></a>
Objek yang menentukan ruang disk, dalam MB, tersedia untuk fungsi Lambda Anda di. `/tmp`  
Untuk informasi selengkapnya tentang properti ini, lihat [lingkungan eksekusi Lambda](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) di Panduan *AWS Lambda Pengembang*.  
*Jenis*: [EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)` properti `AWS::Lambda::Function` sumber daya.

 `EventInvokeConfig`   <a name="sam-function-eventinvokeconfig"></a>
Objek yang menggambarkan peristiwa memanggil konfigurasi pada fungsi Lambda.  
*Jenis*: [EventInvokeConfiguration](sam-property-function-eventinvokeconfiguration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

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

 `FileSystemConfigs`   <a name="sam-function-filesystemconfigs"></a>
Daftar [FileSystemConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html)objek yang menentukan pengaturan koneksi untuk sistem file Amazon Elastic File System (Amazon EFS).  
Jika template Anda berisi [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)sumber daya, Anda juga harus menentukan atribut `DependsOn` resource untuk memastikan bahwa target mount dibuat atau diperbarui sebelum fungsi.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FileSystemConfigs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs)` properti `AWS::Lambda::Function` sumber daya.

 `FunctionName`   <a name="sam-function-functionname"></a>
Nama untuk fungsi. Jika Anda tidak menentukan nama, nama unik akan dibuat untuk Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname)` properti `AWS::Lambda::Function` sumber daya.

 `FunctionScalingConfig`   <a name="sam-function-functionscalingconfig"></a>
Mengonfigurasi perilaku penskalaan untuk fungsi Lambda yang berjalan pada penyedia kapasitas. Mendefinisikan jumlah minimum dan maksimum lingkungan eksekusi.  
*Jenis*: [FunctionScalingConfig](sam-property-function-functionscalingconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig)` properti `AWS::Lambda::Function` sumber daya.

 `FunctionUrlConfig`   <a name="sam-function-functionurlconfig"></a>
Objek yang menggambarkan URL fungsi. URL fungsi adalah titik akhir HTTPS yang dapat Anda gunakan untuk menjalankan fungsi Anda.  
Untuk informasi selengkapnya, lihat [Fungsi URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) dalam *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FunctionUrlConfig](sam-property-function-functionurlconfig.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Handler`   <a name="sam-function-handler"></a>
Fungsi dalam kode Anda yang dipanggil untuk memulai eksekusi. Properti ini hanya diperlukan jika properti `PackageType` diatur ke `Zip`.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Handler](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler)` properti `AWS::Lambda::Function` sumber daya.

 `ImageConfig`   <a name="sam-function-imageconfig"></a>
Objek yang digunakan untuk mengonfigurasi pengaturan citra kontainer Lambda. Untuk informasi selengkapnya, lihat [Menggunakan citra kontainer dengan Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) di *Panduan Developer AWS Lambda *.  
*Jenis*: [ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)` properti `AWS::Lambda::Function` sumber daya.

 `ImageUri`   <a name="sam-function-imageuri"></a>
URI repositori Amazon Elastic Container Registry (Amazon ECR) untuk citra kontainer fungsi Lambda ini. Properti ini hanya berlaku jika properti `PackageType` diatur ke `Image`, jika tidak akan diabaikan. Untuk informasi selengkapnya, lihat [Menggunakan citra kontainer dengan Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) di *Panduan Developer AWS Lambda *.  
Jika `PackageType` properti disetel ke`Image`, maka `ImageUri` diperlukan, atau Anda harus membangun aplikasi Anda dengan `Metadata` entri yang diperlukan dalam file AWS SAM template. Untuk informasi selengkapnya, lihat [Membangun default dengan AWS SAM](serverless-sam-cli-using-build.md).
Membangun aplikasi Anda dengan `Metadata` entri yang diperlukan lebih diutamakan`ImageUri`, jadi jika Anda menentukan keduanya maka `ImageUri` diabaikan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ImageUri](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri)` properti tipe `AWS::Lambda::Function` `Code` data.

 `InlineCode`   <a name="sam-function-inlinecode"></a>
Kode fungsi Lambda yang ditulis langsung dalam templat. Properti ini hanya berlaku jika properti `PackageType` diatur ke `Zip`, jika tidak akan diabaikan.  
Jika properti `PackageType` diatur ke `Zip` (default), salah satu `CodeUri` atau `InlineCode` harus ada.
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ZipFile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile)` properti tipe `AWS::Lambda::Function` `Code` data.

 `KmsKeyArn`   <a name="sam-function-kmskeyarn"></a>
ARN dari kunci AWS Key Management Service (AWS KMS) yang digunakan Lambda untuk mengenkripsi dan mendekripsi variabel lingkungan fungsi Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn)` properti `AWS::Lambda::Function` sumber daya.

 `Layers`   <a name="sam-function-layers"></a>
Daftar `LayerVersion` ARNs yang harus digunakan fungsi ini. Urutan yang ditentukan di sini adalah urutan ketika urutan impor saat menjalankan fungsi Lambda. Versi ini adalah ARN lengkap termasuk versi atau referensi ke sumber daya. LayerVersion Misalnya, referensi ke a `LayerVersion` akan `!Ref MyLayer` sementara ARN lengkap termasuk versi akan. `arn:aws:lambda:region:account-id:layer:layer-name:version`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Layers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers)` properti `AWS::Lambda::Function` sumber daya.

 `LoggingConfig`   <a name="sam-function-loggingconfig"></a>
Pengaturan konfigurasi Amazon CloudWatch Logs fungsi.  
*Jenis*: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig)properti `AWS::Lambda::Function` sumber daya.

 `MemorySize`   <a name="sam-function-memorysize"></a>
Ukuran memori dalam MB yang dialokasikan per pemanggilan fungsi.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MemorySize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize)` properti `AWS::Lambda::Function` sumber daya.

 `PackageType`   <a name="sam-function-packagetype"></a>
Tipe paket deployment fungsi Lambda. Untuk informasi lebih lanjut, lihat [Paket deployment Lambda](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) di *Panduan Developer AWS Lambda *.  
**Catatan:**  
1. Jika properti ini diatur ke `Zip` (default), `CodeUri` atau `InlineCode` berlaku, dan `ImageUri` diabaikan.  
2. Jika properti ini diatur ke `Image`, hanya `ImageUri` yang berlaku, dan `CodeUri` dan `InlineCode` diabaikan. Repositori Amazon ECR yang diperlukan untuk menyimpan gambar kontainer fungsi dapat dibuat secara otomatis oleh file. AWS SAMCLI Untuk informasi selengkapnya, lihat [sam deploy](sam-cli-command-reference-sam-deploy.md).  
*Nilai yang valid*: `Zip` atau `Image`  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `Zip`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PackageType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype)` properti `AWS::Lambda::Function` sumber daya.

 `PermissionsBoundary`   <a name="sam-function-permissionsboundary"></a>
ARN batas izin untuk digunakan untuk peran eksekusi fungsi ini. Properti ini bekerja hanya jika peran 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-function-policies"></a>
Kebijakan izin untuk fungsi ini. Kebijakan akan ditambahkan ke peran eksekusi default AWS Identity and Access Management (IAM) fungsi.  
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 mirip dengan `[Policies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-policies)` properti `AWS::IAM::Role` sumber daya.

 `PublishToLatestPublished`   <a name="sam-function-publishtolatestpublished"></a>
Menentukan apakah akan menerbitkan versi fungsi terbaru ketika fungsi diperbarui.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PublishToLatestPublished](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-publishtolatestpublished)` properti `AWS::Lambda::Function` sumber daya.

`PropagateTags`  <a name="sam-function-propagatetags"></a>
Tunjukkan apakah akan meneruskan tag dari `Tags` properti ke sumber daya yang Anda [AWS::Serverless::Function](sam-specification-generated-resources-function.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.

 `ProvisionedConcurrencyConfig`   <a name="sam-function-provisionedconcurrencyconfig"></a>
Konfigurasi konkurensi yang disediakan untuk alias fungsi.  
`ProvisionedConcurrencyConfig`dapat ditentukan hanya jika `AutoPublishAlias` diatur. Jika tidak, akan terjadi kesalahan.
*Jenis*: [ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)` properti `AWS::Lambda::Alias` sumber daya.

 `RecursiveLoop`   <a name="sam-function-recursiveloop"></a>
Status konfigurasi deteksi loop rekursif fungsi Anda.  
Ketika nilai ini disetel ke `Allow` dan Lambda mendeteksi fungsi Anda dipanggil sebagai bagian dari loop rekursif, itu tidak mengambil tindakan apa pun.  
Ketika nilai ini disetel ke `Terminate` dan Lambda mendeteksi fungsi Anda dipanggil sebagai bagian dari loop rekursif, itu menghentikan fungsi Anda dipanggil dan memberi tahu Anda.   
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RecursiveLoop](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-recursiveloop)` properti `AWS::Lambda::Function` sumber daya.

 `ReservedConcurrentExecutions`   <a name="sam-function-reservedconcurrentexecutions"></a>
Jumlah maksimum eksekusi bersamaan yang ingin Anda simpan untuk fungsi tersebut.  
Untuk informasi lebih lanjut, lihat [Skala Fungsi Lambda](https://docs.aws.amazon.com/lambda/latest/dg/scaling.html) dalam *Panduan Developer AWS Lambda *.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ReservedConcurrentExecutions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions)` properti `AWS::Lambda::Function` sumber daya.

 `Role`   <a name="sam-function-role"></a>
ARN dari IAM role untuk digunakan sebagai peran eksekusi fungsi ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role)` properti `AWS::Lambda::Function` sumber daya. Ini diperlukan di CloudFormation tetapi tidak di AWS SAM. Jika peran tidak ditentukan, satu dibuat untuk Anda dengan ID logis `<function-logical-id>Role`.

 `RolePath`   <a name="sam-function-rolepath"></a>
Jalur ke peran eksekusi IAM fungsi.  
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.

 `Runtime`   <a name="sam-function-runtime"></a>
Pengenal [waktu aktif](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) fungsi. Properti ini hanya diperlukan jika properti `PackageType` diatur ke `Zip`.  
Jika Anda menentukan `provided` identifier untuk properti ini, Anda dapat menggunakan atribut `Metadata` resource untuk menginstruksikan AWS SAM untuk membangun runtime kustom yang diperlukan fungsi ini. Untuk informasi selengkapnya tentang membangun waktu aktif kustom, lihat [Membangun fungsi Lambda dengan runtime khusus di AWS SAM](building-custom-runtimes.md).
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Runtime](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime)` properti `AWS::Lambda::Function` sumber daya.

 `RuntimeManagementConfig`   <a name="sam-function-runtimemanagementconfig"></a>
Konfigurasikan opsi manajemen runtime untuk fungsi Lambda Anda seperti pembaruan lingkungan runtime, perilaku rollback, dan memilih versi runtime tertentu. *Untuk mempelajari selengkapnya, lihat [Pembaruan runtime Lambda di Panduan](https://docs.aws.amazon.com//lambda/latest/dg/runtimes-update.html) Pengembang.AWS Lambda *  
*Jenis*: [RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)` properti `AWS::Lambda::Function` sumber daya.

 `SnapStart`   <a name="sam-function-snapstart"></a>
Buat snapshot dari versi fungsi Lambda baru. Snapshot adalah status cache dari fungsi inisialisasi Anda, termasuk semua dependensinya. Fungsi ini diinisialisasi hanya sekali dan status cache digunakan kembali untuk semua pemanggilan future, meningkatkan kinerja aplikasi dengan mengurangi berapa kali fungsi Anda harus diinisialisasi. Untuk mempelajari lebih lanjut, lihat [Meningkatkan kinerja startup dengan Lambda SnapStart di Panduan AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) *Pengembang*.  
*Jenis*: [SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)` properti `AWS::Lambda::Function` sumber daya.

 `SourceKMSKeyArn`   <a name="sam-function-sourcekmskeyarn"></a>
Merupakan ARN kunci KMS yang digunakan untuk mengenkripsi kode fungsi ZIP pelanggan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SourceKMSKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-sourcekmskeyarn)` properti tipe `AWS::Lambda::Function` `Code` data.

 `Tags`   <a name="sam-function-tags"></a>
Sebuah peta (string ke string) yang menentukan tanda ditambahkan ke fungsi ini. Untuk detail tentang kunci dan nilai yang valid untuk tag, lihat [Kunci Tag dan Persyaratan Nilai](https://docs.aws.amazon.com/lambda/latest/dg/configuration-tags.html#configuration-tags-restrictions) di *Panduan AWS Lambda Pengembang*.  
Saat tumpukan dibuat, AWS SAM secara otomatis menambahkan `lambda:createdBy:SAM` tag ke fungsi Lambda ini, dan ke peran default yang dihasilkan untuk fungsi ini.  
*Tipe*: Peta  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags)` properti `AWS::Lambda::Function` sumber daya. `Tags`Properti di AWS SAM terdiri dari pasangan kunci-nilai (sedangkan dalam properti CloudFormation ini terdiri dari daftar `Tag` objek). Selain itu, AWS SAM secara otomatis menambahkan `lambda:createdBy:SAM` tag ke fungsi Lambda ini, dan ke peran default yang dihasilkan untuk fungsi ini.

 `TenancyConfig`   <a name="sam-function-tenancyconfig"></a>
Konfigurasi untuk mode isolasi penyewa Lambda. Memastikan lingkungan eksekusi tidak pernah dibagi antara penyewa yang berbeda IDs, menyediakan isolasi tingkat komputasi untuk aplikasi multi-penyewa.  
*Jenis*: [TenancyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tenancyconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TenancyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tenancyconfig)` properti `AWS::Lambda::Function` sumber daya.

 `Timeout`   <a name="sam-function-timeout"></a>
Waktu maksimum dalam detik bahwa fungsi dapat berjalan sebelum dihentikan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 3  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Timeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout)` properti `AWS::Lambda::Function` sumber daya.

 `Tracing`   <a name="sam-function-tracing"></a>
String yang menentukan mode pelacakan X-Ray fungsi.  
+ `Active`- Mengaktifkan penelusuran X-Ray untuk fungsi tersebut.
+ `Disabled`- Menonaktifkan X-Ray untuk fungsinya.
+ `PassThrough`- Mengaktifkan penelusuran X-Ray untuk fungsi tersebut. Keputusan pengambilan sampel didelegasikan ke layanan hilir.
Jika ditentukan sebagai `Active` atau `PassThrough` dan `Role` properti tidak disetel, AWS SAM tambahkan `arn:aws:iam::aws:policy/AWSXrayWriteOnlyAccess` kebijakan ke peran eksekusi Lambda yang dibuatnya untuk Anda.  
Untuk informasi selengkapnya tentang X-Ray, lihat [Menggunakan AWS Lambda dengan AWS X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html) di *Panduan AWS Lambda Pengembang*.  
*Nilai yang valid*: [`Active`\$1 `Disabled` \$1`PassThrough`]  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[TracingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig)` properti `AWS::Lambda::Function` sumber daya.

 `VersionDescription`   <a name="sam-function-versiondescription"></a>
Menentukan bidang `Description` yang ditambahkan pada sumber daya versi Lambda baru.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description)` properti `AWS::Lambda::Version` sumber daya.

 `VersionDeletionPolicy`   <a name="sam-function-versiondeletionpolicy"></a>
Menentukan kebijakan penghapusan untuk sumber daya versi Lambda yang dibuat saat disetel. `AutoPublishAlias` Ini mengontrol apakah sumber daya versi dipertahankan atau dihapus saat tumpukan dihapus.  
*Nilai yang valid*: `Delete`, `Retain`, atau `Snapshot`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan. Ini menetapkan `DeletionPolicy` atribut pada `AWS::Lambda::Version` sumber daya yang dihasilkan.

 `VpcConfig`   <a name="sam-function-vpcconfig"></a>
Konfigurasi yang memungkinkan fungsi ini mengakses sumber daya privat dalam virtual private cloud (VPC) Anda.  
*Jenis*: [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)` properti `AWS::Lambda::Function` sumber daya.

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

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

Ketika ID logis dari sumber daya ini disediakan untuk fungsi intrinsik `Ref`, ID mengembalikan nama sumber daya dari fungsi Lambda utama.

Untuk informasi lebih lanjut tentang menggunakan 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-function-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 tentang 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 *. 

`Arn`  <a name="Arn-fn::getatt"></a>
ARN fungsi Lambda utama.

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

### Fungsi sederhana
<a name="sam-resource-function-examples-simple-function"></a>

Berikut ini adalah contoh dasar sumber daya [AWS::Serverless::Function](#sam-resource-function) dari tipe paket `Zip` (default) dan kode fungsi dalam bucket Amazon S3.

#### YAML
<a name="sam-resource-function-examples-simple-function--yaml"></a>

```
Type: AWS::Serverless::Function
Properties:
  Handler: index.handler
  Runtime: python3.9
  CodeUri: s3://bucket-name/key-name
```

### Contoh properti fungsi
<a name="sam-resource-function-examples-function-properties-example"></a>

Berikut ini adalah contoh-contoh [AWS::Serverless::Function](#sam-resource-function) dari tipe paket `Zip` (default) yang menggunakan `InlineCode`, `Layers`, `Tracing`, `Policies`, `Amazon EFS`, dan sumber peristiwa `Api`.

#### YAML
<a name="sam-resource-function-examples-function-properties-example--yaml"></a>

```
Type: AWS::Serverless::Function
DependsOn: MyMountTarget        # This is needed if an AWS::EFS::MountTarget resource is declared for EFS
Properties:
  Handler: index.handler
  Runtime: python3.9
  InlineCode: |
    def handler(event, context):
      print("Hello, world!")
  ReservedConcurrentExecutions: 30
  Layers:
    - Ref: MyLayer
  Tracing: Active
  Timeout: 120
  FileSystemConfigs:
    - Arn: !Ref MyEfsFileSystem
      LocalMountPath: /mnt/EFS
  Policies:
    - AWSLambdaExecute
    - Version: '2012-10-17		 	 	 ' 
      Statement:
        - Effect: Allow
          Action:
            - s3:GetObject
            - s3:GetObjectACL
          Resource: 'arn:aws:s3:::sam-s3-demo-bucket/*'
  Events:
    ApiEvent:
      Type: Api
      Properties:
        Path: /path
        Method: get
```

### ImageConfig contoh
<a name="sam-resource-function-examples-imageconfig-example"></a>

Berikut ini adalah contoh-contoh `ImageConfig` untuk fungsi Lambda dari tipe paket `Image`.

#### YAML
<a name="sam-resource-function-examples-imageconfig-example--yaml"></a>

```
HelloWorldFunction:
  Type: AWS::Serverless::Function
  Properties:
    PackageType: Image
    ImageUri: account-id.dkr.ecr.region.amazonaws.com/ecr-repo-name:image-name
    ImageConfig:
      Command:
        - "app.lambda_handler"
      EntryPoint:
        - "entrypoint1"
      WorkingDirectory: "workDir"
```

### RuntimeManagementConfig contoh
<a name="sam-resource-function-examples-runtimemanagementconfig-examples"></a>

Fungsi Lambda yang dikonfigurasi untuk memperbarui lingkungan runtime-nya sesuai dengan perilaku saat ini:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      UpdateRuntimeOn: Auto
```

Fungsi Lambda yang dikonfigurasi untuk memperbarui lingkungan runtime-nya saat fungsi diperbarui:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      UpdateRuntimeOn: FunctionUpdate
```

Fungsi Lambda yang dikonfigurasi untuk memperbarui lingkungan runtime-nya secara manual:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      RuntimeVersionArn: arn:aws:lambda:us-east-1::runtime:4c459dd0104ee29ec65dcad056c0b3ddbe20d6db76b265ade7eda9a066859b1e
      UpdateRuntimeOn: Manual
```

### SnapStart contoh
<a name="sam-resource-function-examples-snapstart-examples"></a>

Contoh fungsi Lambda dengan SnapStart dihidupkan untuk versi masa depan:

```
TestFunc
  Type: AWS::Serverless::Function
  Properties:
    ...
    SnapStart:
      ApplyOn: PublishedVersions
```

### TenancyConfig contoh
<a name="sam-resource-function-examples-tenancyconfig-examples"></a>

Contoh fungsi Lambda dengan mode isolasi penyewa diaktifkan:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    TenancyConfig:
      TenantIsolationMode: PER_TENANT
```

# DeadLetterQueue
<a name="sam-property-function-deadletterqueue"></a>

Menentukan antrian SQS atau topik SNS yang ( AWS Lambda Lambda) mengirimkan peristiwa ketika tidak dapat memproses mereka. *Untuk informasi selengkapnya tentang fungsionalitas antrian surat mati, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq)AWS Lambda *

SAM akan secara otomatis menambahkan izin yang sesuai ke peran eksekusi fungsi Lambda Anda untuk memberikan akses layanan Lambda ke sumber daya. sqs: SendMessage akan ditambahkan untuk antrian SQS dan SNS: Publikasikan untuk topik SNS.

## Sintaksis
<a name="sam-property-function-deadletterqueue-syntax"></a>

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

### YAML
<a name="sam-property-function-deadletterqueue-syntax.yaml"></a>

```
  [TargetArn](#sam-function-deadletterqueue-targetarn): String
  [Type](#sam-function-deadletterqueue-type): String
```

## Sifat-sifat
<a name="sam-property-function-deadletterqueue-properties"></a>

 `TargetArn`   <a name="sam-function-deadletterqueue-targetarn"></a>
Amazon Resource Name (ARN) antrean Amazon SQS atau topik Amazon SNS.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TargetArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html#cfn-lambda-function-deadletterconfig-targetarn)` properti tipe `AWS::Lambda::Function` `DeadLetterConfig` data.

 `Type`   <a name="sam-function-deadletterqueue-type"></a>
Tipe antrean surat mati.  
*Nilai valid:* `SNS`, `SQS`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-deadletterqueue--examples"></a>

### DeadLetterQueue
<a name="sam-property-function-deadletterqueue--examples--deadletterqueue"></a>

Contoh Antrean Surat Mati untuk topik SNS.

#### YAML
<a name="sam-property-function-deadletterqueue--examples--deadletterqueue--yaml"></a>

```
DeadLetterQueue:
  Type: SNS
  TargetArn: arn:aws:sns:us-east-2:123456789012:my-topic
```

# DeploymentPreference
<a name="sam-property-function-deploymentpreference"></a>

Menentukan konfigurasi untuk mengaktifkan deployment Lambda bertahap. Untuk informasi selengkapnya tentang konfigurasi deployment Lambda secara bertahap, lihat [Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM](automating-updates-to-serverless-apps.md).

**catatan**  
Anda harus menentukan `AutoPublishAlias` dalam Anda [AWS::Serverless::Function](sam-resource-function.md) untuk menggunakan `DeploymentPreference` objek, jika tidak kesalahan akan terjadi.

## Sintaksis
<a name="sam-property-function-deploymentpreference-syntax"></a>

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

### YAML
<a name="sam-property-function-deploymentpreference-syntax.yaml"></a>

```
  [Alarms](#sam-function-deploymentpreference-alarms): List
  [Enabled](#sam-function-deploymentpreference-enabled): Boolean
  [Hooks](#sam-function-deploymentpreference-hooks): Hooks
  [PassthroughCondition](#sam-function-deploymentpreference-passthroughcondition): Boolean
  [Role](#sam-function-deploymentpreference-role): String
  [TriggerConfigurations](#sam-function-deploymentpreference-triggerconfigurations): List
  [Type](#sam-function-deploymentpreference-type): String
```

## Sifat-sifat
<a name="sam-property-function-deploymentpreference-properties"></a>

 `Alarms`   <a name="sam-function-deploymentpreference-alarms"></a>
Daftar CloudWatch alarm yang ingin Anda picu oleh kesalahan apa pun yang dimunculkan oleh penerapan.  
Properti ini menerima fungsi intrinsik `Fn::If`. Lihat bagian Contoh di bagian bawah topik ini untuk contoh templat yang menggunakan `Fn::If`.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Enabled`   <a name="sam-function-deploymentpreference-enabled"></a>
Apakah preferensi deployment ini diaktifkan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: BETUL  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Hooks`   <a name="sam-function-deploymentpreference-hooks"></a>
Validasi fungsi Lambda yang dijalankan sebelum dan sesudah pergeseran lalu lintas.  
*Tipe*: [Hook](sam-property-function-hooks.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `PassthroughCondition`   <a name="sam-function-deploymentpreference-passthroughcondition"></a>
Jika Benar, dan jika preferensi penerapan ini diaktifkan, Kondisi fungsi akan diteruskan ke CodeDeploy sumber daya yang dihasilkan. Umumnya, Anda harus mengatur ini ke True. Jika tidak, CodeDeploy sumber daya akan dibuat bahkan jika Kondisi fungsi diselesaikan menjadi False.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Role`   <a name="sam-function-deploymentpreference-role"></a>
Peran IAM ARN CodeDeploy yang akan digunakan untuk pergeseran lalu lintas. IAM role tidak akan dibuat jika ini disediakan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `TriggerConfigurations`   <a name="sam-function-deploymentpreference-triggerconfigurations"></a>
Daftar konfigurasi pemicu yang ingin Anda kaitkan dengan grup deployment. Digunakan untuk memberitahu topik SNS pada peristiwa siklus hidup.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TriggerConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations)` properti `AWS::CodeDeploy::DeploymentGroup` sumber daya.

 `Type`   <a name="sam-function-deploymentpreference-type"></a>
Ada dua kategori tipe deployment pada saat ini: Linear dan Canary. Untuk informasi selengkapnya tentang tipe deployment yang tersedia, lihat [Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM](automating-updates-to-serverless-apps.md).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-deploymentpreference--examples"></a>

### DeploymentPreference dengan kait sebelum dan sesudah lalu lintas.
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-pre--and-post-traffic-hooks."></a>

Contoh preferensi deployment yang berisi kait pra dan pascalalulintas.

#### YAML
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-pre--and-post-traffic-hooks.--yaml"></a>

```
DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    - !Ref: AliasErrorMetricGreaterThanZeroAlarm
    - !Ref: LatestVersionErrorMetricGreaterThanZeroAlarm
  Hooks:
    PreTraffic:
      !Ref: PreTrafficLambdaFunction
    PostTraffic:
      !Ref: PostTrafficLambdaFunction
```

### DeploymentPreference dengan Fn: :Jika fungsi intrinsik
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-fn::if-intrinsic-function"></a>

Contoh preferensi deployment yang menggunakan `Fn::If` untuk mengonfigurasi alarm. Dalam contoh ini, `Alarm1` akan dikonfigurasi jika `MyCondition` adalah `true`, dan `Alarm2` dan `Alarm5` akan dikonfigurasi jika `MyCondition` adalah `false`.

#### YAML
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-fn::if-intrinsic-function--yaml"></a>

```
DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    Fn::If:
      - MyCondition
      - - Alarm1
      - - Alarm2
        - Alarm5
```

# Hooks
<a name="sam-property-function-hooks"></a>

Validasi fungsi Lambda yang dijalankan sebelum dan sesudah pergeseran lalu lintas.

**catatan**  
Fungsi Lambda yang direferensikan dalam properti ini mengkonfigurasi `CodeDeployLambdaAliasUpdate` objek sumber daya yang dihasilkan. [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html) Untuk informasi selengkapnya, lihat [CodeDeployLambdaAliasUpdate Kebijakan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-codedeploylambdaaliasupdate) di *Panduan AWS CloudFormation Pengguna*.

## Sintaksis
<a name="sam-property-function-hooks-syntax"></a>

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

### YAML
<a name="sam-property-function-hooks-syntax.yaml"></a>

```
  [PostTraffic](#sam-function-hooks-posttraffic): String
  [PreTraffic](#sam-function-hooks-pretraffic): String
```

## Sifat-sifat
<a name="sam-property-function-hooks-properties"></a>

 `PostTraffic`   <a name="sam-function-hooks-posttraffic"></a>
Fungsi Lambda yang dijalankan setelah pergeseran lalu lintas.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `PreTraffic`   <a name="sam-function-hooks-pretraffic"></a>
Fungsi Lambda yang dijalankan sebelum pergeseran lalu lintas.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-hooks--examples"></a>

### Hook
<a name="sam-property-function-hooks--examples--hooks"></a>

Contoh fungsi kait

#### YAML
<a name="sam-property-function-hooks--examples--hooks--yaml"></a>

```
Hooks:
  PreTraffic:
    Ref: PreTrafficLambdaFunction
  PostTraffic:
    Ref: PostTrafficLambdaFunction
```

# DurableConfig
<a name="sam-property-function-durableconfig"></a>

Mengkonfigurasi pengaturan eksekusi tahan lama untuk AWS Lambda fungsi. Fungsi yang tahan lama dapat berjalan hingga satu tahun dan secara otomatis memeriksa kemajuan pos, memungkinkan alur kerja yang berjalan lama dan aplikasi yang toleran terhadap kesalahan. Untuk informasi selengkapnya tentang fungsi tahan lama, lihat [Fungsi tahan lama Lambda](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html) di Panduan *AWS Lambda Pengembang*.

## Sintaksis
<a name="sam-property-function-durableconfig-syntax"></a>

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

### YAML
<a name="sam-property-function-durableconfig-syntax.yaml"></a>

```
  [ExecutionTimeout](#sam-function-durableconfig-executiontimeout): Integer
  [RetentionPeriodInDays](#sam-function-durableconfig-retentionperiodindays): Integer
```

## Sifat-sifat
<a name="sam-property-function-durableconfig-properties"></a>

 `ExecutionTimeout`   <a name="sam-function-durableconfig-executiontimeout"></a>
Jumlah waktu (dalam detik) yang memungkinkan Lambda menjalankan fungsi yang tahan lama sebelum menghentikannya. Maksimal satu tahun 366 hari atau 31.622.400 detik.  
*Tipe*: Integer  
*Wajib*: Ya  
*Minimal*: 1  
*Maksimal*: 31622400  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ExecutionTimeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-executiontimeout)` properti tipe `AWS::Lambda::Function` `DurableConfig` data.

 `RetentionPeriodInDays`   <a name="sam-function-durableconfig-retentionperiodindays"></a>
Jumlah hari setelah eksekusi yang tahan lama ditutup sehingga Lambda mempertahankan sejarahnya, dari satu hingga 90 hari. Defaultnya adalah 14 hari.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 14  
*Minimal*: 1  
*Maksimal*: 90  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RetentionPeriodInDays](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-retentionperiodindays)` properti tipe `AWS::Lambda::Function` `DurableConfig` data.

## Contoh
<a name="sam-property-function-durableconfig--examples"></a>

### DurableConfig
<a name="sam-property-function-durableconfig--examples--durableconfig"></a>

Contoh konfigurasi tahan lama untuk fungsi dengan batas waktu eksekusi 1 jam dan periode retensi 7 hari.

#### YAML
<a name="sam-property-function-durableconfig--examples--durableconfig--yaml"></a>

```
DurableConfig:
  ExecutionTimeout: 3600
  RetentionPeriodInDays: 7
```

# EventInvokeConfiguration
<a name="sam-property-function-eventinvokeconfiguration"></a>

Opsi konfigurasi untuk pemanggilan alias atau versi Lambda [tidak sinkron](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html).

## Sintaksis
<a name="sam-property-function-eventinvokeconfiguration-syntax"></a>

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

### YAML
<a name="sam-property-function-eventinvokeconfiguration-syntax.yaml"></a>

```
  [DestinationConfig](#sam-function-eventinvokeconfiguration-destinationconfig): EventInvokeDestinationConfiguration
  [MaximumEventAgeInSeconds](#sam-function-eventinvokeconfiguration-maximumeventageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-eventinvokeconfiguration-maximumretryattempts): Integer
```

## Sifat-sifat
<a name="sam-property-function-eventinvokeconfiguration-properties"></a>

 `DestinationConfig`   <a name="sam-function-eventinvokeconfiguration-destinationconfig"></a>
Objek konfigurasi yang menentukan tujuan dari peristiwa setelah Lambda memprosesnya.  
*Jenis*: [EventInvokeDestinationConfiguration](sam-property-function-eventinvokedestinationconfiguration.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html)` properti `AWS::Lambda::EventInvokeConfig` sumber daya. SAM membutuhkan parameter tambahan, “Type”, yang tidak ada di CloudFormation.

 `MaximumEventAgeInSeconds`   <a name="sam-function-eventinvokeconfiguration-maximumeventageinseconds"></a>
Masa maksimum permintaan yang dikirimkan Lambda ke fungsi untuk diproses.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumEventAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds)` properti `AWS::Lambda::EventInvokeConfig` sumber daya.

 `MaximumRetryAttempts`   <a name="sam-function-eventinvokeconfiguration-maximumretryattempts"></a>
Jumlah waktu maksimum untuk mencoba kembali saat fungsi mengembalikan kesalahan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts)` properti `AWS::Lambda::EventInvokeConfig` sumber daya.

## Contoh
<a name="sam-property-function-eventinvokeconfiguration--examples"></a>

### MaximumEventAgeInSeconds
<a name="sam-property-function-eventinvokeconfiguration--examples--maximumeventageinseconds"></a>

MaximumEventAgeInSeconds contoh

#### YAML
<a name="sam-property-function-eventinvokeconfiguration--examples--maximumeventageinseconds--yaml"></a>

```
EventInvokeConfig:
  MaximumEventAgeInSeconds: 60
  MaximumRetryAttempts: 2
  DestinationConfig:
    OnSuccess:
      Type: SQS
      Destination: arn:aws:sqs:us-west-2:012345678901:my-queue
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn
```

# EventInvokeDestinationConfiguration
<a name="sam-property-function-eventinvokedestinationconfiguration"></a>

Objek konfigurasi yang menentukan tujuan dari peristiwa setelah Lambda memprosesnya.

## Sintaksis
<a name="sam-property-function-eventinvokedestinationconfiguration-syntax"></a>

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

### YAML
<a name="sam-property-function-eventinvokedestinationconfiguration-syntax.yaml"></a>

```
  [OnFailure](#sam-function-eventinvokedestinationconfiguration-onfailure): OnFailure
  [OnSuccess](#sam-function-eventinvokedestinationconfiguration-onsuccess): OnSuccess
```

## Sifat-sifat
<a name="sam-property-function-eventinvokedestinationconfiguration-properties"></a>

 `OnFailure`   <a name="sam-function-eventinvokedestinationconfiguration-onfailure"></a>
Tujuan untuk peristiwa yang gagal diproses.  
*Jenis*: [OnFailure](sam-property-function-onfailure.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[OnFailure](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html)` properti `AWS::Lambda::EventInvokeConfig` sumber daya. Membutuhkan `Type`, properti hanya-SAM tambahan.

 `OnSuccess`   <a name="sam-function-eventinvokedestinationconfiguration-onsuccess"></a>
Tujuan untuk peristiwa yang berhasil diproses.  
*Jenis*: [OnSuccess](sam-property-function-onsuccess.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[OnSuccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess)` properti `AWS::Lambda::EventInvokeConfig` sumber daya. Membutuhkan `Type`, properti hanya-SAM tambahan.

## Contoh
<a name="sam-property-function-eventinvokedestinationconfiguration--examples"></a>

### OnSuccess
<a name="sam-property-function-eventinvokedestinationconfiguration--examples--onsuccess"></a>

OnSuccess contoh

#### YAML
<a name="sam-property-function-eventinvokedestinationconfiguration--examples--onsuccess--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
      Destination: arn:aws:sqs:us-west-2:012345678901:my-queue
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn
```

# OnFailure
<a name="sam-property-function-onfailure"></a>

Tujuan untuk peristiwa yang gagal diproses.

## Sintaksis
<a name="sam-property-function-onfailure-syntax"></a>

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

### YAML
<a name="sam-property-function-onfailure-syntax.yaml"></a>

```
  [Destination](#sam-function-onfailure-destination): String
  [Type](#sam-function-onfailure-type): String
```

## Sifat-sifat
<a name="sam-property-function-onfailure-properties"></a>

 `Destination`   <a name="sam-function-onfailure-destination"></a>
Amazon Resource Name (ARN) dari sumber daya tujuan.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[OnFailure](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html)` properti `AWS::Lambda::EventInvokeConfig` sumber daya. SAM akan menambahkan izin yang diperlukan untuk membuat IAM role yang dibuat secara otomatis terkait dengan fungsi ini untuk mengakses sumber daya yang dirujuk dalam properti ini.  
*Catatan tambahan*: Jika jenisnya adalah Lambda/EventBridge, Tujuan diperlukan.

 `Type`   <a name="sam-function-onfailure-type"></a>
Tipe sumber daya yang dirujuk di tujuan. Jenis yang didukung adalah`SQS`,`SNS`,`S3`,`Lambda`, dan`EventBridge`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: Jika jenisnya SQS/SNS dan `Destination` properti dibiarkan kosong, maka SQS/SNS sumber daya dihasilkan secara otomatis oleh SAM. Untuk referensi sumber daya, gunakan `<function-logical-id>.DestinationQueue` untuk SQS atau `<function-logical-id>.DestinationTopic` untuk SNS. Jika jenisnya adalah Lambda/EventBridge, `Destination` diperlukan.

## Contoh
<a name="sam-property-function-onfailure--examples"></a>

### EventInvoke Contoh Konfigurasi dengan tujuan SQS dan Lambda
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations"></a>

Dalam contoh ini tidak ada Tujuan yang diberikan untuk OnSuccess konfigurasi SQS, sehingga SAM secara implisit membuat antrian SQS dan menambahkan izin yang diperlukan. Juga untuk contoh ini, Tujuan untuk sumber daya Lambda yang dideklarasikan dalam file template ditentukan dalam OnFailure konfigurasi, jadi SAM menambahkan izin yang diperlukan ke fungsi Lambda ini untuk memanggil fungsi Lambda tujuan.

#### YAML
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn  # Arn of a Lambda function declared in the template file.
```

### EventInvoke Contoh Konfigurasi dengan tujuan SNS
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sns-destination"></a>

Dalam contoh ini Tujuan diberikan untuk topik SNS yang dideklarasikan dalam file template untuk OnSuccess konfigurasi.

#### YAML
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sns-destination--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SNS
      Destination:
        Ref: DestinationSNS       # Arn of an SNS topic declared in the tempate file
```

# OnSuccess
<a name="sam-property-function-onsuccess"></a>

Tujuan untuk peristiwa yang berhasil diproses.

## Sintaksis
<a name="sam-property-function-onsuccess-syntax"></a>

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

### YAML
<a name="sam-property-function-onsuccess-syntax.yaml"></a>

```
  [Destination](#sam-function-onsuccess-destination): String
  [Type](#sam-function-onsuccess-type): String
```

## Sifat-sifat
<a name="sam-property-function-onsuccess-properties"></a>

 `Destination`   <a name="sam-function-onsuccess-destination"></a>
Amazon Resource Name (ARN) dari sumber daya tujuan.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[OnSuccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess)` properti `AWS::Lambda::EventInvokeConfig` sumber daya. SAM akan menambahkan izin yang diperlukan untuk membuat IAM role yang dibuat secara otomatis terkait dengan fungsi ini untuk mengakses sumber daya yang dirujuk dalam properti ini.  
*Catatan tambahan*: Jika jenisnya adalah Lambda/EventBridge, Tujuan diperlukan.

 `Type`   <a name="sam-function-onsuccess-type"></a>
Tipe sumber daya yang dirujuk di tujuan. Jenis yang didukung adalah`SQS`,`SNS`,`S3`,`Lambda`, dan`EventBridge`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: Jika jenisnya SQS/SNS dan `Destination` properti dibiarkan kosong, maka SQS/SNS sumber daya dihasilkan secara otomatis oleh SAM. Untuk referensi sumber daya, gunakan `<function-logical-id>.DestinationQueue` untuk SQS atau `<function-logical-id>.DestinationTopic` untuk SNS. Jika jenisnya adalah Lambda/EventBridge, `Destination` diperlukan.

## Contoh
<a name="sam-property-function-onsuccess--examples"></a>

### EventInvoke Contoh Konfigurasi dengan tujuan SQS dan Lambda
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations"></a>

Dalam contoh ini tidak ada Tujuan yang diberikan untuk OnSuccess konfigurasi SQS, sehingga SAM secara implisit membuat antrian SQS dan menambahkan izin yang diperlukan. Juga untuk contoh ini, Tujuan untuk sumber daya Lambda yang dideklarasikan dalam file template ditentukan dalam OnFailure konfigurasi, jadi SAM menambahkan izin yang diperlukan ke fungsi Lambda ini untuk memanggil fungsi Lambda tujuan.

#### YAML
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn  # Arn of a Lambda function declared in the template file.
```

### EventInvoke Contoh Konfigurasi dengan tujuan SNS
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sns-destination"></a>

Dalam contoh ini Tujuan diberikan untuk topik SNS yang dideklarasikan dalam file template untuk OnSuccess konfigurasi.

#### YAML
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sns-destination--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SNS
      Destination:
        Ref: DestinationSNS       # Arn of an SNS topic declared in the tempate file
```

# EventSource
<a name="sam-property-function-eventsource"></a>

Objek yang menggambarkan sumber peristiwa yang memicu fungsi. 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 topik yang sesuai dengan tipe tersebut.

## Sintaksis
<a name="sam-property-function-eventsource-syntax"></a>

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

### YAML
<a name="sam-property-function-eventsource-syntax.yaml"></a>

```
  [Properties](#sam-function-eventsource-properties): AlexaSkill | Api | CloudWatchEvent | CloudWatchLogs | Cognito | DocumentDB | DynamoDB | EventBridgeRule | HttpApi | IoTRule | Kinesis | MQ | MSK | S3 | Schedule | ScheduleV2 | SelfManagedKafka | SNS | SQS
  [Type](#sam-function-eventsource-type): String
```

## Sifat-sifat
<a name="sam-property-function-eventsource-properties"></a>

 `Properties`   <a name="sam-function-eventsource-properties"></a>
Objek menggambarkan sifat pemetaan peristiwa ini. Set properti harus sesuai dengan tipe yang ditentukan.  
*Jenis* [[[[[[: [AlexaSkill](sam-property-function-alexaskill.md)\$1 [Api](sam-property-function-api.md) \$1 \$1 \$1 [Cognito [CloudWatchEvent[CloudWatchLogs](sam-property-function-cloudwatchlogs.md)](sam-property-function-cloudwatchevent.md)](sam-property-function-cognito.md)\$1 DocumentDB \$1 DynamoDB [\$1 \$1 \$1 [EventBridgeRule](sam-property-function-eventbridgerule.md)](sam-property-function-documentdb.md)Io \$1 [TRuleKinesis \$1 [MQ](sam-property-function-mq.md) \$1 MSK [\$1](sam-property-function-dynamodb.md) S3 [HttpApi](sam-property-function-httpapi.md)\$1 Jadwal \$1 Schedulev2](sam-property-function-iotrule.md)[\$1 \$1](sam-property-function-kinesis.md) SNS \$1 SQS [SelfManagedKafka](sam-property-function-selfmanagedkafka.md)](sam-property-function-sqs.md)](sam-property-function-sns.md)](sam-property-function-schedulev2.md)](sam-property-function-schedule.md)](sam-property-function-s3.md)](sam-property-function-msk.md)  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Type`   <a name="sam-function-eventsource-type"></a>
Jenis peristiwa.  
*Nilai yang valid*: `AlexaSkill``Api`,`CloudWatchEvent`,`CloudWatchLogs`,`Cognito`,`DocumentDB`,`DynamoDB`,,`EventBridgeRule`,`HttpApi`,`IoTRule`,`Kinesis`,`MQ`,`MSK`,`S3`,`Schedule`,`ScheduleV2`,`SelfManagedKafka`,`SNS`, `SQS`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-eventsource--examples"></a>

### APIEvent
<a name="sam-property-function-eventsource--examples--apievent"></a>

Contoh menggunakan peristiwa API

#### YAML
<a name="sam-property-function-eventsource--examples--apievent--yaml"></a>

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

# AlexaSkill
<a name="sam-property-function-alexaskill"></a>

Objek yang menggambarkan tipe sumber peristiwa `AlexaSkill`.

## Sintaksis
<a name="sam-property-function-alexaskill-syntax"></a>

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

### YAML
<a name="sam-property-function-alexaskill-syntax.yaml"></a>

```
  [SkillId](#sam-function-alexaskill-skillid): String
```

## Sifat-sifat
<a name="sam-property-function-alexaskill-properties"></a>

 `SkillId`   <a name="sam-function-alexaskill-skillid"></a>
ID Keterampilan Alexa untuk Keterampilan Alexa Anda. Untuk informasi selengkapnya tentang ID Keterampilan lihat [Konfigurasikan pemicu untuk fungsi Lambda](https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-an-aws-lambda-function.html#configuring-the-alexa-skills-kit-trigger) dalam dokumentasi Kit Keterampilan Alexa.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-alexaskill--examples"></a>

### AlexaSkillTrigger
<a name="sam-property-function-alexaskill--examples--alexaskilltrigger"></a>

Contoh Peristiwa Keterampilan Alexa

#### YAML
<a name="sam-property-function-alexaskill--examples--alexaskilltrigger--yaml"></a>

```
AlexaSkillEvent:
  Type: AlexaSkill
```

# Api
<a name="sam-property-function-api"></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.

Jika [AWS::Serverless::Api](sam-resource-api.md) tidak ditentukan, input dan output fungsi adalah representasi dari permintaan HTTP dan respons HTTP.

Misalnya, menggunakan JavaScript API, kode status dan isi respons dapat dikontrol dengan mengembalikan objek dengan kunci StatusCode dan body.

## Sintaksis
<a name="sam-property-function-api-syntax"></a>

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

### YAML
<a name="sam-property-function-api-syntax.yaml"></a>

```
  [Auth](#sam-function-api-auth): ApiFunctionAuth
  [Method](#sam-function-api-method): String
  [Path](#sam-function-api-path): String
  [RequestModel](#sam-function-api-requestmodel): RequestModel
  [RequestParameters](#sam-function-api-requestparameters): List of [ String | RequestParameter ]
  [RestApiId](#sam-function-api-restapiid): String
  [ResponseTransferMode](#sam-function-api-responsetransfermode): String
  TimeoutInMillis: Integer
```

## Sifat-sifat
<a name="sam-property-function-api-properties"></a>

 `Auth`   <a name="sam-function-api-auth"></a>
Konfigurasi auth untuk Api\$1Path\$1Metode tertentu ini.  
Berguna untuk membatalkan config auth pengaturan `DefaultAuthorizer` API pada jalur individu ketika `DefaultAuthorizer` tidak ditentukan atau membatalkan pengaturan `ApiKeyRequired` default.  
*Jenis*: [ApiFunctionAuth](sam-property-function-apifunctionauth.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Method`   <a name="sam-function-api-method"></a>
Metode HTTP yang membuat fungsi ini dipanggil. Pilihan termasuk`DELETE`,`GET`,`HEAD`,`OPTIONS`,`PATCH`,`POST`,`PUT`, dan`ANY`. Lihat [Mengatur metode HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html#setup-method-add-http-method) di *Panduan Pengembang API Gateway* untuk detailnya.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

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

 `RequestModel`   <a name="sam-function-api-requestmodel"></a>
Permintaan model yang akan digunakan untuk Api\$1Path\$1Metode tertentu ini. Ini harus merujuk nama model yang ditentukan dalam bagian `Models` dari sumber daya [AWS::Serverless::Api](sam-resource-api.md).  
*Jenis*: [RequestModel](sam-property-function-requestmodel.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RequestParameters`   <a name="sam-function-api-requestparameters"></a>
Konfigurasi parameter permintaan untuk Api\$1Path\$1Metode tertentu ini. Semua nama parameter harus dimulai dengan `method.request` dan harus terbatas pada `method.request.header`, `method.request.querystring`, atau `method.request.path`.  
Daftar dapat berisi string nama parameter dan [RequestParameter](sam-property-function-requestparameter.md)objek. Untuk string, `Caching` properti `Required` and akan default ke`false`.  
*Jenis*: Daftar [String \$1 [RequestParameter](sam-property-function-requestparameter.md)]  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RestApiId`   <a name="sam-function-api-restapiid"></a>
Pengidentifikasi RestApi sumber daya, 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`.  
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.

`ResponseTransferMode`  <a name="sam-function-api-responsetransfermode"></a>
Mode transfer respons untuk integrasi fungsi Lambda. Setel `RESPONSE_STREAM` untuk mengaktifkan streaming respons Lambda melalui API Gateway, memungkinkan fungsi untuk mengalirkan respons kembali ke klien. Saat disetel ke`RESPONSE_STREAM`, API Gateway menggunakan API Lambda InvokeWithResponseStreaming .  
*Tipe*: String  
*Wajib*: Tidak  
*Nilai yang valid*: `BUFFERED` \$1 `RESPONSE_STREAM`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode)properti`AWS::ApiGateway::Method Integration`.

`TimeoutInMillis`  <a name="sam-function-api-timeoutinmillis"></a>
Waktu habis khusus antara 50 dan 29.000 milidetik.  
Saat Anda menentukan properti ini, AWS SAM memodifikasi definisi OpenAPI Anda. Definisi OpenAPI harus ditentukan sebaris menggunakan properti. `DefinitionBody` 
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 29.000 milidetik atau 29 detik  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-api--examples"></a>

### Contoh basic
<a name="sam-property-function-api--examples--apievent"></a>

#### YAML
<a name="sam-property-function-api--examples--apievent--yaml"></a>

```
Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
      RequestParameters:
        - method.request.header.Authorization
        - method.request.querystring.keyword:
            Required: true
            Caching: false
```

# ApiFunctionAuth
<a name="sam-property-function-apifunctionauth"></a>

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

## Sintaksis
<a name="sam-property-function-apifunctionauth-syntax"></a>

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

### YAML
<a name="sam-property-function-apifunctionauth-syntax.yaml"></a>

```
  [ApiKeyRequired](#sam-function-apifunctionauth-apikeyrequired): Boolean
  [AuthorizationScopes](#sam-function-apifunctionauth-authorizationscopes): List
  [Authorizer](#sam-function-apifunctionauth-authorizer): String
  [InvokeRole](#sam-function-apifunctionauth-invokerole): String
  OverrideApiAuth: Boolean
  [ResourcePolicy](#sam-function-apifunctionauth-resourcepolicy): ResourcePolicyStatement
```

## Sifat-sifat
<a name="sam-property-function-apifunctionauth-properties"></a>

 `ApiKeyRequired`   <a name="sam-function-apifunctionauth-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-function-apifunctionauth-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-function-apifunctionauth-authorizer"></a>
`Authorizer`Untuk fungsi tertentu.  
Jika Anda memiliki otorisasi global yang ditentukan untuk `AWS::Serverless::Api` sumber daya Anda, Anda dapat mengganti otorisasi dengan menyetelnya. `Authorizer` `NONE` Sebagai contoh, lihat [Ganti otorisasi global untuk REST API Amazon API Gateway](#sam-property-function-apifunctionauth--examples--override).  
Jika Anda menggunakan `DefinitionBody` properti `AWS::Serverless::Api` sumber daya untuk mendeskripsikan API Anda, Anda harus menggunakan `OverrideApiAuth` with `Authorizer` untuk mengganti otorisasi global Anda. Untuk informasi selengkapnya, lihat `OverrideApiAuth`.
*Nilai valid*:`AWS_IAM`,`NONE`, atau ID logis untuk otorisasi apa pun yang ditentukan dalam AWS SAM template Anda.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `InvokeRole`   <a name="sam-function-apifunctionauth-invokerole"></a>
Menentukan `InvokeRole` untuk digunakan untuk otorisasi `AWS_IAM`.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `CALLER_CREDENTIALS`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.  
*Catatan tambahan*: `CALLER_CREDENTIALS` memetakan ke `arn:aws:iam:::<user>/`, yang menggunakan kredensial pemanggil untuk memanggil titik akhir.

`OverrideApiAuth`  <a name="sam-function-apifunctionauth-overrideapiauth"></a>
Tentukan `true` untuk mengganti konfigurasi otorisasi global sumber daya Anda`AWS::Serverless::Api`. Properti ini hanya diperlukan jika Anda menentukan otorisasi global dan menggunakan `DefinitionBody` properti `AWS::Serverless::Api` sumber daya untuk mendeskripsikan API Anda.  
Saat Anda menentukan `OverrideApiAuth` sebagai`true`, AWS SAM akan mengganti otorisasi global Anda dengan nilai apa pun yang disediakan untuk`ApiKeyRequired`,`Authorizer`, atau. `ResourcePolicy` Oleh karena itu, setidaknya satu dari properti ini juga harus ditentukan saat menggunakan`OverrideApiAuth`. Sebagai contoh, lihat [Ganti otorisasi global saat DefinitionBody for ditentukan AWS::Serverless::Api](#sam-property-function-apifunctionauth--examples--override2).
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ResourcePolicy`   <a name="sam-function-apifunctionauth-resourcepolicy"></a>
Mengonfigurasi Kebijakan Sumber Daya untuk jalur ini pada API.  
*Jenis*: [ResourcePolicyStatement](sam-property-function-resourcepolicystatement.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-apifunctionauth--examples"></a>

### Function-Auth
<a name="sam-property-function-apifunctionauth--examples--function-auth"></a>

Contoh berikut menentukan otorisasi pada tingkat fungsi.

#### YAML
<a name="sam-property-function-apifunctionauth--examples--function-auth--yaml"></a>

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

### Ganti otorisasi global untuk REST API Amazon API Gateway
<a name="sam-property-function-apifunctionauth--examples--override"></a>

Anda dapat menentukan otorisasi global untuk `AWS::Serverless::Api` sumber daya Anda. Berikut ini adalah contoh yang mengkonfigurasi otorisasi default global:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
```

Untuk mengganti authorizer default untuk AWS Lambda fungsi Anda, Anda dapat menentukan `Authorizer` sebagai. `NONE` Berikut ini adalah contohnya:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  ...
  MyFn:
    Type: AWS::Serverless::Function
    Properties:
      ...
      Events:
        LambdaRequest:
          Type: Api
          Properties:
            RestApiId: !Ref MyApiWithLambdaRequestAuth
            Method: GET
            Auth:
              Authorizer: NONE
```

### Ganti otorisasi global saat DefinitionBody for ditentukan AWS::Serverless::Api
<a name="sam-property-function-apifunctionauth--examples--override2"></a>

Saat menggunakan `DefinitionBody` properti untuk mendeskripsikan `AWS::Serverless::Api` sumber daya Anda, metode penggantian sebelumnya tidak berfungsi. Berikut ini adalah contoh penggunaan `DefinitionBody` properti untuk sumber `AWS::Serverless::Api` daya:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      DefinitionBody:
        swagger: 2.0
        ...
        paths:
          /lambda-request:
            ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
```

Untuk mengganti otorisasi global, gunakan properti. `OverrideApiAuth` Berikut ini adalah contoh yang digunakan `OverrideApiAuth` untuk mengganti otorisasi global dengan nilai yang disediakan untuk: `Authorizer`

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      DefinitionBody:
        swagger: 2-0
        ...
        paths:
          /lambda-request:
            ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
    
    MyAuthFn:
      Type: AWS::Serverless::Function
      ...
    
    MyFn:
      Type: AWS::Serverless::Function
        Properties:
          ...
          Events:
            LambdaRequest:
              Type: Api
              Properties:
                RestApiId: !Ref MyApiWithLambdaRequestAuth
                Method: GET
                Auth:
                  Authorizer: NONE
                  OverrideApiAuth: true
                Path: /lambda-token
```

# ResourcePolicyStatement
<a name="sam-property-function-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-function-resourcepolicystatement-syntax"></a>

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

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

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

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

 `AwsAccountBlacklist`   <a name="sam-function-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-function-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-function-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-function-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-function-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-function-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-function-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-function-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-function-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-function-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-function-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-function-resourcepolicystatement--examples"></a>

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

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

#### YAML
<a name="sam-property-function-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
```

# RequestModel
<a name="sam-property-function-requestmodel"></a>

Mengkonfigurasi Model Permintaan untuk Metode Api\$1Path\$1tertentu.

## Sintaksis
<a name="sam-property-function-requestmodel-syntax"></a>

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

### YAML
<a name="sam-property-function-requestmodel-syntax.yaml"></a>

```
  [Model](#sam-function-requestmodel-model): String
  [Required](#sam-function-requestmodel-required): Boolean
  [ValidateBody](#sam-function-requestmodel-validatebody): Boolean
  [ValidateParameters](#sam-function-requestmodel-validateparameters): Boolean
```

## Sifat-sifat
<a name="sam-property-function-requestmodel-properties"></a>

 `Model`   <a name="sam-function-requestmodel-model"></a>
Nama model yang ditentukan dalam properti Model dari [AWS::Serverless::Api](sam-resource-api.md).  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Required`   <a name="sam-function-requestmodel-required"></a>
Menambahkan `required` properti di bagian parameter OpenApi definisi untuk titik akhir API yang diberikan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ValidateBody`   <a name="sam-function-requestmodel-validatebody"></a>
Menentukan apakah API Gateway menggunakan `Model` untuk memvalidasi badan permintaan. Untuk informasi selengkapnya, lihat [Mengaktifkan validasi permintaan di API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) di *Panduan Pengembang API Gateway*.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `ValidateParameters`   <a name="sam-function-requestmodel-validateparameters"></a>
Menentukan apakah API Gateway menggunakan `Model` untuk memvalidasi parameter jalur permintaan, string kueri, dan header. Untuk informasi selengkapnya, lihat [Mengaktifkan validasi permintaan di API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) di *Panduan Pengembang API Gateway*.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-requestmodel--examples"></a>

### Model Permintaan
<a name="sam-property-function-requestmodel--examples--request-model"></a>

Contoh Permintaan Model

#### YAML
<a name="sam-property-function-requestmodel--examples--request-model--yaml"></a>

```
RequestModel:
  Model: User
  Required: true
  ValidateBody: true
  ValidateParameters: true
```

# RequestParameter
<a name="sam-property-function-requestparameter"></a>

Mengonfigurasi Parameter Permintaan untuk Api\$1Path\$1Metode tertentu.

Properti `Required` atau `Caching` perlu ditentukan untuk parameter permintaan

## Sintaksis
<a name="sam-property-function-requestparameter-syntax"></a>

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

### YAML
<a name="sam-property-function-requestparameter-syntax.yaml"></a>

```
  [Caching](#sam-function-requestparameter-caching): Boolean
  [Required](#sam-function-requestparameter-required): Boolean
```

## Sifat-sifat
<a name="sam-property-function-requestparameter-properties"></a>

 `Caching`   <a name="sam-function-requestparameter-caching"></a>
Menambahkan `cacheKeyParameters` bagian ke OpenApi definisi API Gateway  
*Tipe*: Boolean  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Required`   <a name="sam-function-requestparameter-required"></a>
Bidang ini menentukan apakah parameter diperlukan  
*Tipe*: Boolean  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-requestparameter--examples"></a>

### Parameter permintaan
<a name="sam-property-function-requestparameter--examples--request-parameter"></a>

Contoh Parameter Permintaan pengaturan

#### YAML
<a name="sam-property-function-requestparameter--examples--request-parameter--yaml"></a>

```
RequestParameters:
  - method.request.header.Authorization:
      Required: true
      Caching: true
```

# CloudWatchEvent
<a name="sam-property-function-cloudwatchevent"></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-function-eventbridgerule.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-function-cloudwatchevent-syntax"></a>

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

### YAML
<a name="sam-property-function-cloudwatchevent-syntax.yaml"></a>

```
  [Enabled](#sam-function-cloudwatchevent-enabled): Boolean
  [EventBusName](#sam-function-cloudwatchevent-eventbusname): String
  [Input](#sam-function-cloudwatchevent-input): String
  [InputPath](#sam-function-cloudwatchevent-inputpath): String
  [Pattern](#sam-function-cloudwatchevent-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  [State](#sam-function-cloudwatchevent-state): String
```

## Sifat-sifat
<a name="sam-property-function-cloudwatchevent-properties"></a>

 `Enabled`   <a name="sam-function-cloudwatchevent-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`.

 `EventBusName`   <a name="sam-function-cloudwatchevent-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-function-cloudwatchevent-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-function-cloudwatchevent-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-function-cloudwatchevent-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.

 `State`   <a name="sam-function-cloudwatchevent-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.

## Contoh
<a name="sam-property-function-cloudwatchevent--examples"></a>

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

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

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

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

# CloudWatchLogs
<a name="sam-property-function-cloudwatchlogs"></a>

Objek yang menggambarkan tipe sumber peristiwa `CloudWatchLogs`.

Acara ini menghasilkan [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html)sumber daya dan menentukan filter langganan dan mengaitkannya dengan grup log yang ditentukan.

## Sintaksis
<a name="sam-property-function-cloudwatchlogs-syntax"></a>

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

### YAML
<a name="sam-property-function-cloudwatchlogs-syntax.yaml"></a>

```
  [FilterPattern](#sam-function-cloudwatchlogs-filterpattern): String
  [LogGroupName](#sam-function-cloudwatchlogs-loggroupname): String
```

## Sifat-sifat
<a name="sam-property-function-cloudwatchlogs-properties"></a>

 `FilterPattern`   <a name="sam-function-cloudwatchlogs-filterpattern"></a>
Ekspresi pemfilteran yang membatasi apa yang dikirim ke sumber daya tujuan AWS . Untuk informasi selengkapnya tentang sintaks pola filter, lihat [Sintaks Filter dan Pola](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)..  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-filterpattern)` properti `AWS::Logs::SubscriptionFilter` sumber daya.

 `LogGroupName`   <a name="sam-function-cloudwatchlogs-loggroupname"></a>
Grup log yang dikaitkan dengan filter langganan. Semua peristiwa log yang diunggah ke grup log ini difilter dan dikirim ke AWS sumber daya yang ditentukan jika pola filter cocok dengan peristiwa log.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LogGroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-loggroupname)` properti `AWS::Logs::SubscriptionFilter` sumber daya.

## Contoh
<a name="sam-property-function-cloudwatchlogs--examples"></a>

### Filter Langganan Cloudwatchlogs
<a name="sam-property-function-cloudwatchlogs--examples--cloudwatchlogs-subscription-filter"></a>

Contoh filter Langganan Cloudwatchlogs

#### YAML
<a name="sam-property-function-cloudwatchlogs--examples--cloudwatchlogs-subscription-filter--yaml"></a>

```
CWLog:
  Type: CloudWatchLogs
  Properties:
    LogGroupName:
      Ref: CloudWatchLambdaLogsGroup
    FilterPattern: My pattern
```

# Cognito
<a name="sam-property-function-cognito"></a>

Objek yang menggambarkan tipe sumber peristiwa `Cognito`.

## Sintaksis
<a name="sam-property-function-cognito-syntax"></a>

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

### YAML
<a name="sam-property-function-cognito-syntax.yaml"></a>

```
  [Trigger](#sam-function-cognito-trigger): List
  [UserPool](#sam-function-cognito-userpool): String
```

## Sifat-sifat
<a name="sam-property-function-cognito-properties"></a>

 `Trigger`   <a name="sam-function-cognito-trigger"></a>
Lambda memicu informasi konfigurasi untuk kolam pengguna baru.  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LambdaConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html)` properti `AWS::Cognito::UserPool` sumber daya.

 `UserPool`   <a name="sam-function-cognito-userpool"></a>
Referensi untuk UserPool didefinisikan dalam template yang sama  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-cognito--examples"></a>

### Peristiwa Cognito
<a name="sam-property-function-cognito--examples--cognito-event"></a>

Contoh Cognito

#### YAML
<a name="sam-property-function-cognito--examples--cognito-event--yaml"></a>

```
CognitoUserPoolPreSignup:
  Type: Cognito
  Properties:
    UserPool:
      Ref: MyCognitoUserPool
    Trigger: PreSignUp
```

# DocumentDB
<a name="sam-property-function-documentdb"></a>

Objek yang menggambarkan tipe sumber peristiwa `DocumentDB`. *Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda Amazon DocumentDB](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) di AWS Lambda Panduan Pengembang.*

## Sintaksis
<a name="sam-property-function-documentdb-syntax"></a>

Untuk mendeklarasikan entitas ini di AWS SAM template Anda, gunakan sintaks berikut.

### YAML
<a name="sam-property-function-documentdb-syntax-yaml"></a>

```
BatchSize: Integer
Cluster: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
CollectionName: String
DatabaseName: String
Enabled: Boolean
FilterCriteria: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
FullDocument: String
KmsKeyArn: String  
MaximumBatchingWindowInSeconds: Integer
SecretsManagerKmsKeyId: String
SourceAccessConfigurations: List
StartingPosition: String
StartingPositionTimestamp: Double
```

## Sifat-sifat
<a name="sam-property-function-documentdb-properties"></a>

 `BatchSize`   <a name="sam-function-documentdb-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Cluster`   <a name="sam-function-documentdb-cluster"></a>
Nama Sumber Daya Amazon (ARN) dari cluster Amazon DocumentDB.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `CollectionName`   <a name="sam-function-documentdb-collectionname"></a>
Nama koleksi untuk dikonsumsi dalam database. Jika Anda tidak menentukan koleksi, Lambda mengkonsumsi semua koleksi.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ CollectionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname)` properti tipe `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` data.

 `DatabaseName`   <a name="sam-function-documentdb-databasename"></a>
Nama database untuk dikonsumsi dalam cluster Amazon DocumentDB.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ DatabaseName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename)` properti tipe `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` data.

 `Enabled`   <a name="sam-function-documentdb-enabled"></a>
Jika`true`, pemetaan sumber peristiwa aktif. Untuk menjeda polling dan pemanggilan, atur ke `false`.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-documentdb-filtercriteria"></a>
Objek yang mendefinisikan kriteria yang menentukan apakah Lambda harus memproses suatu peristiwa. *Untuk informasi selengkapnya, lihat [Pemfilteran acara Lambda di Panduan](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) Pengembang.AWS Lambda *  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FullDocument`   <a name="sam-function-documentdb-fulldocument"></a>
Menentukan apa yang Amazon DocumentDB kirimkan ke aliran acara Anda selama operasi pembaruan dokumen. Jika disetel ke`UpdateLookup`, Amazon DocumentDB mengirimkan delta yang menjelaskan perubahan, bersama dengan salinan seluruh dokumen. Jika tidak, Amazon DocumentDB hanya mengirimkan sebagian dokumen yang berisi perubahan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ FullDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument)` properti tipe `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` data.

 `KmsKeyArn`   <a name="sam-function-documentdb-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-documentdb-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan rekaman sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `SecretsManagerKmsKeyId`   <a name="sam-function-documentdb-secretsmanagerkmskeyid"></a>
ID kunci AWS Key Management Service (AWS KMS) kunci kunci yang dikelola pelanggan dari AWS Secrets Manager. Diperlukan saat Anda menggunakan kunci terkelola pelanggan dari Secrets Manager dengan peran eksekusi Lambda yang tidak menyertakan izin. `kms:Decrypt`  
Nilai properti ini adalah UUID. Sebagai contoh: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceAccessConfigurations`   <a name="sam-function-documentdb-sourceaccessconfigurations"></a>
Array protokol otentikasi atau host virtual. Tentukan ini menggunakan tipe [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)data.  
Untuk tipe sumber `DocumentDB` acara, satu-satunya jenis konfigurasi yang valid adalah`BASIC_AUTH`.  
+ `BASIC_AUTH`Rahasia Secrets Manager yang menyimpan kredensi broker Anda. Untuk tipe ini, kredensialnya harus dalam format berikut: `{"username": "your-username", "password": "your-password"}`. Hanya satu objek dari tipe `BASIC_AUTH` diizinkan.
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPosition`   <a name="sam-function-documentdb-startingposition"></a>
Posisi dalam pengaliran tempat untuk mulai membaca.  
+ `AT_TIMESTAMP`— Tentukan waktu untuk mulai membaca catatan.
+ `LATEST`— Baca hanya catatan baru.
+ `TRIM_HORIZON`— Memproses semua catatan yang tersedia.
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPositionTimestamp`   <a name="sam-function-documentdb-startingpositiontimestamp"></a>
Waktu untuk mulai membaca, dalam detik waktu Unix. Tentukan `StartingPositionTimestamp` kapan `StartingPosition` ditentukan sebagai`AT_TIMESTAMP`.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-documentdb-examples"></a>

### Sumber acara Amazon DocumentDB
<a name="sam-property-function-documentdb-examples-example1"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
    ...
      Events:
        MyDDBEvent:
          Type: DocumentDB
          Properties:
            Cluster: "arn:aws:rds:us-west-2:123456789012:cluster:docdb-2023-01-01"
            BatchSize: 10
            MaximumBatchingWindowInSeconds: 5
            DatabaseName: "db1"
            CollectionName: "collection1"
            FullDocument: "UpdateLookup"
            SourceAccessConfigurations:
              - Type: BASIC_AUTH
                URI: "arn:aws:secretsmanager:us-west-2:123456789012:secret:doc-db"
```

# DynamoDB
<a name="sam-property-function-dynamodb"></a>

Objek yang menggambarkan tipe sumber peristiwa `DynamoDB`. *Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda Amazon DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html) di AWS Lambda Panduan Pengembang.*

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

## Sintaksis
<a name="sam-property-function-dynamodb-syntax"></a>

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

### YAML
<a name="sam-property-function-dynamodb-syntax.yaml"></a>

```
  [BatchSize](#sam-function-dynamodb-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-dynamodb-bisectbatchonfunctionerror): Boolean
  [DestinationConfig](#sam-function-dynamodb-destinationconfig): [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)
  [Enabled](#sam-function-dynamodb-enabled): Boolean
  [FilterCriteria](#sam-function-dynamodb-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-dynamodb-functionresponsetypes): List
  KmsKeyArn: String          
  [MaximumBatchingWindowInSeconds](#sam-function-dynamodb-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-dynamodb-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-dynamodb-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-dynamodb-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ParallelizationFactor](#sam-function-dynamodb-parallelizationfactor): Integer
  [StartingPosition](#sam-function-dynamodb-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-dynamodb-stream): String
  [TumblingWindowInSeconds](#sam-function-dynamodb-tumblingwindowinseconds): Integer
```

## Sifat-sifat
<a name="sam-property-function-dynamodb-properties"></a>

 `BatchSize`   <a name="sam-function-dynamodb-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 100  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.  
*Minimal*: `1`  
*Maksimum*: `1000`

 `BisectBatchOnFunctionError`   <a name="sam-function-dynamodb-bisectbatchonfunctionerror"></a>
Jika fungsi mengembalikan kesalahan, bagi batch menjadi dua dan coba lagi.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `DestinationConfig`   <a name="sam-function-dynamodb-destinationconfig"></a>
Antrean Amazon Simple Queue Service (Amazon SQS) atau tujuan topik Amazon Simple Notification Service (Amazon SNS) untuk catatan yang dibuang.  
*Jenis*: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Enabled`   <a name="sam-function-dynamodb-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-dynamodb-filtercriteria"></a>
Objek yang mendefinisikan kriteria untuk menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FunctionResponseTypes`   <a name="sam-function-dynamodb-functionresponsetypes"></a>
Daftar tipe jawaban saat ini yang diterapkan ke pemetaan sumber peristiwa. Untuk informasi selengkapnya, lihat [Melaporkan kegagalan item batch](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting) di *Panduan Developer AWS Lambda *.  
*Nilai yang valid*: `ReportBatchItemFailures`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KmsKeyArn`   <a name="sam-function-dynamodb-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-dynamodb-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan rekaman sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-dynamodb-maximumrecordageinseconds"></a>
Periode permintaan maksimum yang dikirimkan Lambda ke fungsi untuk diproses.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRetryAttempts`   <a name="sam-function-dynamodb-maximumretryattempts"></a>
Jumlah waktu maksimum untuk mencoba kembali saat fungsi mengembalikan kesalahan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MetricsConfig`   <a name="sam-function-dynamodb-metricsconfig"></a>
Konfigurasi keikutsertaan untuk mendapatkan metrik yang disempurnakan untuk pemetaan sumber peristiwa yang menangkap setiap tahap pemrosesan. Sebagai contoh, lihat [MetricsConfig acara](#sam-property-function-dynamodb-example-metricsconfigevent).  
*Jenis*: [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ParallelizationFactor`   <a name="sam-function-dynamodb-parallelizationfactor"></a>
Jumlah batch yang akan diproses dari tiap serpihan secara bersamaan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ParallelizationFactor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPosition`   <a name="sam-function-dynamodb-startingposition"></a>
Posisi dalam pengaliran tempat untuk mulai membaca.  
+ `AT_TIMESTAMP`— Tentukan waktu untuk mulai membaca catatan.
+ `LATEST`— Baca hanya catatan baru.
+ `TRIM_HORIZON`— Memproses semua catatan yang tersedia.
*Nilai yang valid*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPositionTimestamp`   <a name="sam-function-dynamodb-startingpositiontimestamp"></a>
Waktu untuk mulai membaca, dalam detik waktu Unix. Tentukan `StartingPositionTimestamp` kapan `StartingPosition` ditentukan sebagai`AT_TIMESTAMP`.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Stream`   <a name="sam-function-dynamodb-stream"></a>
Amazon Resource Name (ARN) dari pengaliran DynamoDB.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `TumblingWindowInSeconds`   <a name="sam-function-dynamodb-tumblingwindowinseconds"></a>
Durasi dalam detik dari periode pemrosesan. Kisaran yang valid adalah 1 sampai 900 (15 menit).  
Untuk informasi selengkapnya, lihat [Periode Jatuh](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#streams-tumbling) di *Panduan Developer AWS Lambda *.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TumblingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-dynamodb--examples"></a>

### MetricsConfig acara
<a name="sam-property-function-dynamodb-example-metricsconfigevent"></a>

Berikut ini adalah contoh sumber daya yang menggunakan `MetricsConfig` properti untuk menangkap setiap tahap pemrosesan untuk pemetaan sumber peristiwa mereka.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Sumber peristiwa DynamoDB untuk tabel DynamoDB yang ada
<a name="sam-property-function-dynamodb--examples--dynamodb-event-source-for-existing-dynamodb-table"></a>

DynamoDB sumber peristiwa untuk tabel DynamoDB yang sudah ada di akun. AWS 

#### YAML
<a name="sam-property-function-dynamodb--examples--dynamodb-event-source-for-existing-dynamodb-table--yaml"></a>

```
Events:
  DDBEvent:
    Type: DynamoDB
    Properties:
      Stream: arn:aws:dynamodb:us-east-1:123456789012:table/TestTable/stream/2016-08-11T21:21:33.291
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
```

### Peristiwa DynamoDB untuk tabel DynamoDB yang dinyatakan dalam Templat
<a name="sam-property-function-dynamodb--examples--dynamodb-event-for-dynamodb-table-declared-in-template"></a>

Peristiwa DynamoDB untuk tabel DynamoDB yang dinyatakan dalam file templat yang sama.

#### YAML
<a name="sam-property-function-dynamodb--examples--dynamodb-event-for-dynamodb-table-declared-in-template--yaml"></a>

```
Events:
  DDBEvent:
    Type: DynamoDB
    Properties:
      Stream: 
        !GetAtt MyDynamoDBTable.StreamArn   # This must be the name of a DynamoDB table declared in the same template file
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
```

# EventBridgeRule
<a name="sam-property-function-eventbridgerule"></a>

Objek yang menjelaskan jenis sumber `EventBridgeRule` peristiwa, yang menetapkan fungsi tanpa server Anda sebagai target aturan Amazon. EventBridge Untuk informasi lebih lanjut, 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. AWS SAM juga menciptakan `AWS::Lambda::Permission` sumber daya, yang diperlukan sehingga `EventBridgeRule` dapat memanggil Lambda.

## Sintaksis
<a name="sam-property-function-eventbridgerule-syntax"></a>

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

### YAML
<a name="sam-property-function-eventbridgerule-syntax.yaml"></a>

```
  [DeadLetterConfig](#sam-function-eventbridgerule-deadletterconfig): DeadLetterConfig
  [EventBusName](#sam-function-eventbridgerule-eventbusname): String
  [Input](#sam-function-eventbridgerule-input): String
  [InputPath](#sam-function-eventbridgerule-inputpath): String
  InputTransformer: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)
  [Pattern](#sam-function-eventbridgerule-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  [RetryPolicy](#sam-function-eventbridgerule-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](#sam-function-eventbridgerule-target): Target
```

## Sifat-sifat
<a name="sam-property-function-eventbridgerule-properties"></a>

 `DeadLetterConfig`   <a name="sam-function-eventbridgerule-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 [AWS::Serverless::Function](sam-resource-function.md) sumber daya memiliki tipe data yang serupa`DeadLetterQueue`, yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan yang dikembalikan oleh fungsi target Lambda. *Untuk informasi selengkapnya tentang `DeadLetterQueue` properti fungsi, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *
*Jenis*: [DeadLetterConfig](sam-property-function-deadletterconfig.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-function-eventbridgerule-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-function-eventbridgerule-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-function-eventbridgerule-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-function-eventbridgerule-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-function-eventbridgerule-pattern"></a>
Menjelaskan peristiwa yang dirutekan ke target yang ditentukan. Untuk informasi selengkapnya, lihat [ EventBridgeperistiwa Amazon](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html) dan [pola EventBridge acara](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) di *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-function-eventbridgerule-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-function-eventbridgerule-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-function-eventbridgerule-state"></a>
Keadaan aturan.  
*Nilai yang diterima*: `DISABLED` \$1 `ENABLED` \$1 `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`  
*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-function-eventbridgerule-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-function-target.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. `Amazon EC2 RebootInstances API call`adalah contoh dari properti target. Versi AWS SAM properti ini hanya mengizinkan Anda untuk menentukan ID logis dari satu target.

## Contoh
<a name="sam-property-function-eventbridgerule--examples"></a>

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

Berikut adalah contoh tipe sumber peristiwa `EventBridgeRule`.

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

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
    RetryPolicy:
      MaximumRetryAttempts: 5
      MaximumEventAgeInSeconds: 900
    DeadLetterConfig:
      Type: SQS
      QueueLogicalId: EBRuleDLQ
    Target:
      Id: MyTarget
```

# DeadLetterConfig
<a name="sam-property-function-deadletterconfig"></a>

Objek yang digunakan untuk menentukan antrean Amazon Simple Queue Service (Amazon SQS) EventBridge tempat mengirimkan peristiwa setelah pemanggilan target gagal. Permintaan dapat gagal, misalnya, ketika mengirim peristiwa ke fungsi Lambda yang tidak ada, atau izin tidak 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 *

**catatan**  
Jenis [AWS::Serverless::Function](sam-resource-function.md) sumber daya memiliki tipe data yang serupa, `DeadLetterQueue` yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan dikembalikan oleh fungsi target Lambda. *Untuk informasi selengkapnya tentang `DeadLetterQueue` properti fungsi, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *

## Sintaksis
<a name="sam-property-function-deadletterconfig-syntax"></a>

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

### YAML
<a name="sam-property-function-deadletterconfig-syntax.yaml"></a>

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

## Sifat-sifat
<a name="sam-property-function-deadletterconfig-properties"></a>

 `Arn`   <a name="sam-function-deadletterconfig-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-function-deadletterconfig-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-function-deadletterconfig-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-function-deadletterconfig--examples"></a>

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

DeadLetterConfig

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

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

# Target
<a name="sam-property-function-target"></a>

Mengkonfigurasi AWS sumber daya yang EventBridge dipanggil ketika aturan dipicu.

## Sintaksis
<a name="sam-property-function-target-syntax"></a>

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

### YAML
<a name="sam-property-function-target-syntax.yaml"></a>

```
  [Id](#sam-function-target-id): String
```

## Sifat-sifat
<a name="sam-property-function-target-properties"></a>

 `Id`   <a name="sam-function-target-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-function-target--examples"></a>

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

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

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

# HttpApi
<a name="sam-property-function-httpapi"></a>

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.

## Sintaksis
<a name="sam-property-function-httpapi-syntax"></a>

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

### YAML
<a name="sam-property-function-httpapi-syntax.yaml"></a>

```
  [ApiId](#sam-function-httpapi-apiid): String
  [Auth](#sam-function-httpapi-auth): HttpApiFunctionAuth
  [Method](#sam-function-httpapi-method): String
  [Path](#sam-function-httpapi-path): String
  [PayloadFormatVersion](#sam-function-httpapi-payloadformatversion): String
  [RouteSettings](#sam-function-httpapi-routesettings): [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)
  [TimeoutInMillis](#sam-function-httpapi-timeoutinmillis): Integer
```

## Sifat-sifat
<a name="sam-property-function-httpapi-properties"></a>

 `ApiId`   <a name="sam-function-httpapi-apiid"></a>
Pengenal dari sumber daya [AWS::Serverless::HttpApi](sam-resource-httpapi.md) yang ditentukan dalam templat ini.  
Jika tidak ditentukan, [AWS::Serverless::HttpApi](sam-resource-httpapi.md) 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 menentukan`ApiId`.  
Ini tidak dapat merujuk sumber daya [AWS::Serverless::HttpApi](sam-resource-httpapi.md) yang ditentukan dalam templat lain.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Auth`   <a name="sam-function-httpapi-auth"></a>
Konfigurasi auth untuk Api\$1Path\$1Metode tertentu ini.  
Berguna untuk membatalkan `DefaultAuthorizer` API atau mengatur auth config pada jalur individu ketika `DefaultAuthorizer` tidak ditentukan.  
*Jenis*: [HttpApiFunctionAuth](sam-property-function-httpapifunctionauth.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Method`   <a name="sam-function-httpapi-method"></a>
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  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Path`   <a name="sam-function-httpapi-path"></a>
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  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `PayloadFormatVersion`   <a name="sam-function-httpapi-payloadformatversion"></a>
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  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `RouteSettings`   <a name="sam-function-httpapi-routesettings"></a>
Pengaturan rute per rute untuk API HTTP ini. Untuk informasi selengkapnya tentang setelan rute, lihat [AWS::ApiGatewayV2::Stage RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html)di *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` properti `AWS::ApiGatewayV2::Stage` sumber daya.

 `TimeoutInMillis`   <a name="sam-function-httpapi-timeoutinmillis"></a>
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  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-httpapi--examples"></a>

### HttpApi Acara Default
<a name="sam-property-function-httpapi--examples--default-httpapi-event"></a>

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

#### YAML
<a name="sam-property-function-httpapi--examples--default-httpapi-event--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
```

### HttpApi
<a name="sam-property-function-httpapi--examples--httpapi"></a>

HttpApi Peristiwa yang menggunakan jalur dan metode tertentu.

#### YAML
<a name="sam-property-function-httpapi--examples--httpapi--yaml"></a>

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

### HttpApi Otorisasi
<a name="sam-property-function-httpapi--examples--httpapi-authorization"></a>

HttpApi Event yang menggunakan Authorizer.

#### YAML
<a name="sam-property-function-httpapi--examples--httpapi-authorization--yaml"></a>

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

# HttpApiFunctionAuth
<a name="sam-property-function-httpapifunctionauth"></a>

Mengonfigurasi otorisasi di tingkat peristiwa.

Mengonfigurasi Auth untuk API \$1 Path \$1 Metode tertentu

## Sintaksis
<a name="sam-property-function-httpapifunctionauth-syntax"></a>

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

### YAML
<a name="sam-property-function-httpapifunctionauth-syntax.yaml"></a>

```
  [AuthorizationScopes](#sam-function-httpapifunctionauth-authorizationscopes): List
  [Authorizer](#sam-function-httpapifunctionauth-authorizer): String
```

## Sifat-sifat
<a name="sam-property-function-httpapifunctionauth-properties"></a>

 `AuthorizationScopes`   <a name="sam-function-httpapifunctionauth-authorizationscopes"></a>
Cakupan otorisasi yang akan diterapkan ke API, path, dan metode ini.  
Lingkup yang tercantum di sini akan membatalkan setiap cakupan yang diterapkan oleh `DefaultAuthorizer` jika ada.  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Authorizer`   <a name="sam-function-httpapifunctionauth-authorizer"></a>
`Authorizer`Untuk Fungsi tertentu. Untuk menggunakan otorisasi IAM, tentukan `AWS_IAM` dan tentukan `true` untuk `EnableIamAuthorizer` di `Globals` bagian template Anda.  
Jika Anda telah menentukan Otorisasi Global pada API dan ingin membuat Fungsi tertentu terbuka untuk publik, batalkan dengan mengatur `Authorizer` menjadi `NONE`.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-httpapifunctionauth--examples"></a>

### Function-Auth
<a name="sam-property-function-httpapifunctionauth--examples--function-auth"></a>

Menentukan Otorisasi di tingkat Fungsi

#### YAML
<a name="sam-property-function-httpapifunctionauth--examples--function-auth--yaml"></a>

```
Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2
```

### Otorisasi IAM
<a name="sam-property-function-httpapifunctionauth--examples--iam-authorization"></a>

Menentukan otorisasi IAM di tingkat acara. Untuk menggunakan `AWS_IAM` otorisasi di tingkat acara, Anda juga harus menentukan `true` untuk `EnableIamAuthorizer` di `Globals` bagian template Anda. Untuk informasi selengkapnya, lihat [Bagian global dari template AWS SAM](sam-specification-template-anatomy-globals.md).

#### YAML
<a name="sam-property-function-httpapifunctionauth--examples--iam-authorization--yaml"></a>

```
Globals:
  HttpApi:
    Auth:
      EnableIamAuthorizer: true

Resources:
  HttpApiFunctionWithIamAuth:
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: HttpApi
          Properties:
            Path: /iam-auth
            Method: GET
            Auth:
              Authorizer: AWS_IAM
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
          return {'body': 'HttpApiFunctionWithIamAuth', 'statusCode': 200}
      Runtime: python3.9
```

# IoTRule
<a name="sam-property-function-iotrule"></a>

Objek yang menggambarkan tipe sumber peristiwa `IoTRule`.

Membuat sumber [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html)daya untuk mendeklarasikan aturan. AWS IoT Untuk informasi selengkapnya, lihat [dokumentasi CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html)

## Sintaksis
<a name="sam-property-function-iotrule-syntax"></a>

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

### YAML
<a name="sam-property-function-iotrule-syntax.yaml"></a>

```
  [AwsIotSqlVersion](#sam-function-iotrule-awsiotsqlversion): String
  [Sql](#sam-function-iotrule-sql): String
```

## Sifat-sifat
<a name="sam-property-function-iotrule-properties"></a>

 `AwsIotSqlVersion`   <a name="sam-function-iotrule-awsiotsqlversion"></a>
Versi mesin aturan SQL yang harus digunakan saat mengevaluasi aturan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AwsIotSqlVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion)` properti `AWS::IoT::TopicRule TopicRulePayload` sumber daya.

 `Sql`   <a name="sam-function-iotrule-sql"></a>
Pernyataan SQL yang digunakan untuk mengkuerikan topik. Untuk informasi selengkapnya, lihat [Referensi SQL AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) di *Panduan Developer AWS IoT *.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Sql](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql)` properti `AWS::IoT::TopicRule TopicRulePayload` sumber daya.

## Contoh
<a name="sam-property-function-iotrule--examples"></a>

### Aturan IOT
<a name="sam-property-function-iotrule--examples--iot-rule"></a>

Contoh Aturan IOT

#### YAML
<a name="sam-property-function-iotrule--examples--iot-rule--yaml"></a>

```
IoTRule:
  Type: IoTRule
  Properties:
    Sql: SELECT * FROM 'topic/test'
```

# Kinesis
<a name="sam-property-function-kinesis"></a>

Objek yang menggambarkan tipe sumber peristiwa `Kinesis`. Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda dengan Amazon Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html) di Panduan *AWS Lambda Pengembang*.

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

## Sintaksis
<a name="sam-property-function-kinesis-syntax"></a>

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

### YAML
<a name="sam-property-function-kinesis-syntax.yaml"></a>

```
  [BatchSize](#sam-function-kinesis-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-kinesis-bisectbatchonfunctionerror): Boolean
  [DestinationConfig](#sam-function-kinesis-destinationconfig): [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)
  [Enabled](#sam-function-kinesis-enabled): Boolean
  [FilterCriteria](#sam-function-kinesis-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-kinesis-functionresponsetypes): List
  KmsKeyArn: String          
  [MaximumBatchingWindowInSeconds](#sam-function-kinesis-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-kinesis-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-kinesis-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-kinesis-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ParallelizationFactor](#sam-function-kinesis-parallelizationfactor): Integer
  [StartingPosition](#sam-function-kinesis-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-kinesis-stream): String
  [TumblingWindowInSeconds](#sam-function-kinesis-tumblingwindowinseconds): Integer
```

## Sifat-sifat
<a name="sam-property-function-kinesis-properties"></a>

 `BatchSize`   <a name="sam-function-kinesis-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 100  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.  
*Minimal*: `1`  
*Maksimum*: `10000`

 `BisectBatchOnFunctionError`   <a name="sam-function-kinesis-bisectbatchonfunctionerror"></a>
Jika fungsi mengembalikan kesalahan, bagi batch menjadi dua dan coba lagi.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `DestinationConfig`   <a name="sam-function-kinesis-destinationconfig"></a>
Antrean Amazon Simple Queue Service (Amazon SQS) atau tujuan topik Amazon Simple Notification Service (Amazon SNS) untuk catatan yang dibuang.  
*Jenis*: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Enabled`   <a name="sam-function-kinesis-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-kinesis-filtercriteria"></a>
Objek yang mendefinisikan kriteria untuk menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FunctionResponseTypes`   <a name="sam-function-kinesis-functionresponsetypes"></a>
Daftar tipe jawaban saat ini yang diterapkan ke pemetaan sumber peristiwa. Untuk informasi selengkapnya, lihat [Melaporkan kegagalan item batch](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-batchfailurereporting) di *Panduan Developer AWS Lambda *.  
*Nilai yang valid*: `ReportBatchItemFailures`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KmsKeyArn`   <a name="sam-function-kinesis-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-kinesis-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan rekaman sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-kinesis-maximumrecordageinseconds"></a>
Periode permintaan maksimum yang dikirimkan Lambda ke fungsi untuk diproses.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRetryAttempts`   <a name="sam-function-kinesis-maximumretryattempts"></a>
Jumlah waktu maksimum untuk mencoba kembali saat fungsi mengembalikan kesalahan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MetricsConfig`   <a name="sam-function-kinesis-metricsconfig"></a>
Konfigurasi keikutsertaan untuk mendapatkan metrik yang disempurnakan untuk pemetaan sumber peristiwa yang menangkap setiap tahap pemrosesan. Sebagai contoh, lihat [MetricsConfig acara](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent).  
*Jenis*: [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ParallelizationFactor`   <a name="sam-function-kinesis-parallelizationfactor"></a>
Jumlah batch yang akan diproses dari tiap serpihan secara bersamaan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ParallelizationFactor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPosition`   <a name="sam-function-kinesis-startingposition"></a>
Posisi dalam pengaliran tempat untuk mulai membaca.  
+ `AT_TIMESTAMP`— Tentukan waktu untuk mulai membaca catatan.
+ `LATEST`— Baca hanya catatan baru.
+ `TRIM_HORIZON`— Memproses semua catatan yang tersedia.
*Nilai yang valid*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPositionTimestamp`   <a name="sam-function-kinesis-startingpositiontimestamp"></a>
Waktu untuk mulai membaca, dalam detik waktu Unix. Tentukan `StartingPositionTimestamp` kapan `StartingPosition` ditentukan sebagai`AT_TIMESTAMP`.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Stream`   <a name="sam-function-kinesis-stream"></a>
Amazon Resource Name (ARN) dari aliran data atau konsumen pengaliran.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `TumblingWindowInSeconds`   <a name="sam-function-kinesis-tumblingwindowinseconds"></a>
Durasi dalam detik dari periode pemrosesan. Kisaran yang valid adalah 1 sampai 900 (15 menit).  
Untuk informasi selengkapnya, lihat [Periode Jatuh](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#streams-tumbling) di *Panduan Developer AWS Lambda *.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TumblingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-kinesis--examples"></a>

### MetricsConfig acara
<a name="sam-property-function-kinesis-example-metricsconfigevent"></a>

Berikut ini adalah contoh sumber daya yang menggunakan `MetricsConfig` properti untuk menangkap setiap tahap pemrosesan untuk pemetaan sumber peristiwa mereka.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Sumber peristiwa Kinesis
<a name="sam-property-function-kinesis--examples--kinesis-event-source"></a>

Berikut ini adalah contoh sumber peristiwa Kinesis.

#### YAML
<a name="sam-property-function-kinesis--examples--kinesis-event-source--yaml"></a>

```
Events:
  KinesisEvent:
    Type: Kinesis
    Properties:
      Stream: arn:aws:kinesis:us-east-1:123456789012:stream/my-stream
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
      FilterCriteria: 
        Filters: 
          - Pattern: '{"key": ["val1", "val2"]}'
```

# MQ
<a name="sam-property-function-mq"></a>

Objek yang menggambarkan tipe sumber peristiwa `MQ`. Untuk informasi lebih lanjut, lihat [Menggunakan Lambda dengan Amazon MQ](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html) dalam *Panduan Developer AWS Lambda *.

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

**catatan**  
Untuk memiliki antrian Amazon MQ di cloud pribadi virtual (VPC) yang terhubung ke fungsi Lambda di jaringan publik, peran eksekusi fungsi Anda harus menyertakan izin berikut:   
`ec2:CreateNetworkInterface`
`ec2:DeleteNetworkInterface`
`ec2:DescribeNetworkInterfaces`
`ec2:DescribeSecurityGroups`
`ec2:DescribeSubnets`
`ec2:DescribeVpcs`
Untuk informasi selengkapnya, lihat [Izin peran eksekusi](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#events-mq-permissions) di *Panduan Developer AWS Lambda *.

## Sintaksis
<a name="sam-property-function-mq-syntax"></a>

Untuk mendeklarasikan entitas ini di AWS SAM template Anda, gunakan sintaks berikut.

### YAML
<a name="sam-property-function-mq-syntax.yaml"></a>

```
  [BatchSize](#sam-function-mq-batchsize): Integer
  [Broker](#sam-function-mq-broker): String
  DynamicPolicyName: Boolean
  [Enabled](#sam-function-mq-enabled): Boolean
  [FilterCriteria](#sam-function-mq-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  KmsKeyArn: String 
  [MaximumBatchingWindowInSeconds](#sam-function-mq-maximumbatchingwindowinseconds): Integer
  [Queues](#sam-function-mq-queues): List
  [SecretsManagerKmsKeyId](#sam-function-mq-secretsmanagerkmskeyid): String
  [SourceAccessConfigurations](#sam-function-mq-sourceaccessconfigurations): List
```

## Sifat-sifat
<a name="sam-property-function-mq-properties"></a>

 `BatchSize`   <a name="sam-function-mq-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 100  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.  
*Minimal*: `1`  
*Maksimum*: `10000`

 `Broker`   <a name="sam-function-mq-broker"></a>
Amazon Resource Name (ARN) broker Amazon MQ.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `DynamicPolicyName`   <a name="sam-function-mq-dynamicpolicyname"></a>
Secara default, nama kebijakan AWS Identity and Access Management (IAM) adalah `SamAutoGeneratedAMQPolicy` untuk kompatibilitas mundur. Tentukan `true` untuk menggunakan nama yang dibuat secara otomatis untuk kebijakan IAM Anda. Nama ini akan menyertakan ID logis sumber peristiwa Amazon MQ.  
Saat menggunakan lebih dari satu sumber peristiwa Amazon MQ, tentukan `true` untuk menghindari duplikat nama kebijakan IAM.
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: `false`  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Enabled`   <a name="sam-function-mq-enabled"></a>
Jika`true`, pemetaan sumber peristiwa aktif. Untuk menjeda polling dan pemanggilan, atur ke `false`.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-mq-filtercriteria"></a>
Objek yang mendefinisikan kriteria yang menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KmsKeyArn`   <a name="sam-function-mq-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-mq-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan rekaman sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Queues`   <a name="sam-function-mq-queues"></a>
Nama antrean tujuan broker Amazon MQ yang akan digunakan.  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Queues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `SecretsManagerKmsKeyId`   <a name="sam-function-mq-secretsmanagerkmskeyid"></a>
ID kunci AWS Key Management Service (AWS KMS) kunci kunci yang dikelola pelanggan dari AWS Secrets Manager. Diperlukan saat Anda menggunakan kunci terkelola pelanggan dari Secrets Manager dengan peran eksekusi Lambda yang tidak menyertakan izin. `kms:Decrypt`  
Nilai properti ini adalah UUID. Sebagai contoh: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`.  
*Tipe*: String  
*Wajib*: Bersyarat  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `SourceAccessConfigurations`   <a name="sam-function-mq-sourceaccessconfigurations"></a>
Array dari protokol autentikasi atau host vitual. Tentukan ini menggunakan tipe [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)data.  
Untuk tipe sumber `MQ` acara, satu-satunya tipe konfigurasi yang valid adalah `BASIC_AUTH` dan`VIRTUAL_HOST`.  
+ **`BASIC_AUTH`**Rahasia Secrets Manager yang menyimpan kredensi broker Anda. Untuk tipe ini, kredensialnya harus dalam format berikut: `{"username": "your-username", "password": "your-password"}`. Hanya satu objek dari tipe `BASIC_AUTH` diizinkan.
+ **`VIRTUAL_HOST`**— Nama host virtual di broker RabbitMQ Anda. Lambda akan menggunakan host Rabbit MQ ini sebagai sumber peristiwa. Hanya satu objek dari tipe `VIRTUAL_HOST` diizinkan.
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-mq--examples"></a>

### Sumber peristiwa Amazon MQ
<a name="sam-property-function-mq--examples--amazon-mq-event-source"></a>

Berikut ini adalah contoh tipe sumber peristiwa `MQ` untuk broker Amazon MQ.

#### YAML
<a name="sam-property-function-mq--examples--amazon-mq-event-source--yaml"></a>

```
Events:
  MQEvent:
    Type: MQ
    Properties:
      Broker: arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
      Queues: List of queues
      SourceAccessConfigurations:
        - Type: BASIC_AUTH
          URI: arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName
      BatchSize: 200
      Enabled: true
```

# MSK
<a name="sam-property-function-msk"></a>

Objek yang menggambarkan tipe sumber peristiwa `MSK`. Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda MSK Amazon](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) di *Panduan AWS Lambda Pengembang*.

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

Untuk menggunakan Schema Registry, Anda perlu menentukan izin peran IAM tertentu untuk fungsi Anda. Lihat [Penyiapan lengkap dengan peran IAM](#sam-property-function-msk-example-complete) untuk contoh konfigurasi yang diperlukan.

## Sintaksis
<a name="sam-property-function-msk-syntax"></a>

Untuk mendeklarasikan entitas ini di AWS SAM template Anda, gunakan sintaks berikut.

### YAML
<a name="sam-property-function-msk-syntax.yaml"></a>

```
  [BatchSize](#sam-function-msk-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-msk-bisectbatchonfunctionerror): Boolean
  [ConsumerGroupId](#sam-function-msk-consumergroupid): String
  DestinationConfig: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)
  [Enabled](#sam-function-msk-enabled): Boolean
  [FilterCriteria](#sam-function-msk-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-msk-functionresponsetypes): List
  KmsKeyArn: String
  [MaximumBatchingWindowInSeconds](#sam-function-msk-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-msk-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-msk-maximumretryattempts): Integer
  [LoggingConfig](#sam-function-msk-loggingconfig): [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)
  [MetricsConfig](#sam-function-msk-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)
  [ProvisionedPollerConfig](#sam-function-msk-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [SchemaRegistryConfig](#sam-function-msk-schemaregistryconfig): [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html)
  SourceAccessConfigurations: [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)
  [StartingPosition](#sam-function-msk-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-msk-stream): String
  [Topics](#sam-function-msk-topics): List
```

## Sifat-sifat
<a name="sam-property-function-msk-properties"></a>

 `BatchSize`   <a name="sam-function-msk-batchsize"></a>
Jumlah maksimum rekaman di setiap batch yang Lambda tarik dari aliran atau antrian Anda dan dikirim ke fungsi Anda. Lambda meneruskan semua catatan dalam batch ke fungsi dalam satu panggilan, hingga batas payload untuk pemanggilan sinkron (6 MB).  
*Default*: 100  
*Rentang Valid*: Nilai minimum 1. Nilai maksimum 10.000.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `BisectBatchOnFunctionError`   <a name="sam-function-msk-bisectbatchonfunctionerror"></a>
Jika fungsi mengembalikan kesalahan, bagi batch menjadi dua dan coba lagi.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ConsumerGroupId`   <a name="sam-function-msk-consumergroupid"></a>
String yang mengonfigurasi bagaimana acara akan dibaca dari topik Kafka.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AmazonManagedKafkaConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `DestinationConfig`   <a name="sam-function-msk-destinationconfig"></a>
Objek konfigurasi yang menentukan tujuan dari peristiwa setelah Lambda memprosesnya.  
Gunakan properti ini untuk menentukan tujuan pemanggilan gagal dari sumber peristiwa MSK Amazon.  
*Jenis*: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Enabled`   <a name="sam-function-msk-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-msk-filtercriteria"></a>
Objek yang mendefinisikan kriteria yang menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FunctionResponseTypes`   <a name="sam-function-msk-functionresponsetypes"></a>
Daftar tipe jawaban saat ini yang diterapkan ke pemetaan sumber peristiwa. Untuk informasi selengkapnya, lihat [Melaporkan kegagalan item batch](https://docs.aws.amazon.com/lambda/latest/dg/kafka-retry-configurations.html) di *Panduan Developer AWS Lambda *.  
*Nilai yang valid*: `ReportBatchItemFailures`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KmsKeyArn`   <a name="sam-function-msk-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-msk-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan rekaman sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-msk-maximumrecordageinseconds"></a>
Periode permintaan maksimum yang dikirimkan Lambda ke fungsi untuk diproses.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRetryAttempts`   <a name="sam-function-msk-maximumretryattempts"></a>
Jumlah waktu maksimum untuk mencoba kembali saat fungsi mengembalikan kesalahan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `LoggingConfig`   <a name="sam-function-msk-loggingconfig"></a>
Objek konfigurasi yang menentukan konfigurasi logging untuk pemetaan sumber peristiwa.  
*Jenis*: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MetricsConfig`   <a name="sam-function-msk-metricsconfig"></a>
Objek konfigurasi yang menentukan konfigurasi metrik untuk pemetaan sumber peristiwa.  
*Jenis*: [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ProvisionedPollerConfig`   <a name="sam-function-msk-provisionedpollerconfig"></a>
Konfigurasi untuk meningkatkan jumlah poller yang digunakan untuk menghitung pemetaan sumber peristiwa. Konfigurasi ini memungkinkan minimal 1 poller dan maksimum 2000 poller. Sebagai contoh, lihat[ProvisionedPollerConfig contoh](#sam-property-function-msk-example-provisionedpollerconfig).  
*Jenis*: [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

`SchemaRegistryConfig`  <a name="sam-function-msk-schemaregistryconfig"></a>
Konfigurasi untuk menggunakan registri skema dengan sumber acara Kafka.  
Fitur ini `ProvisionedPollerConfig` perlu dikonfigurasi.
*Jenis*: SchemaRegistryConfig  
*Wajib*: Tidak  
*CloudFormation kompatibilitas:* Properti ini diteruskan langsung ke `[AmazonManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `SourceAccessConfigurations`   <a name="sam-function-msk-sourceaccessconfigurations"></a>
Susunan protokol autentikasi, komponen VPC, atau host virtual untuk mengamankan dan menentukan sumber peristiwa Anda.  
*Nilai yang valid*: `CLIENT_CERTIFICATE_TLS_AUTH`  
*Jenis*: Daftar [SourceAccessConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas:* Properti ini adalah bagian dari [AmazonManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig)properti sumber daya. `AWS::Lambda::EventSourceMapping`

 `StartingPosition`   <a name="sam-function-msk-startingposition"></a>
Posisi dalam pengaliran tempat untuk mulai membaca.  
+ `AT_TIMESTAMP`— Tentukan waktu untuk mulai membaca catatan.
+ `LATEST`— Baca hanya catatan baru.
+ `TRIM_HORIZON`— Memproses semua catatan yang tersedia.
*Nilai yang valid*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPositionTimestamp`   <a name="sam-function-msk-startingpositiontimestamp"></a>
Waktu untuk mulai membaca, dalam detik waktu Unix. Tentukan `StartingPositionTimestamp` kapan `StartingPosition` ditentukan sebagai`AT_TIMESTAMP`.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Stream`   <a name="sam-function-msk-stream"></a>
Amazon Resource Name (ARN) dari aliran data atau konsumen pengaliran.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Topics`   <a name="sam-function-msk-topics"></a>
Nama topik Kafka.  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Topics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-msk--examples"></a>

### Penyiapan lengkap dengan peran IAM
<a name="sam-property-function-msk-example-complete"></a>

Contoh berikut menunjukkan penyiapan lengkap termasuk konfigurasi peran IAM yang diperlukan untuk menggunakan Schema Registry:

```
Parameters:
  PreCreatedSubnetOne:
    Type: String
  PreCreatedSubnetTwo:
    Type: String
  MskClusterName4:
    Type: String

Resources:
  MyLambdaExecutionRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17		 	 	 '
        Statement:
        - Action: [sts:AssumeRole]
          Effect: Allow
          Principal:
            Service: [lambda.amazonaws.com]
      Policies:
      - PolicyName: KafkaClusterPermissions
        PolicyDocument:
          Statement:
          - Action: [kafka:DescribeClusterV2, kafka:GetBootstrapBrokers]
            Effect: Allow
            Resource: 'arn:aws:kafka:us-east-1:123456789012:cluster/*'
      - PolicyName: KafkaAuthPolicy
        PolicyDocument:
          Statement:
          - Action: [secretsmanager:GetSecretValue, kms:Decrypt]
            Effect: "Allow"
            Resource: ['arn:aws:secretsmanager:us-west-2:123456789012:secret:kafkaSecret-******',
                        'arn:aws:kms:us-west-2:123456789012:key/keyId']
      - PolicyName: ENIPolicy
        PolicyDocument:
          Statement:
          - Action: [ec2:CreateNetworkInterface,
              ec2:DescribeNetworkInterfaces, ec2:DescribeVpcs, ec2:DeleteNetworkInterface,
              ec2:DescribeSubnets, ec2:DescribeSecurityGroups]
            Effect: Allow
            Resource: '*'
      - PolicyName: SchemaRegistryPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetRegistry]
            Effect: Allow
            Resource: 'arn:aws:glue:{region}:{account-id}:registry/{registry-name}'
      - PolicyName: SchemaVersionsPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetSchemaVersions]
            Effect: Allow
            Resource: '*'
      ManagedPolicyArns:
      - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
      Tags:
      - {Value: SAM, Key: lambda:createdBy}

  MyMskCluster:
    Type: AWS::MSK::Cluster
    Properties:
      BrokerNodeGroupInfo:
        ClientSubnets:
        - Ref: PreCreatedSubnetOne
        - Ref: PreCreatedSubnetTwo
        InstanceType: kafka.t3.small
        StorageInfo:
          EBSStorageInfo:
            VolumeSize: 1
      ClusterName:
        Ref: MskClusterName4
      KafkaVersion: 3.8.x
      NumberOfBrokerNodes: 2

  MyMskStreamProcessor:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: nodejs18.x
      Handler: index.handler
      CodeUri: ${codeuri}
      Role:
        Fn::GetAtt: [MyLambdaExecutionRole, Arn]
      Events:
        MyMskEvent:
          Type: MSK
          Properties:
            StartingPosition: LATEST
            Stream:
              Ref: MyMskCluster
            SourceAccessConfigurations:
            - Type: SASL_SCRAM_512_AUTH
              URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
            Topics:
            - SchemaRegistryTestTopic
            ProvisionedPollerConfig:
              MinimumPollers: 1
            SchemaRegistryConfig:
              AccessConfigs:
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
              SchemaValidationConfigs:
              - Attribute: KEY
              EventRecordFormat: JSON
              SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
```

### ProvisionedPollerConfig contoh
<a name="sam-property-function-msk-example-provisionedpollerconfig"></a>

```
ProvisionedPollerConfig:
  MinimumPollers: 1
  MaximumPollers: 200
```

### Contoh Amazon MSK untuk Klaster yang ada
<a name="sam-property-function-msk--examples--amazon-msk-example-for-existing-cluster"></a>

Berikut ini adalah contoh jenis sumber `MSK` peristiwa untuk kluster MSK Amazon yang sudah ada di file Akun AWS.

#### YAML
<a name="sam-property-function-msk--examples--amazon-msk-example-for-existing-cluster--yaml"></a>

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream: arn:aws:kafka:us-east-1:012345678012:cluster/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2
      Topics:
        - MyTopic
```

### Amazon MSK contoh untuk Klaster yang dinyatakan dalam Templat yang sama
<a name="sam-property-function-msk--examples--amazon-msk-example-for-cluster-declared-in-same-template"></a>

Berikut ini adalah contoh tipe sumber peristiwa `MSK` untuk klaster Amazon MSK yang dinyatakan dalam file templat yang sama.

#### YAML
<a name="sam-property-function-msk--examples--amazon-msk-example-for-cluster-declared-in-same-template--yaml"></a>

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster   # This must be the name of an MSK cluster declared in the same template file
      Topics:
        - MyTopic
```

#### Sumber Acara MSK dengan Registri Skema
<a name="sam-property-function-msk-example-schemaregistry"></a>

Berikut ini adalah contoh dari jenis sumber `MSK` peristiwa dikonfigurasi dengan registri skema.

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster
      Topics:
        - SchemaRegistryTestTopic
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
```

#### Sumber Acara MSK dengan Registri Skema Konfluen
<a name="sam-property-function-msk-example-schemaregistry-confluent"></a>

Berikut ini adalah contoh dari jenis sumber `MSK` peristiwa dikonfigurasi dengan Confluent Schema Registry.

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster
      Topics:
        - SchemaRegistryTestTopic
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: https://my-schema-registry.confluent.cloud
        AccessConfigs:
          - Type: BASIC_AUTH
            URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-secret
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
```

# S3
<a name="sam-property-function-s3"></a>

Objek yang menggambarkan tipe sumber peristiwa `S3`.

## Sintaksis
<a name="sam-property-function-s3-syntax"></a>

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

### YAML
<a name="sam-property-function-s3-syntax.yaml"></a>

```
  [Bucket](#sam-function-s3-bucket): String
  [Events](#sam-function-s3-events): String | List
  [Filter](#sam-function-s3-filter): [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)
```

## Sifat-sifat
<a name="sam-property-function-s3-properties"></a>

 `Bucket`   <a name="sam-function-s3-bucket"></a>
Nama bucket S3. Bucket ini harus ada dalam templat yang sama.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini mirip dengan `[BucketName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name)` properti `AWS::S3::Bucket` sumber daya. Ini adalah bidang yang diperlukan dalam SAM. Bidang ini hanya menerima referensi ke bucket S3 yang dibuat dalam templat ini

 `Events`   <a name="sam-function-s3-events"></a>
Peristiwa bucket Amazon S3 yang akan dipanggilkan fungsi Lambda. Lihat [Tipe peristiwa yang didukung Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#supported-notification-event-types) untuk daftar nilai yang valid.  
*Tipe*: String \$1 Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Event](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-event)` properti tipe `AWS::S3::Bucket` `LambdaConfiguration` data.

 `Filter`   <a name="sam-function-s3-filter"></a>
Aturan pemfilteran yang menentukan objek Amazon S3 yang memanggil fungsi Lambda. Untuk informasi tentang pemfilteran nama kunci Amazon S3, lihat Mengonfigurasi [Pemberitahuan Acara Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) di Panduan Pengguna Layanan Penyimpanan Sederhana *Amazon*.  
*Jenis*: [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)` properti tipe `AWS::S3::Bucket` `LambdaConfiguration` data.

## Contoh
<a name="sam-property-function-s3--examples"></a>

### S3-Event
<a name="sam-property-function-s3--examples--s3-event"></a>

Contoh peristiwa S3.

#### YAML
<a name="sam-property-function-s3--examples--s3-event--yaml"></a>

```
Events:
  S3Event:
    Type: S3
    Properties:
      Bucket:
        Ref: ImagesBucket     # This must be the name of an S3 bucket declared in the same template file
      Events: s3:ObjectCreated:*
      Filter:
        S3Key:
          Rules:
          - Name: prefix      # or "suffix"
            Value: value      # The value to search for in the S3 object key names
```

# Schedule
<a name="sam-property-function-schedule"></a>

Objek yang menjelaskan jenis sumber `Schedule` peristiwa, yang menetapkan fungsi tanpa server Anda sebagai target EventBridge aturan Amazon yang dipicu pada 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.

**catatan**  
EventBridge sekarang menawarkan kemampuan penjadwalan baru, [Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html). Amazon EventBridge Scheduler adalah penjadwal tanpa server yang memungkinkan Anda membuat, menjalankan, dan mengelola tugas dari satu layanan terpusat dan terkelola. EventBridge Schedulersangat dapat disesuaikan, dan menawarkan skalabilitas yang ditingkatkan dibandingkan aturan EventBridge terjadwal, dengan serangkaian operasi API target yang lebih luas dan. Layanan AWS  
Kami merekomendasikan Anda menggunakan EventBridge Scheduler untuk menginvokasi target sesuai jadwal. Untuk menentukan jenis sumber acara ini di AWS SAM templat Anda, lihat[ScheduleV2](sam-property-function-schedulev2.md).

## Sintaksis
<a name="sam-property-function-schedule-syntax"></a>

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

### YAML
<a name="sam-property-function-schedule-syntax.yaml"></a>

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

## Sifat-sifat
<a name="sam-property-function-schedule-properties"></a>

 `DeadLetterConfig`   <a name="sam-function-schedule-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 [AWS::Serverless::Function](sam-resource-function.md) sumber daya memiliki tipe data yang serupa`DeadLetterQueue`, yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan yang dikembalikan oleh fungsi target Lambda. *Untuk informasi selengkapnya tentang `DeadLetterQueue` properti fungsi, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *
*Jenis*: [DeadLetterConfig](sam-property-function-scheduledeadletterconfig.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-function-schedule-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-function-schedule-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-function-schedule-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-function-schedule-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-function-schedule-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.

 `Schedule`   <a name="sam-function-schedule-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-function-schedule-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.

## Contoh
<a name="sam-property-function-schedule--examples"></a>

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

CloudWatch Jadwal Contoh Acara

#### YAML
<a name="sam-property-function-schedule--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-function-scheduledeadletterconfig"></a>

Objek yang digunakan untuk menentukan antrean Amazon Simple Queue Service (Amazon SQS) EventBridge tempat mengirimkan peristiwa setelah pemanggilan target gagal. Permintaan dapat gagal, misalnya, ketika mengirim peristiwa ke fungsi Lambda yang tidak ada, atau izin tidak 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 *

**catatan**  
Jenis [AWS::Serverless::Function](sam-resource-function.md) sumber daya memiliki tipe data yang serupa, `DeadLetterQueue` yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan dikembalikan oleh fungsi target Lambda. *Untuk informasi selengkapnya tentang `DeadLetterQueue` properti fungsi, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *

## Sintaksis
<a name="sam-property-function-scheduledeadletterconfig-syntax"></a>

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

### YAML
<a name="sam-property-function-scheduledeadletterconfig-syntax.yaml"></a>

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

## Sifat-sifat
<a name="sam-property-function-scheduledeadletterconfig-properties"></a>

 `Arn`   <a name="sam-function-scheduledeadletterconfig-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-function-scheduledeadletterconfig-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-function-scheduledeadletterconfig-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-function-scheduledeadletterconfig--examples"></a>

### DeadLetterConfig
<a name="sam-property-function-scheduledeadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

#### YAML
<a name="sam-property-function-scheduledeadletterconfig--examples--deadletterconfig--yaml"></a>

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

# ScheduleV2
<a name="sam-property-function-schedulev2"></a>

Objek yang menjelaskan jenis sumber `ScheduleV2` peristiwa, yang menetapkan fungsi tanpa server 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-function-schedulev2-syntax"></a>

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

### YAML
<a name="sam-property-function-schedulev2-syntax.yaml"></a>

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

## Sifat-sifat
<a name="sam-property-function-schedulev2-properties"></a>

 `DeadLetterConfig`   <a name="sam-function-schedulev2-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 [AWS::Serverless::Function](sam-resource-function.md) sumber daya memiliki tipe data yang serupa`DeadLetterQueue`, yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan yang dikembalikan oleh fungsi target Lambda. *Untuk informasi selengkapnya tentang `DeadLetterQueue` properti fungsi, lihat [Antrian huruf mati di Panduan Pengembang.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *
*Jenis*: [DeadLetterConfig](sam-property-function-scheduledeadletterconfig.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-function-schedulev2-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-function-schedulev2-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-function-schedulev2-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-schedule.html#cfn-scheduler-schedule-flexibletimewindow)` properti `AWS::Scheduler::Schedule` sumber daya.

 `GroupName`   <a name="sam-function-schedulev2-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-function-schedulev2-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-function-schedulev2-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-function-schedulev2-name"></a>
Nama jadwal. Jika Anda tidak menentukan nama, AWS SAM buat nama dalam format `Function-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-function-schedulev2-omitname"></a>
Secara default, AWS SAM menghasilkan dan menggunakan nama jadwal dalam format*<Function-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-function-schedulev2-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-function-schedulev2-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-function-schedulev2-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-function-schedulev2-scheduleexpression"></a>
Ekspresi penjadwalan yang menentukan kapan dan seberapa sering acara jadwal penjadwal 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-function-schedulev2-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-function-schedulev2-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-function-schedulev2-state"></a>
Keadaan jadwal Scheduler.  
*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-function-schedulev2--examples"></a>

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

```
Resources:
  Function:
    Properties:
      ...
      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
```

**catatan**  
ID fisik yang dihasilkan dari ScheduleV2 tidak menyertakan nama tumpukan.

# SelfManagedKafka
<a name="sam-property-function-selfmanagedkafka"></a>

Objek yang menggambarkan tipe sumber peristiwa `SelfManagedKafka`. *Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda Apache Kafka yang dikelola sendiri di Panduan](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html) Pengembang.AWS Lambda *

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

Untuk menggunakan Schema Registry, Anda perlu menentukan izin peran IAM tertentu untuk fungsi Anda. Lihat [Penyiapan lengkap dengan peran IAM](sam-property-function-msk.md#sam-property-function-msk-example-complete) untuk contoh konfigurasi yang diperlukan.

## Sintaksis
<a name="sam-property-function-selfmanagedkafka-syntax"></a>

Untuk mendeklarasikan entitas ini di AWS SAM template Anda, gunakan sintaks berikut.

### YAML
<a name="sam-property-function-selfmanagedkafka-syntax.yaml"></a>

```
  [BatchSize](#sam-function-selfmanagedkafka-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-selfmanagedkafka-bisectbatchonfunctionerror): Boolean
  [ConsumerGroupId](#sam-function-selfmanagedkafka-consumergroupid): String
  DestinationConfig: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)
  [Enabled](#sam-function-selfmanagedkafka-enabled): Boolean
  [FilterCriteria](#sam-function-selfmanagedkafka-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [KafkaBootstrapServers](#sam-function-selfmanagedkafka-kafkabootstrapservers): List
  [FunctionResponseTypes](#sam-function-selfmanagedkafka-functionresponsetypes): List
  KmsKeyArn: String
  [LoggingConfig](#sam-function-selfmanagedkafka-loggingconfig): LoggingConfig
  [MaximumRecordAgeInSeconds](#sam-function-selfmanagedkafka-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-selfmanagedkafka-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-selfmanagedkafka-metricsconfig): MetricsConfig
  [ProvisionedPollerConfig](#sam-function-selfmanagedkafka-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [SchemaRegistryConfig](#sam-function-selfmanagedkafka-schemaregistryconfig): [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html)
  [SourceAccessConfigurations](#sam-function-selfmanagedkafka-sourceaccessconfigurations): [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)
  StartingPosition: String
  StartingPositionTimestamp: Double
  [Topics](#sam-function-selfmanagedkafka-topics): List
```

## Sifat-sifat
<a name="sam-property-function-selfmanagedkafka-properties"></a>

 `BatchSize`   <a name="sam-function-selfmanagedkafka-batchsize"></a>
Jumlah maksimum rekaman di setiap batch yang Lambda tarik dari aliran Anda dan dikirim ke fungsi Anda.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 100  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.  
*Minimal*: `1`  
*Maksimum*: `10000`

 `BisectBatchOnFunctionError`   <a name="sam-function-selfmanagedkafka-bisectbatchonfunctionerror"></a>
Jika fungsi mengembalikan kesalahan, bagi batch menjadi dua dan coba lagi.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ConsumerGroupId`   <a name="sam-function-selfmanagedkafka-consumergroupid"></a>
String yang mengonfigurasi bagaimana acara akan dibaca dari topik Kafka.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `DestinationConfig`   <a name="sam-function-selfmanagedkafka-destinationconfig"></a>
Objek konfigurasi yang menentukan tujuan dari peristiwa setelah Lambda memprosesnya.  
Gunakan properti ini untuk menentukan tujuan pemanggilan gagal dari sumber acara Kafka yang dikelola sendiri.  
*Jenis*: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Enabled`   <a name="sam-function-selfmanagedkafka-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-selfmanagedkafka-filtercriteria"></a>
Objek yang mendefinisikan kriteria untuk menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KafkaBootstrapServers`   <a name="sam-function-selfmanagedkafka-kafkabootstrapservers"></a>
Daftar server bootstrap untuk broker Kafka Anda. Sertakan port, misalnya `broker.example.com:xxxx`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `FunctionResponseTypes`   <a name="sam-function-selfmanagedkafka-functionresponsetypes"></a>
Daftar tipe jawaban saat ini yang diterapkan ke pemetaan sumber peristiwa. Untuk informasi selengkapnya, lihat [Melaporkan kegagalan item batch](https://docs.aws.amazon.com/lambda/latest/dg/kafka-retry-configurations.html) di *Panduan Developer AWS Lambda *.  
*Nilai yang valid*: `ReportBatchItemFailures`  
*Tipe*: Daftar  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `KmsKeyArn`   <a name="sam-function-selfmanagedkafka-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `LoggingConfig`   <a name="sam-function-selfmanagedkafka-loggingconfig"></a>
Konfigurasi logging untuk sumber acara Anda.  
*Jenis*: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-loggingconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-selfmanagedkafka-maximumrecordageinseconds"></a>
Periode permintaan maksimum yang dikirimkan Lambda ke fungsi untuk diproses.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MetricsConfig`   <a name="sam-function-selfmanagedkafka-metricsconfig"></a>
Konfigurasi metrik untuk sumber acara Anda.  
*Jenis*: [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-metricsconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumRetryAttempts`   <a name="sam-function-selfmanagedkafka-maximumretryattempts"></a>
Jumlah waktu maksimum untuk mencoba kembali saat fungsi mengembalikan kesalahan.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ProvisionedPollerConfig`   <a name="sam-function-selfmanagedkafka-provisionedpollerconfig"></a>
Konfigurasi untuk meningkatkan jumlah poller yang digunakan untuk menghitung pemetaan sumber peristiwa. Konfigurasi ini memungkinkan minimal 1 poller dan maksimum 2000 poller. Sebagai contoh, lihat [ProvisionedPollerConfig contoh](#sam-property-function-selfmanagedkafka-example-provisionedpollerconfig)  
*Jenis*: [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

`SchemaRegistryConfig`  <a name="sam-function-selfmanagedkafka-schemaregistryconfig"></a>
Konfigurasi untuk menggunakan registri skema dengan sumber acara Kafka yang dikelola sendiri.  
Fitur ini `ProvisionedPollerConfig` perlu dikonfigurasi.
*Jenis*: [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas:* Properti ini diteruskan langsung ke `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `SourceAccessConfigurations`   <a name="sam-function-selfmanagedkafka-sourceaccessconfigurations"></a>
Susunan protokol autentikasi, komponen VPC, atau host virtual untuk mengamankan dan menentukan sumber peristiwa Anda.  
*Nilai yang valid*: `BASIC_AUTH | CLIENT_CERTIFICATE_TLS_AUTH | SASL_SCRAM_256_AUTH | SASL_SCRAM_512_AUTH | SERVER_ROOT_CA_CERTIFICATE`  
*Jenis*: Daftar [SourceAccessConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration)  
*Wajib*: Ya  
*CloudFormation kompatibilitas:* Properti ini adalah bagian dari `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPosition`   <a name="sam-function-selfmanagedkafka-startingposition"></a>
Posisi dalam pengaliran tempat untuk mulai membaca.  
+ `AT_TIMESTAMP`— Tentukan waktu untuk mulai membaca catatan.
+ `LATEST`— Baca hanya catatan baru.
+ `TRIM_HORIZON`— Memproses semua catatan yang tersedia.
*Nilai yang valid*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `StartingPositionTimestamp`   <a name="sam-function-selfmanagedkafka-startingpositiontimestamp"></a>
Waktu untuk mulai membaca, dalam detik waktu Unix. Tentukan `StartingPositionTimestamp` kapan `StartingPosition` ditentukan sebagai`AT_TIMESTAMP`.  
*Tipe*: Ganda  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Topics`   <a name="sam-function-selfmanagedkafka-topics"></a>
Nama topik Kafka.  
*Tipe*: Daftar  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Topics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-selfmanagedkafka--examples"></a>

### Pengaturan lengkap dengan peran IAM
<a name="sam-property-function-selfmanagedkafka-example-complete"></a>

Contoh berikut menunjukkan penyiapan lengkap termasuk konfigurasi peran IAM yang diperlukan untuk menggunakan Schema Registry:

```
Parameters:
  PreCreatedSubnetOne:
    Type: String
  PreCreatedSubnetTwo:
    Type: String

Resources:
  MyLambdaExecutionRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17		 	 	 '
        Statement:
        - Action: [sts:AssumeRole]
          Effect: Allow
          Principal:
            Service: [lambda.amazonaws.com]
      Policies:
      - PolicyName: KafkaAuthPolicy
        PolicyDocument:
          Statement:
          - Action: [secretsmanager:GetSecretValue, kms:Decrypt]
            Effect: "Allow"
            Resource: ['arn:aws:secretsmanager:us-west-2:123456789012:secret:kafkaSecret-******',
                        'arn:aws:kms:us-west-2:123456789012:key/keyId']
      - PolicyName: ENIPolicy
        PolicyDocument:
          Statement:
          - Action: [ec2:CreateNetworkInterface,
              ec2:DescribeNetworkInterfaces, ec2:DescribeVpcs, ec2:DeleteNetworkInterface,
              ec2:DescribeSubnets, ec2:DescribeSecurityGroups]
            Effect: Allow
            Resource: '*'
      - PolicyName: SchemaRegistryPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetRegistry]
            Effect: Allow
            Resource: 'arn:aws:glue:{region}:{account-id}:registry/{registry-name}'
      - PolicyName: SchemaVersionsPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetSchemaVersions]
            Effect: Allow
            Resource: '*'
      ManagedPolicyArns:
      - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
      Tags:
      - {Value: SAM, Key: lambda:createdBy}

  MyKafkaProcessor:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: nodejs18.x
      Handler: index.handler
      CodeUri: ${codeuri}
      Role:
        Fn::GetAtt: [MyLambdaExecutionRole, Arn]
      Events:
        SelfManagedKafkaEvent:
          Type: SelfManagedKafka
          Properties:
            KafkaBootstrapServers:
              - my-kafka-broker-1:9092
              - my-kafka-broker-2:9092
            Topics:
              - SchemaRegistryTestTopic
            StartingPosition: LATEST
            SourceAccessConfigurations:
              - Type: VPC_SUBNET
                URI: subnet:subnet-12345678
              - Type: VPC_SECURITY_GROUP
                URI: security_group:sg-12345678
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
            ProvisionedPollerConfig:
              MinimumPollers: 1
            SchemaRegistryConfig:
              AccessConfigs:
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
              SchemaValidationConfigs:
              - Attribute: KEY
              EventRecordFormat: JSON
              SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
```

### ProvisionedPollerConfig contoh
<a name="sam-property-function-selfmanagedkafka-example-provisionedpollerconfig"></a>

```
ProvisionedPollerConfig:
  MinimumPollers: 1
  MaximumPollers: 200
```

### Sumber acara Kafka yang dikelola sendiri
<a name="sam-property-function-selfmanagedkafka--examples--self-managed-kafka-event-source"></a>

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

#### YAML
<a name="sam-property-function-selfmanagedkafka--examples--self-managed-kafka-event-source--yaml"></a>

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      BatchSize: 1000
      Enabled: true
      KafkaBootstrapServers:
        - abc.xyz.com:xxxx
      SourceAccessConfigurations:
        -  Type: BASIC_AUTH
           URI: arn:aws:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
      Topics:
        - MyKafkaTopic
```

### Sumber Acara Kafka yang dikelola sendiri dengan AWS Glue Schema Registry
<a name="sam-property-function-selfmanagedkafka-example-schemaregistry"></a>

Berikut ini adalah contoh dari jenis sumber `SelfManagedKafka` peristiwa dikonfigurasi dengan AWS Glue Schema Registry.

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      KafkaBootstrapServers:
        - abc.xyz.com:9092
      Topics:
        - SchemaRegistryTestTopic
      StartingPosition: LATEST
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
      SourceAccessConfigurations:
        - Type: VPC_SUBNET
          URI: subnet:subnet-12345678
        - Type: VPC_SECURITY_GROUP
          URI: security_group:sg-12345678
```

### Sumber Acara Kafka yang dikelola sendiri dengan Registri Skema Konfluen
<a name="sam-property-function-selfmanagedkafka-example-schemaregistry-confluent"></a>

Berikut ini adalah contoh dari jenis sumber `SelfManagedKafka` peristiwa dikonfigurasi dengan Confluent Schema Registry.

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      KafkaBootstrapServers:
        - abc.xyz.com:9092
      Topics:
        - SchemaRegistryTestTopic
      StartingPosition: LATEST
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: https://my-schema-registry.confluent.cloud
        AccessConfigs:
          - Type: BASIC_AUTH
            URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-secret
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
      SourceAccessConfigurations:
        - Type: VPC_SUBNET
          URI: subnet:subnet-12345678
        - Type: VPC_SECURITY_GROUP
          URI: security_group:sg-12345678
        - Type: BASIC_AUTH
          URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:kafka-secret
```

# SNS
<a name="sam-property-function-sns"></a>

Objek yang menggambarkan tipe sumber peristiwa `SNS`.

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

## Sintaksis
<a name="sam-property-function-sns-syntax"></a>

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

### YAML
<a name="sam-property-function-sns-syntax.yaml"></a>

```
  [FilterPolicy](#sam-function-sns-filterpolicy): [SnsFilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)
  FilterPolicyScope: String
  RedrivePolicy: Json
  [Region](#sam-function-sns-region): String
  [SqsSubscription](#sam-function-sns-sqssubscription): Boolean | SqsSubscriptionObject
  [Topic](#sam-function-sns-topic): String
```

## Sifat-sifat
<a name="sam-property-function-sns-properties"></a>

 `FilterPolicy`   <a name="sam-function-sns-filterpolicy"></a>
Kebijakan filter JSON yang ditetapkan untuk langganan. Untuk informasi selengkapnya, lihat [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)di Referensi API Layanan Pemberitahuan Sederhana Amazon.  
*Jenis*: [SnsFilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)` properti `AWS::SNS::Subscription` sumber daya.

 `FilterPolicyScope`   <a name="sam-function-sns-filterpolicyscope"></a>
Atribut ini memungkinkan Anda memilih lingkup penyaringan dengan menggunakan salah satu jenis nilai string berikut:  
+ `MessageAttributes`— Filter diterapkan pada atribut pesan.
+ `MessageBody`— Filter diterapkan pada badan pesan.
*Tipe*: String  
*Wajib*: Tidak  
*Default*: `MessageAttributes`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke ` [ FilterPolicyScope](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope)` properti `AWS::SNS::Subscription` sumber daya.

 `RedrivePolicy`   <a name="sam-function-sns-redrivepolicy"></a>
Bila ditentukan, kirim pesan yang tidak terkirim ke antrean surat mati Amazon SQS yang ditentukan. Pesan yang tidak dapat dikirim karena kesalahan klien (misalnya, ketika titik akhir berlangganan tidak terjangkau) atau kesalahan server (misalnya, ketika layanan yang mendorong titik akhir langganan menjadi tidak tersedia) diadakan di antrean surat mati untuk analisis lebih lanjut atau pemrosesan ulang.  
*Untuk informasi selengkapnya tentang kebijakan redrive dan antrian surat mati, lihat antrian surat [mati Amazon SQS di Panduan Pengembang Layanan Antrian](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) Sederhana Amazon.*  
*Jenis*: Json  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ RedrivePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy)` properti `AWS::SNS::Subscription` sumber daya.

 `Region`   <a name="sam-function-sns-region"></a>
Untuk langganan lintas region, region tempat topik berada.  
Jika tidak ada wilayah yang ditentukan, CloudFormation gunakan wilayah pemanggil sebagai default.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region)` properti `AWS::SNS::Subscription` sumber daya.

 `SqsSubscription`   <a name="sam-function-sns-sqssubscription"></a>
Atur properti ini menjadi BETUL, atau tentukan `SqsSubscriptionObject` untuk mengaktifkan batching notifikasi topik SNS dalam antrean SQS. Mengatur properti ini menjadi `true` membuat antrean SQS baru, sedangkan menentukan `SqsSubscriptionObject` menggunakan antrean SQS yang ada.  
*Jenis*: Boolean \$1 [SqsSubscriptionObject](sam-property-function-sqssubscriptionobject.md)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Topic`   <a name="sam-function-sns-topic"></a>
ARN dari topik untuk dilanggan.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[TopicArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn)` properti `AWS::SNS::Subscription` sumber daya.

## Contoh
<a name="sam-property-function-sns--examples"></a>

### Contoh Sumber Peristiwa SNS
<a name="sam-property-function-sns--examples--sns-event-source-example"></a>

Contoh Sumber Peristiwa SNS

#### YAML
<a name="sam-property-function-sns--examples--sns-event-source-example--yaml"></a>

```
Events:
  SNSEvent:
    Type: SNS
    Properties:
      Topic: arn:aws:sns:us-east-1:123456789012:my_topic
      SqsSubscription: true
      FilterPolicy:
        store:
          - example_corp
        price_usd:
          - numeric:
              - ">="
              - 100
```

# SqsSubscriptionObject
<a name="sam-property-function-sqssubscriptionobject"></a>

Tentukan opsi antrean SQS yang ada untuk peristiwa SNS

## Sintaksis
<a name="sam-property-function-sqssubscriptionobject-syntax"></a>

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

### YAML
<a name="sam-property-function-sqssubscriptionobject-syntax.yaml"></a>

```
  [BatchSize](#sam-function-sqssubscriptionobject-batchsize): String
  [Enabled](#sam-function-sqssubscriptionobject-enabled): Boolean
  [QueueArn](#sam-function-sqssubscriptionobject-queuearn): String
  [QueuePolicyLogicalId](#sam-function-sqssubscriptionobject-queuepolicylogicalid): String
  [QueueUrl](#sam-function-sqssubscriptionobject-queueurl): String
```

## Sifat-sifat
<a name="sam-property-function-sqssubscriptionobject-properties"></a>

 `BatchSize`   <a name="sam-function-sqssubscriptionobject-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch untuk antrean SQS.  
*Tipe*: String  
*Wajib*: Tidak  
*Default*: 10  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `Enabled`   <a name="sam-function-sqssubscriptionobject-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa SQS untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*Default*: BETUL  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `QueueArn`   <a name="sam-function-sqssubscriptionobject-queuearn"></a>
Tentukan arn antrean SQS yang ada.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `QueuePolicyLogicalId`   <a name="sam-function-sqssubscriptionobject-queuepolicylogicalid"></a>
Berikan nama LogicaLid kustom untuk sumber daya. [AWS::SQS::QueuePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html)  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

 `QueueUrl`   <a name="sam-function-sqssubscriptionobject-queueurl"></a>
Tentukan URL antrean yang terkait dengan properti `QueueArn`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

## Contoh
<a name="sam-property-function-sqssubscriptionobject--examples"></a>

### SQS yang ada untuk peristiwa SNS
<a name="sam-property-function-sqssubscriptionobject--examples--existing-sqs-for-sns-event"></a>

Contoh untuk menambahkan antrean SQS yang ada untuk melanggan topik SNS.

#### YAML
<a name="sam-property-function-sqssubscriptionobject--examples--existing-sqs-for-sns-event--yaml"></a>

```
QueuePolicyLogicalId: CustomQueuePolicyLogicalId
QueueArn:
  Fn::GetAtt: MyCustomQueue.Arn
QueueUrl:
  Ref: MyCustomQueue
BatchSize: 5
```

# SQS
<a name="sam-property-function-sqs"></a>

Objek yang menggambarkan tipe sumber peristiwa `SQS`. Untuk informasi selengkapnya, lihat [Menggunakan AWS Lambda Amazon SQS di Panduan AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html) *Pengembang*.

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

## Sintaksis
<a name="sam-property-function-sqs-syntax"></a>

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

### YAML
<a name="sam-property-function-sqs-syntax.yaml"></a>

```
  [BatchSize](#sam-function-sqs-batchsize): Integer
  [Enabled](#sam-function-sqs-enabled): Boolean
  [FilterCriteria](#sam-function-sqs-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-sqs-functionresponsetypes): List
  KmsKeyArn: String
  [MaximumBatchingWindowInSeconds](#sam-function-sqs-maximumbatchingwindowinseconds): Integer
  [MetricsConfig](#sam-function-sqs-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ProvisionedPollerConfig](#sam-function-sqs-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [Queue](#sam-function-sqs-queue): String
  ScalingConfig: [ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)
```

## Sifat-sifat
<a name="sam-property-function-sqs-properties"></a>

 `BatchSize`   <a name="sam-function-sqs-batchsize"></a>
Jumlah maksimum item yang akan diambil dalam satu batch.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: 10  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` properti `AWS::Lambda::EventSourceMapping` sumber daya.  
*Minimal*: `1`  
*Maksimum*: `10000`

 `Enabled`   <a name="sam-function-sqs-enabled"></a>
Menonaktifkan pemetaan sumber peristiwa untuk menjeda polling dan pemanggilan.  
*Tipe*: Boolean  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FilterCriteria`   <a name="sam-function-sqs-filtercriteria"></a>
Objek yang mendefinisikan kriteria untuk menentukan apakah Lambda harus memproses suatu peristiwa. Untuk informasi selengkapnya, lihat [pemfilteran AWS Lambda acara](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) di *Panduan AWS Lambda Pengembang*.  
*Jenis*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `FunctionResponseTypes`   <a name="sam-function-sqs-functionresponsetypes"></a>
 Daftar tipe jawaban saat ini yang diterapkan ke pemetaan sumber peristiwa. Untuk informasi selengkapnya, lihat [Melaporkan kegagalan item batch](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting) di *Panduan AWS Lambda Pengembang*.   
 *Nilai yang valid*: `ReportBatchItemFailures`   
 *Tipe*: Daftar   
 *Wajib*: Tidak   
 *CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` properti `AWS::Lambda::EventSourceMapping` sumber daya. 

 `KmsKeyArn`   <a name="sam-function-sqs-kmskeyarn"></a>
Nama Sumber Daya Amazon (ARN) dari kunci untuk mengenkripsi informasi yang terkait dengan acara ini.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-sqs-maximumbatchingwindowinseconds"></a>
Jumlah waktu maksimum untuk mengumpulkan catatan sebelum memanggil fungsi, dalam hitungan detik.  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `MetricsConfig`   <a name="sam-function-sqs-metricsconfig"></a>
Konfigurasi keikutsertaan untuk mendapatkan metrik yang disempurnakan untuk pemetaan sumber peristiwa yang menangkap setiap tahap pemrosesan. Sebagai contoh, lihat [MetricsConfig acara](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent).  
*Jenis*: [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ProvisionedPollerConfig`   <a name="sam-function-sqs-provisionedpollerconfig"></a>
Konfigurasi untuk meningkatkan jumlah poller yang digunakan untuk menghitung pemetaan sumber peristiwa. Konfigurasi ini memungkinkan minimal 2 poller dan maksimum 2000 poller. Sebagai contoh, lihat[ProvisionedPollerConfig contoh](#sam-property-function-sqs-example-provisionedpollerconfig).  
*Jenis*: [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `Queue`   <a name="sam-function-sqs-queue"></a>
ARN antrean.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

 `ScalingConfig`   <a name="sam-function-sqs-scalingconfig"></a>
Konfigurasi penskalaan poller SQS untuk mengontrol laju pemanggilan dan menetapkan pemanggilan bersamaan maksimum.  
*Jenis*: `[ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)`  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)` properti `AWS::Lambda::EventSourceMapping` sumber daya.

## Contoh
<a name="sam-property-function-sqs--examples"></a>

### MetricsConfig acara
<a name="sam-property-function-sqs-example-metricsconfigevent"></a>

Berikut ini adalah contoh sumber daya yang menggunakan `MetricsConfig` properti untuk menangkap setiap tahap pemrosesan untuk pemetaan sumber peristiwa mereka.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Acara SQS dasar
<a name="sam-property-function-sqs--examples--sqs-event"></a>

```
Events:
  SQSEvent:
    Type: SQS
    Properties:
      Queue: arn:aws:sqs:us-west-2:012345678901:my-queue
      BatchSize: 10
      Enabled: false
      FilterCriteria:
        Filters:
          - Pattern: '{"key": ["val1", "val2"]}'
```

### Konfigurasikan pelaporan batch sebagian untuk antrian SQS Anda
<a name="sam-property-function-sqs--examples--sqs-partial-batch"></a>

```
Events:
  SQSEvent:
    Type: SQS
    Properties:
      Enabled: true
      FunctionResponseTypes:
        - ReportBatchItemFailures
      Queue: !GetAtt MySqsQueue.Arn
      BatchSize: 10
```

### Fungsi Lambda dengan acara SQS yang telah dikonfigurasi penskalaan
<a name="sam-property-function-sqs--examples--sqs-event-scaling"></a>

```
MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    ...
    Events:
      MySQSEvent:
        Type: SQS
        Properties:
          ...
          ScalingConfig:
            MaximumConcurrency: 10
```

### ProvisionedPollerConfig contoh
<a name="sam-property-function-sqs-example-provisionedpollerconfig"></a>

```
MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    Handler: index.handler
    Runtime: nodejs18.x
    Timeout: 30
    Events:
      SQSEvent:
        Type: SQS
        Properties:
          Queue: !GetAtt MyQueue.Arn
          BatchSize: 10
          Enabled: True
          ProvisionedPollerConfig:
            MaximumPollers: 300
            MinimumPollers: 10
```

# FunctionCode
<a name="sam-property-function-functioncode"></a>

[Paket deployment](https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html) untuk fungsi Lambda.

## Sintaksis
<a name="sam-property-function-functioncode-syntax"></a>

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

### YAML
<a name="sam-property-function-functioncode-syntax.yaml"></a>

```
  [Bucket](#sam-function-functioncode-bucket): String
  [Key](#sam-function-functioncode-key): String
  [Version](#sam-function-functioncode-version): String
```

## Sifat-sifat
<a name="sam-property-function-functioncode-properties"></a>

 `Bucket`   <a name="sam-function-functioncode-bucket"></a>
Bucket Amazon S3 di AWS Wilayah yang sama dengan fungsi Anda.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[S3Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket)` properti tipe `AWS::Lambda::Function` `Code` data.

 `Key`   <a name="sam-function-functioncode-key"></a>
Kunci Amazon S3 dari paket deployment.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[S3Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3key)` properti tipe `AWS::Lambda::Function` `Code` data.

 `Version`   <a name="sam-function-functioncode-version"></a>
Untuk objek berversi, versi objek paket deployment yang digunakan.  
*Tipe*: String  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[S3ObjectVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion)` properti tipe `AWS::Lambda::Function` `Code` data.

## Contoh
<a name="sam-property-function-functioncode--examples"></a>

### FunctionCode
<a name="sam-property-function-functioncode--examples--functioncode"></a>

`CodeUri`: Contoh Kode Fungsi

#### YAML
<a name="sam-property-function-functioncode--examples--functioncode--yaml"></a>

```
CodeUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```

# FunctionUrlConfig
<a name="sam-property-function-functionurlconfig"></a>

Membuat URL AWS Lambda fungsi dengan parameter konfigurasi yang ditentukan. URL fungsi Lambda adalah titik akhir HTTPS yang dapat Anda gunakan untuk menjalankan fungsi Anda.

Secara default, URL fungsi yang Anda buat menggunakan `$LATEST` versi fungsi Lambda Anda. Jika Anda menentukan `AutoPublishAlias` untuk fungsi Lambda Anda, titik akhir terhubung ke alias fungsi yang ditentukan.

Untuk informasi selengkapnya, lihat [fungsi Lambda URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) di Panduan *AWS Lambda Pengembang*.

## Sintaksis
<a name="sam-property-function-functionurlconfig-syntax"></a>

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

### YAML
<a name="sam-property-function-functionurlconfig-syntax.yaml"></a>

```
[AuthType](#sam-function-functionurlconfig-authtype): String
[Cors](#sam-function-functionurlconfig-cors): [Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)
[InvokeMode](#sam-function-functionurlconfig-invokemode): String
```

## Sifat-sifat
<a name="sam-property-function-functionurlconfig-properties"></a>

 `AuthType`   <a name="sam-function-functionurlconfig-authtype"></a>
Jenis otorisasi untuk URL fungsi Anda. Untuk menggunakan AWS Identity and Access Management (IAM) untuk mengotorisasi permintaan, setel ke. `AWS_IAM` Untuk akses terbuka, atur ke`NONE`.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[AuthType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype)` properti `AWS::Lambda::Url` sumber daya.

 `Cors`   <a name="sam-function-functionurlconfig-cors"></a>
Pengaturan berbagi sumber daya lintas asal (CORS) untuk URL fungsi Anda.  
*Jenis*: [Cor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)` properti `AWS::Lambda::Url` sumber daya.

 `InvokeMode`  <a name="sam-function-functionurlconfig-invokemode"></a>
Mode URL fungsi Anda akan dipanggil. Agar fungsi Anda mengembalikan respons setelah pemanggilan selesai, setel ke. `BUFFERED` Agar fungsi Anda mengalirkan respons, setel ke`RESPONSE_STREAM`. Nilai default-nya adalah `BUFFERED`.  
*Nilai yang valid*: `BUFFERED` atau `RESPONSE_STREAM`  
*Tipe*: String  
*Wajib*: Tidak  
*AWS CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode)properti `AWS::Lambda::Url` sumber daya.

## Contoh
<a name="sam-property-function-functionurlconfig--examples"></a>

### URL fungsi
<a name="sam-property-function-functionurlconfig--examples--function-url"></a>

Contoh berikut membuat fungsi Lambda dengan URL fungsi. URL fungsi menggunakan otorisasi IAM.

#### YAML
<a name="sam-property-function-functionurlconfig--examples--function-url--yaml"></a>

```
HelloWorldFunction:
  Type: AWS::Serverless::Function
  Properties:
    CodeUri: hello_world/
    Handler: index.handler
    Runtime: nodejs20.x
    FunctionUrlConfig:
      AuthType: AWS_IAM
      InvokeMode: RESPONSE_STREAM

Outputs:
  MyFunctionUrlEndpoint:
      Description: "My Lambda Function URL Endpoint"
      Value:
        Fn::GetAtt: HelloWorldFunctionUrl.FunctionUrl
```

# CapacityProviderConfig
<a name="sam-property-function-capacityproviderconfig"></a>

Mengkonfigurasi penyedia kapasitas tempat versi fungsi yang diterbitkan akan dilampirkan. Ini memungkinkan fungsi berjalan pada EC2 instance milik pelanggan yang dikelola oleh Lambda.

**catatan**  
Konfigurasi ini menentukan jenis komputasi fungsi dan perlu ditentukan selama penerapan fungsi pertama. Itu tidak dapat ditambahkan atau dihapus setelah sumber daya fungsi dibuat.

## Sintaksis
<a name="sam-property-function-capacityproviderconfig-syntax"></a>

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

### YAML
<a name="sam-property-function-capacityproviderconfig-syntax.yaml"></a>

```
[Arn](#sam-function-capacityproviderconfig-arn): String
[ExecutionEnvironmentMemoryGiBPerVCpu](#sam-function-capacityproviderconfig-executionenvironmentmemorygibpervcpu): Float
[PerExecutionEnvironmentMaxConcurrency](#sam-function-capacityproviderconfig-perexecutionenvironmentmaxconcurrency): Integer
```

## Sifat-sifat
<a name="sam-property-function-capacityproviderconfig-properties"></a>

 `Arn`   <a name="sam-function-capacityproviderconfig-arn"></a>
ARN dari penyedia kapasitas untuk digunakan untuk fungsi ini.  
*Tipe*: String  
*Wajib*: Ya  
*CloudFormation kompatibilitas*: Properti ini unik untuk SAM.

 `ExecutionEnvironmentMemoryGiBPerVCpu`   <a name="sam-function-capacityproviderconfig-executionenvironmentmemorygibpervcpu"></a>
Rasio memori (dalam GiB) ke vCPU untuk setiap lingkungan eksekusi.  
Rasio memori per CPU tidak dapat melebihi memori total fungsi 2048MB. memory-to-CPURasio yang didukung adalah 2GB, 4GB, atau 8GB per CPU.
*Jenis*: Mengapung  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[ExecutionEnvironmentMemoryGiBPerVCpu](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-lambdamanagedinstancescapacityproviderconfig)` properti `AWS::Lambda::Function` sumber daya.

 `PerExecutionEnvironmentMaxConcurrency`   <a name="sam-function-capacityproviderconfig-perexecutionenvironmentmaxconcurrency"></a>
Jumlah maksimum eksekusi bersamaan per lingkungan eksekusi (sandbox).  
*Tipe*: Integer  
*Wajib*: Tidak  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[PerExecutionEnvironmentMaxConcurrency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-lambdamanagedinstancescapacityproviderconfig)` properti `AWS::Lambda::Function` sumber daya.

## Contoh
<a name="sam-property-function-capacityproviderconfig-examples"></a>

### Konfigurasi penyedia kapasitas
<a name="sam-property-function-capacityproviderconfig-examples-basic"></a>

Contoh berikut menunjukkan konfigurasi penyedia kapasitas yang mereferensikan sumber daya penyedia kapasitas.

```
CapacityProviderConfig:
  Arn: !GetAtt MyCapacityProvider.Arn
  ExecutionEnvironmentMemoryGiBPerVCpu: 4.0
  PerExecutionEnvironmentMaxConcurrency: 100
```

# FunctionScalingConfig
<a name="sam-property-function-functionscalingconfig"></a>

Mengonfigurasi perilaku penskalaan untuk versi fungsi Lambda, mengontrol jumlah lingkungan eksekusi (kotak pasir) yang dapat dibuat. Konfigurasi ini berlaku untuk versi fungsi \$1LATEST.PUBLISED dan numerik.

## Sintaksis
<a name="sam-property-function-functionscalingconfig-syntax"></a>

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

### YAML
<a name="sam-property-function-functionscalingconfig-syntax.yaml"></a>

```
[MinExecutionEnvironments](#sam-function-functionscalingconfig-minexecutionenvironments): Integer
[MaxExecutionEnvironments](#sam-function-functionscalingconfig-maxexecutionenvironments): Integer
```

## Sifat-sifat
<a name="sam-property-function-functionscalingconfig-properties"></a>

 `MinExecutionEnvironments`   <a name="sam-function-functionscalingconfig-minexecutionenvironments"></a>
Jumlah minimum lingkungan eksekusi yang harus dipertahankan untuk versi fungsi.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: `3`  
*Minimal*: `0`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MinExecutionEnvironments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig-minexecutionenvironments)` properti `AWS::Lambda::Function` sumber daya.

 `MaxExecutionEnvironments`   <a name="sam-function-functionscalingconfig-maxexecutionenvironments"></a>
Jumlah maksimum lingkungan eksekusi yang dapat dibuat untuk versi fungsi.  
*Tipe*: Integer  
*Wajib*: Tidak  
*Default*: `3`  
*Minimal*: `0`  
*CloudFormation kompatibilitas*: Properti ini diteruskan langsung ke `[MaxExecutionEnvironments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig-maxexecutionenvironments)` properti `AWS::Lambda::Function` sumber daya.

## Contoh
<a name="sam-property-function-functionscalingconfig-examples"></a>

### Konfigurasi penskalaan fungsi
<a name="sam-property-function-functionscalingconfig-examples-basic"></a>

Contoh berikut menunjukkan konfigurasi penskalaan fungsi dengan lingkungan eksekusi minimum dan maksimum.

```
FunctionScalingConfig:
  MinExecutionEnvironments: 5
  MaxExecutionEnvironments: 100
```