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

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