

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

# Referensi API pengelolaan cluster, instans, dan sumber daya Amazon DocumentDB
<a name="api-reference"></a>

Bagian ini menjelaskan operasi pengelolaan klaster, instance, dan sumber daya untuk Amazon DocumentDB (dengan kompatibilitas MongoDB) yang dapat diakses melalui HTTP, (), AWS Command Line Interface atau SDK.AWS CLI AWS Anda dapat menggunakan ini APIs untuk membuat, menghapus, dan memodifikasi cluster dan instance.

 

**penting**  
Ini hanya APIs digunakan untuk mengelola cluster, instance, dan sumber daya terkait. Untuk informasi tentang cara menghubungkan ke klaster Amazon DocumentDB yang sedang berjalan, lihat [Panduan memulai](get-started-guide.md).

**Topics**
+ [Tindakan](API_Operations.md)
+ [Tipe Data](API_Types.md)
+ [Kesalahan Umum](CommonErrors.md)
+ [Parameter Umum](CommonParameters.md)

# Tindakan
<a name="API_Operations"></a>

Tindakan berikut didukung oleh Amazon DocumentDB (with MongoDB compatibility):
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 

Tindakan berikut didukung oleh Amazon DocumentDB Elastic Clusters:
+  [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) 
+  [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) 
+  [CreateCluster](API_elastic_CreateCluster.md) 
+  [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) 
+  [DeleteCluster](API_elastic_DeleteCluster.md) 
+  [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) 
+  [GetCluster](API_elastic_GetCluster.md) 
+  [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) 
+  [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) 
+  [ListClusters](API_elastic_ListClusters.md) 
+  [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) 
+  [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) 
+  [ListTagsForResource](API_elastic_ListTagsForResource.md) 
+  [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) 
+  [StartCluster](API_elastic_StartCluster.md) 
+  [StopCluster](API_elastic_StopCluster.md) 
+  [TagResource](API_elastic_TagResource.md) 
+  [UntagResource](API_elastic_UntagResource.md) 
+  [UpdateCluster](API_elastic_UpdateCluster.md) 

# Amazon DocumentDB (with MongoDB compatibility)
<a name="API_Operations_Amazon_DocumentDB_with_MongoDB_compatibility"></a>

Tindakan berikut didukung oleh Amazon DocumentDB (with MongoDB compatibility):
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 

# AddSourceIdentifierToSubscription
<a name="API_AddSourceIdentifierToSubscription"></a>

Menambahkan pengidentifikasi sumber ke langganan notifikasi peristiwa yang ada.

## Parameter Permintaan
<a name="API_AddSourceIdentifierToSubscription_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** SourceIdentifier **   
Pengidentifikasi sumber peristiwa yang akan ditambahkan:  
+ Jika jenis sumber adalah sebuah instans, `DBInstanceIdentifier` harus disediakan.
+ Jika jenis sumber adalah sebuah grup keamanan, `DBSecurityGroupName` harus disediakan.
+ Jika jenis sumber adalah sebuah grup parameter, `DBParameterGroupName` harus disediakan.
+ Jika jenis sumber adalah sebuah snapshot, `DBSnapshotIdentifier` harus disediakan.
Tipe: String  
Diperlukan: Ya

 ** SubscriptionName **   
Nama langganan notifikasi peristiwa Amazon DocumentDB yang ingin Anda tambahkan pengidentifikasi sumbernya.  
Tipe: String  
Diperlukan: Ya

## Elemen Respons
<a name="API_AddSourceIdentifierToSubscription_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** EventSubscription **   
Informasi mendetail tentang peristiwa yang telah Anda langgani.  
Tipe: Objek [EventSubscription](API_EventSubscription.md)

## Kesalahan
<a name="API_AddSourceIdentifierToSubscription_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** SourceNotFound **   
Sumber yang diminta tidak dapat ditemukan.   
Kode Status HTTP: 404

 ** SubscriptionNotFound **   
Nama langganan tidak ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_AddSourceIdentifierToSubscription_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 

# AddTagsToResource
<a name="API_AddTagsToResource"></a>

Menambahkan tag metadata ke sumber daya Amazon DocumentDB. Anda dapat menggunakan tag ini dengan pelaporan alokasi biaya untuk melacak biaya yang terkait dengan sumber daya Amazon DocumentDB atau `Condition` dalam pernyataan AWS Identity and Access Management dalam kebijakan (IAM) untuk Amazon DocumentDB.

## Parameter Permintaan
<a name="API_AddTagsToResource_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** ResourceName **   
Sumber daya Amazon DocumentDB tempat tag ditambahkan. Nilai ini adalah Nama Sumber Daya Amazon.  
Tipe: String  
Diperlukan: Ya

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke sumber daya Amazon DocumentDB.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Ya

## Kesalahan
<a name="API_AddTagsToResource_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` tidak mengacu ke sebuah instans yang ada.   
Kode Status HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` tidak mengacu ke sebuah snapshot yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_AddTagsToResource_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddTagsToResource) 

# ApplyPendingMaintenanceAction
<a name="API_ApplyPendingMaintenanceAction"></a>

Menerapkan tindakan pemeliharaan tertunda ke sumber daya (misalnya, ke instans Amazon DocumentDB).

## Parameter Permintaan
<a name="API_ApplyPendingMaintenanceAction_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** ApplyAction **   
Tindakan pemeliharaan tertunda untuk diterapkan ke sumber daya ini.  
Nilai valid: `system-update`, `db-upgrade`   
Tipe: String  
Diperlukan: Ya

 ** OptInType **   
Nilai yang menentukan jenis permintaan opt-in atau membatalkan permintaan opt-in. Permintaan opt-in dari jenis `immediate` tidak dapat dibatalkan.  
Nilai valid:  
+  `immediate` - Terapkan tindakan pemeliharaan segera.
+  `next-maintenance` - Terapkan tindakan pemeliharaan selama jendela pemeliharaan berikutnya untuk sumber daya. 
+  `undo-opt-in` - Batalkan permintaan opt-in `next-maintenance` apa pun yang ada.
Tipe: String  
Diperlukan: Ya

 ** ResourceIdentifier **   
Amazon Resource Name (ARN) dari sumber daya tempat tindakan pemeliharaan tertunda diterapkan.  
Tipe: String  
Diperlukan: Ya

## Elemen Respons
<a name="API_ApplyPendingMaintenanceAction_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** ResourcePendingMaintenanceActions **   
Merupakan output dari [ApplyPendingMaintenanceAction](#API_ApplyPendingMaintenanceAction).   
Tipe: Objek [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)

## Kesalahan
<a name="API_ApplyPendingMaintenanceAction_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidDBInstanceState **   
 Instans yang ditentukan tidak dalam status *tersedia*.   
Kode Status HTTP: 400

 ** ResourceNotFoundFault **   
ID sumber daya yang ditentukan tidak ditemukan.  
Kode Status HTTP: 404

## Lihat Juga
<a name="API_ApplyPendingMaintenanceAction_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 

# CopyDBClusterParameterGroup
<a name="API_CopyDBClusterParameterGroup"></a>

Salinan grup parameter klaster tertentu.

## Parameter Permintaan
<a name="API_CopyDBClusterParameterGroup_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** SourceDBClusterParameterGroupIdentifier **   
Pengidentifikasi atau Amazon Resource Name (ARN) untuk grup parameter klaster sumber.  
Batas:  
+ Harus menentukan grup parameter klaster yang valid.
+ Jika kelompok parameter cluster sumber Wilayah AWS sama dengan salinan, tentukan pengidentifikasi grup parameter yang valid; misalnya,`my-db-cluster-param-group`, atau ARN yang valid.
+ Jika kelompok parameter sumber berbeda Wilayah AWS dari salinan, tentukan grup parameter cluster yang valid ARN; misalnya,. `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`
Tipe: String  
Diperlukan: Ya

 ** TargetDBClusterParameterGroupDescription **   
Deskripsi untuk grup parameter klaster yang disalin.  
Tipe: String  
Diperlukan: Ya

 ** TargetDBClusterParameterGroupIdentifier **   
Pengidentifikasi untuk grup parameter klaster yang disalin.  
Batas:  
+ Tidak dapat berupa null, kosong, atau blank.
+ Harus berisi 1 sampai 255 huruf, angka, atau tanda hubung. 
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut. 
Contoh: `my-cluster-param-group1`   
Tipe: String  
Diperlukan: Ya

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke grup parameter.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

## Elemen Respons
<a name="API_CopyDBClusterParameterGroup_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBClusterParameterGroup **   
Informasi mendetail tentang grup parameter klaster.   
Tipe: Objek [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

## Kesalahan
<a name="API_CopyDBClusterParameterGroup_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBParameterGroupAlreadyExists **   
Grup parameter dengan nama yang sama sudah ada.  
Kode Status HTTP: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` tidak mengacu ke grup parameter yang ada.   
Kode Status HTTP: 404

 ** DBParameterGroupQuotaExceeded **   
Permintaan ini akan menyebabkan Anda melebihi jumlah grup parameter yang diizinkan.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_CopyDBClusterParameterGroup_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 

# CopyDBClusterSnapshot
<a name="API_CopyDBClusterSnapshot"></a>

Salinan sebuah snapshot dari sebuah klaster.

Untuk menyalin snapshot klaster dari snapshot klaster manual bersama, `SourceDBClusterSnapshotIdentifier` harus menjadi Amazon Resource Name (ARN) dari snapshot klaster bersama. Anda hanya dapat menyalin snapshot klaster DB bersama, baik dienkripsi atau tidak, di Wilayah AWS yang sama.

Untuk membatalkan operasi penyalinan setelah ia berlangsung, hapus snapshot klaster target yang diidentifikasi oleh `TargetDBClusterSnapshotIdentifier` saat snapshot klaster tersebut berada dalam status *menyalin*.

## Parameter Permintaan
<a name="API_CopyDBClusterSnapshot_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** SourceDBClusterSnapshotIdentifier **   
Pengidentifikasi snapshot klaster yang akan disalin. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus menentukan snapshot cluster yang valid dalam status yang *tersedia*.
+ Jika snapshot cluster sumber Wilayah AWS sama dengan salinan, tentukan pengenal snapshot yang valid.
+ Jika snapshot cluster sumber berbeda Wilayah AWS atau dimiliki oleh AWS akun lain, tentukan snapshot ARN.
Contoh: `my-cluster-snapshot1`   
Tipe: String  
Diperlukan: Ya

 ** TargetDBClusterSnapshotIdentifier **   
Pengidentifikasi snapshot klaster baru yang akan dibuat dari snapshot klaster sumber. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung. 
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut. 
Contoh: `my-cluster-snapshot2`   
Tipe: String  
Diperlukan: Ya

 ** CopyTags **   
Atur ke `true` untuk menyalin semua tag dari snapshot klaster sumber ke snapshot klaster target, dan sebaliknya `false`. Defaultnya adalah `false`.  
Tipe: Boolean  
Wajib: Tidak

 ** KmsKeyId **   
ID AWS KMS kunci untuk snapshot cluster terenkripsi. ID AWS KMS kunci adalah Nama Sumber Daya Amazon (ARN), pengenal AWS KMS kunci, atau alias kunci untuk AWS KMS kunci enkripsi. AWS KMS   
Jika Anda menyalin snapshot cluster terenkripsi dari Anda Akun AWS, Anda dapat menentukan nilai `KmsKeyId` untuk mengenkripsi salinan dengan kunci enkripsi baru. AWS KMS Jika Anda tidak menentukan nilai untuk`KmsKeyId`, maka salinan snapshot cluster dienkripsi dengan AWS KMS kunci yang sama dengan snapshot cluster sumber.  
Jika Anda menyalin snapshot kluster terenkripsi yang dibagikan dari yang lain Akun AWS, maka Anda harus menentukan nilai untuk. `KmsKeyId`  
Untuk menyalin snapshot kluster terenkripsi ke yang lain Wilayah AWS, atur `KmsKeyId` ke ID AWS KMS kunci yang ingin Anda gunakan untuk mengenkripsi salinan snapshot cluster di Wilayah tujuan. AWS KMS kunci enkripsi khusus untuk tempat Wilayah AWS mereka dibuat, dan Anda tidak dapat menggunakan kunci enkripsi dari satu Wilayah AWS sama lain Wilayah AWS.  
Jika Anda menyalin snapshot klaster yang tidak terenkripsi dan menentukan nilai untuk parameter `KmsKeyId`, kesalahan akan dikembalikan.  
Tipe: String  
Wajib: Tidak

 ** PreSignedUrl **   
URL yang berisi permintaan ditandatangani Signature Version 4 untuk tindakan `CopyDBClusterSnapshot` API Wilayah AWS yang berisi snapshot cluster sumber untuk disalin. Anda harus menggunakan parameter `PreSignedUrl` ketika menyalin snapshot klaster dari Wilayah AWS yang lain.  
Jika Anda menggunakan alat AWS SDK atau AWS CLI, Anda dapat menentukan `SourceRegion` (atau `--source-region` untuk AWS CLI) alih-alih menentukan secara manual`PreSignedUrl`. Menentukan `SourceRegion` secara otomatis menghasilkan URL pre-signed yang merupakan permintaan yang valid untuk operasi yang dapat dijalankan di Wilayah AWS sumber.  
URL yang telah ditetapkan sebelumnya harus berupa permintaan valid untuk tindakan `CopyDBClusterSnapshot` API yang dapat dijalankan di sumber Wilayah AWS yang berisi snapshot cluster yang akan disalin. Permintaan URL yang ditandatangani sebelumnya harus berisi nilai parameter berikut:  
+  `SourceRegion` - ID dari wilayah yang berisi snapshot yang akan disalin.
+  `SourceDBClusterSnapshotIdentifier` - Pengidentifikasi untuk snapshot klaster terenkripsi yang akan disalin. Pengidentifikasi ini harus dalam format Amazon Resource Name (ARN) untuk Wilayah AWS sumber. Misalnya, jika Anda menyalin snapshot klaster terenkripsi dari Wilayah AWS us-east-1, maka `SourceDBClusterSnapshotIdentifier` Anda akan terlihat seperti berikut: `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
+  `TargetDBClusterSnapshotIdentifier` - Pengidentifikasi untuk snapshot klaster baru yang akan dibuat. Parameter ini tidak peka huruf besar kecil.
Tipe: String  
Wajib: Tidak

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke snapshot klaster.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

## Elemen Respons
<a name="API_CopyDBClusterSnapshot_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBClusterSnapshot **   
Informasi mendetail tentang snapshot klaster.   
Tipe: Objek [DBClusterSnapshot](API_DBClusterSnapshot.md)

## Kesalahan
<a name="API_CopyDBClusterSnapshot_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterSnapshotAlreadyExistsFault **   
Anda sudah memiliki snapshot klaster dengan pengidentifikasi yang diberikan.  
Kode Status HTTP: 400

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` tidak mengacu ke sebuah snapshot klaster yang ada.   
Kode Status HTTP: 404

 ** InvalidDBClusterSnapshotStateFault **   
Nilai yang diberikan bukan status snapshot klaster yang valid.  
Kode Status HTTP: 400

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Terjadi kesalahan saat mengakses AWS KMS kunci.  
Kode Status HTTP: 400

 ** SnapshotQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah snapshot yang diizinkan.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_CopyDBClusterSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterSnapshot) 

# CreateDBCluster
<a name="API_CreateDBCluster"></a>

Membuat klaster Amazon DocumentDB baru.

## Parameter Permintaan
<a name="API_CreateDBCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Pengidentifikasi klaster. Parameter ini disimpan sebagai string huruf kecil.  
Batas:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung. 
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut. 
Contoh: `my-cluster`   
Tipe: String  
Diperlukan: Ya

 ** Engine **   
Nama mesin basis data yang akan digunakan untuk klaster ini.  
Nilai yang valid: `docdb`   
Tipe: String  
Diperlukan: Ya

 **AvailabilityZones. AvailabilityZone.N**   
Daftar Availability Zone Amazon EC2 tempat instans dalam klaster dapat dibuat.  
Tipe: Array string  
Wajib: Tidak

 ** BackupRetentionPeriod **   
Jumlah hari penyimpanan cadangan otomatis. Anda harus menentukan nilai minimum 1.  
Default: 1  
Batas:  
+ Harus berupa nilai dari 1 hingga 35.
Tipe: Integer  
Wajib: Tidak

 ** DBClusterParameterGroupName **   
Nama grup parameter klaster yang akan dikaitkan dengan klaster ini.  
Tipe: String  
Wajib: Tidak

 ** DBSubnetGroupName **   
Grup subnet yang akan dikaitkan dengan klaster ini.  
Batas: Harus cocok dengan nama `DBSubnetGroup` yang ada. Tidak harus default.  
Contoh: `mySubnetgroup`   
Tipe: String  
Wajib: Tidak

 ** DeletionProtection **   
Menentukan apakah klaster ini dapat dihapus. Jika `DeletionProtection` diaktifkan, klaster tidak dapat dihapus kecuali jika diubah dan `DeletionProtection` dinonaktifkan. `DeletionProtection` melindungi klaster agar tidak terhapus secara tidak sengaja.  
Tipe: Boolean  
Wajib: Tidak

 **EnableCloudwatchLogsExports.member.n**   
Daftar jenis log yang perlu diaktifkan untuk mengekspor ke Amazon CloudWatch Logs. Anda dapat mengaktifkan log audit atau log profiler. Untuk informasi selengkapnya, lihat [Peristiwa Pengauditan Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) dan [Operasi Pembuatan Profil Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).   
Tipe: Array string  
Wajib: Tidak

 ** EngineVersion **   
Nomor versi mesin basis data yang akan digunakan. `--engine-version` akan menjadi default ke versi mesin utama terbaru. Untuk beban kerja produksi, kami sarankan nyatakan parameter ini secara eksplisit dengan versi mesin utama yang dimaksud.  
Tipe: String  
Wajib: Tidak

 ** GlobalClusterIdentifier **   
Pengidentifikasi klaster dari klaster global baru.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Wajib: Tidak

 ** KmsKeyId **   
Pengidentifikasi AWS KMS kunci untuk cluster terenkripsi.  
Pengidentifikasi AWS KMS kunci adalah Amazon Resource Name (ARN) untuk kunci enkripsi AWS KMS . Jika Anda membuat cluster menggunakan yang sama Akun AWS yang memiliki kunci AWS KMS enkripsi yang digunakan untuk mengenkripsi cluster baru, Anda dapat menggunakan alias AWS KMS kunci alih-alih ARN untuk kunci enkripsi. AWS KMS   
Jika kunci enkripsi tidak ditentukan dalam `KmsKeyId`:   
+ Jika parameter `StorageEncrypted` adalah `true`, Amazon DocumentDB menggunakan kunci enkripsi default Anda. 
 AWS KMS membuat kunci enkripsi default untuk Anda Akun AWS. Anda Akun AWS memiliki kunci enkripsi default yang berbeda untuk masing-masing Wilayah AWS.  
Tipe: String  
Wajib: Tidak

 ** ManageMasterUserPassword **   
Menentukan apakah akan mengelola kata sandi pengguna utama dengan Amazon Web Services Secrets Manager.  
Kendala: Anda tidak dapat mengelola kata sandi pengguna utama dengan Amazon Web Services Secrets Manager jika `MasterUserPassword` ditentukan.  
Tipe: Boolean  
Wajib: Tidak

 ** MasterUsername **   
Nama pengguna utama untuk klaster.  
Batas:  
+ Harus dari 1 hingga 63 huruf atau angka.
+ Karakter pertama harus berupa surat.
+ Tidak dapat menjadi kata yang direservasi untuk mesin basis data yang dipilih. 
Tipe: String  
Wajib: Tidak

 ** MasterUserPassword **   
Kata sandi untuk pengguna basis data utama. Kata sandi ini dapat berisi karakter ASCII apa pun yang dapat dicetak kecuali garis miring (/), tanda kutip ganda ("), atau simbol "at" (@).  
Kendala: Harus berisi dari 8 hingga 100 karakter.  
Tipe: String  
Wajib: Tidak

 ** MasterUserSecretKmsKeyId **   
Pengidentifikasi kunci Amazon Web Services KMS untuk mengenkripsi rahasia yang dibuat dan dikelola secara otomatis di Amazon Web Services Secrets Manager. Pengaturan ini hanya berlaku jika kata sandi pengguna utama dikelola oleh Amazon DocumentDB di Amazon Web Services Secrets Manager untuk cluster DB.  
Pengidentifikasi kunci Amazon Web Services KMS adalah kunci ARN, ID kunci, alias ARN, atau nama alias untuk kunci KMS. Untuk menggunakan kunci KMS di akun Amazon Web Services yang berbeda, tentukan kunci ARN atau alias ARN.  
Jika Anda tidak menentukan`MasterUserSecretKmsKeyId`, maka kunci `aws/secretsmanager` KMS digunakan untuk mengenkripsi rahasia. Jika rahasianya ada di akun Amazon Web Services yang berbeda, maka Anda tidak dapat menggunakan kunci `aws/secretsmanager` KMS untuk mengenkripsi rahasia, dan Anda harus menggunakan kunci KMS yang dikelola pelanggan.  
Ada kunci KMS default untuk akun Amazon Web Services Anda. Akun Amazon Web Services Anda memiliki kunci KMS default yang berbeda untuk setiap Wilayah Amazon Web Services.  
Tipe: String  
Wajib: Tidak

 ** NetworkType **   
Jenis jaringan cluster.  
Jenis jaringan ditentukan oleh yang `DBSubnetGroup` ditentukan untuk cluster. A hanya `DBSubnetGroup` dapat mendukung IPv4 protokol atau IPv4 dan IPv6 protokol ()`DUAL`.  
Untuk informasi selengkapnya, lihat [cluster DocumentDB di VPC di Panduan Pengembang Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html).  
Nilai Valid: `IPV4` \$1 `DUAL`   
Tipe: String  
Wajib: Tidak

 ** Port **   
Nomor port tempat instans dalam klaster menerima koneksi.  
Tipe: Integer  
Wajib: Tidak

 ** PreferredBackupWindow **   
Rentang waktu harian selama pencadangan otomatis dibuat jika pencadangan otomatis diaktifkan menggunakan parameter `BackupRetentionPeriod`.   
Defaultnya adalah jendela 30 menit yang dipilih secara acak dari blok waktu 8 jam untuk masing-masing. Wilayah AWS  
Batas:  
+ Harus dalam format `hh24:mi-hh24:mi`.
+ Harus dalam Waktu Universal Terkoordinasi (UTC).
+ Tidak boleh bertentangan dengan jendela pemeliharaan yang diinginkan. 
+ Harus setidaknya 30 menit.
Tipe: String  
Wajib: Tidak

 ** PreferredMaintenanceWindow **   
Rentang waktu mingguan selama pemeliharaan sistem dapat terjadi, dalam Waktu Universal Terkoordinasi (UTC).  
Format: `ddd:hh24:mi-ddd:hh24:mi`   
Defaultnya adalah jendela 30 menit yang dipilih secara acak dari blok waktu 8 jam untuk masing-masing Wilayah AWS, terjadi pada hari acak dalam seminggu.  
Hari yang valid: Sen, Sel, Rab, Kam, Jum, Sab, Min  
Kendala: Minimum 30 menit jendela.  
Tipe: String  
Wajib: Tidak

 ** PreSignedUrl **   
Saat ini tidak didukung.   
Tipe: String  
Wajib: Tidak

 ** ServerlessV2ScalingConfiguration **   
Berisi konfigurasi penskalaan cluster Amazon DocumentDB Tanpa Server.  
Tipe: Objek [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Wajib: Tidak

 ** StorageEncrypted **   
Menentukan apakah klaster dienkripsi.  
Tipe: Boolean  
Wajib: Tidak

 ** StorageType **   
Jenis penyimpanan untuk dikaitkan dengan cluster DB.  
Untuk informasi tentang jenis penyimpanan untuk klaster Amazon DocumentDB, lihat Konfigurasi penyimpanan klaster di Panduan Pengembang *Amazon* DocumentDB.  
Nilai yang valid untuk jenis penyimpanan - `standard | iopt1`   
Nilai default adalah `standard `   
Saat Anda membuat klaster Amazon DocumentDB dengan jenis penyimpanan disetel `iopt1` ke, jenis penyimpanan dikembalikan dalam respons. Jenis penyimpanan tidak dikembalikan saat Anda mengaturnya`standard`.
Tipe: String  
Wajib: Tidak

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke klaster.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

 **VpcSecurityGroupIds. VpcSecurityGroupId.N**   
Sebuah daftar grup keamanan VPC EC2 untuk dikaitkan dengan kluster ini.   
Tipe: Array string  
Wajib: Tidak

## Elemen Respons
<a name="API_CreateDBCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBCluster **   
Informasi mendetail tentang klaster.   
Tipe: Objek [DBCluster](API_DBCluster.md)

## Kesalahan
<a name="API_CreateDBCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
Anda sudah memiliki klaster dengan pengidentifikasi yang diberikan.  
Kode Status HTTP: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` tidak mengacu ke grup parameter klaster yang ada.   
Kode Status HTTP: 404

 ** DBClusterQuotaExceededFault **   
Klaster tidak dapat dibuat karena Anda telah mencapai kuota maksimum klaster yang diizinkan.  
Kode Status HTTP: 403

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` tidak mengacu ke sebuah instans yang ada.   
Kode Status HTTP: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnet dalam grup subnet harus mencakup setidaknya dua Availability Zone kecuali hanya ada satu Availability Zone.  
Kode Status HTTP: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` tidak mengacu ke grup subnet yang ada.   
Kode Status HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` tidak mengacu ke sebuah klaster global yang ada.  
Kode Status HTTP: 404

 ** InsufficientStorageClusterCapacity **   
Tidak ada cukup penyimpanan yang tersedia untuk tindakan saat ini. Anda mungkin dapat mengatasi kesalahan ini dengan memperbarui grup subnet Anda untuk menggunakan Availability Zone berbeda yang memiliki lebih banyak penyimpanan yang tersedia.   
Kode Status HTTP: 400

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidDBInstanceState **   
 Instans yang ditentukan tidak dalam status *tersedia*.   
Kode Status HTTP: 400

 ** InvalidDBSubnetGroupStateFault **   
Grup subnet tidak dapat dihapus karena sedang digunakan.  
Kode Status HTTP: 400

 ** InvalidGlobalClusterStateFault **   
Operasi yang diminta tidak dapat dilakukan saat klaster dalam keadaan ini.  
Kode Status HTTP: 400

 ** InvalidSubnet **   
Subnet yang diminta tidak valid, atau beberapa subnet yang diminta tidak semuanya berada dalam virtual private cloud (VPC) yang umum.  
Kode Status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
Grup subnet tidak mencakup semua Availability Zone setelah dibuat karena perubahan yang dibuat.  
Kode Status HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Terjadi kesalahan saat mengakses AWS KMS kunci.  
Kode Status HTTP: 400

 ** NetworkTypeNotSupported **   
Jenis jaringan tidak didukung oleh salah satu `DBSubnetGroup` atau versi mesin DB.  
Kode Status HTTP: 400

 ** StorageQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah penyimpanan yang diizinkan yang tersedia di semua instans.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_CreateDBCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBCluster) 

# CreateDBClusterParameterGroup
<a name="API_CreateDBClusterParameterGroup"></a>

Membuat grup parameter klaster baru.

Parameter dalam grup parameter klaster berlaku untuk semua instans dalam sebuah klaster.

Grup parameter klaster awalnya dibuat dengan parameter default untuk mesin basis data yang digunakan oleh instans dalam klaster. Di Amazon DocumentDB, Anda tidak dapat membuat modifikasi langsung ke grup parameter klaster `default.docdb3.6`. Jika klaster Amazon DocumentDB Anda menggunakan grup parameter klaster default dan Anda ingin mengubah nilai di dalamnya, Anda harus terlebih dahulu [ membuat grup parameter baru](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) atau [ menyalin grup parameter yang ada](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html), memodifikasinya, lalu menerapkan grup parameter yang dimodifikasi ke klaster Anda. Agar grup parameter klaster baru dan pengaturan terkait diterapkan, Anda harus me-reboot instans di klaster tanpa failover. Untuk informasi selengkapnya, lihat [ Memodifikasi Grup Parameter Klaster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html). 

## Parameter Permintaan
<a name="API_CreateDBClusterParameterGroup_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nama grup parameter klaster.  
Batas:  
+ Tidak boleh sesuai dengan nama `DBClusterParameterGroup` yang ada.
Nilai ini disimpan sebagai string huruf kecil.
Tipe: String  
Diperlukan: Ya

 ** DBParameterGroupFamily **   
Nama famili grup parameter klaster.  
Tipe: String  
Diperlukan: Ya

 ** Description **   
Deskripsi untuk grup parameter klaster.  
Tipe: String  
Diperlukan: Ya

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke grup parameter klaster.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

## Elemen Respons
<a name="API_CreateDBClusterParameterGroup_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBClusterParameterGroup **   
Informasi mendetail tentang grup parameter klaster.   
Tipe: Objek [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

## Kesalahan
<a name="API_CreateDBClusterParameterGroup_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBParameterGroupAlreadyExists **   
Grup parameter dengan nama yang sama sudah ada.  
Kode Status HTTP: 400

 ** DBParameterGroupQuotaExceeded **   
Permintaan ini akan menyebabkan Anda melebihi jumlah grup parameter yang diizinkan.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_CreateDBClusterParameterGroup_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 

# CreateDBClusterSnapshot
<a name="API_CreateDBClusterSnapshot"></a>

Membuat snapshot dari sebuah klaster. 

## Parameter Permintaan
<a name="API_CreateDBClusterSnapshot_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Pengidentifikasi klaster untuk membuat snapshotnya. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus cocok dengan pengidentifikasi `DBCluster` yang ada.
Contoh: `my-cluster`   
Tipe: String  
Diperlukan: Ya

 ** DBClusterSnapshotIdentifier **   
Pengidentifikasi snapshot klaster. Parameter ini disimpan sebagai string huruf kecil.  
Batas:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut. 
Contoh: `my-cluster-snapshot1`   
Tipe: String  
Diperlukan: Ya

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke snapshot klaster.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

## Elemen Respons
<a name="API_CreateDBClusterSnapshot_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBClusterSnapshot **   
Informasi mendetail tentang snapshot klaster.   
Tipe: Objek [DBClusterSnapshot](API_DBClusterSnapshot.md)

## Kesalahan
<a name="API_CreateDBClusterSnapshot_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** DBClusterSnapshotAlreadyExistsFault **   
Anda sudah memiliki snapshot klaster dengan pengidentifikasi yang diberikan.  
Kode Status HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
Nilai yang diberikan bukan status snapshot klaster yang valid.  
Kode Status HTTP: 400

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** SnapshotQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah snapshot yang diizinkan.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_CreateDBClusterSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterSnapshot) 

# CreateDBInstance
<a name="API_CreateDBInstance"></a>

Membuat instans baru.

## Parameter Permintaan
<a name="API_CreateDBInstance_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Pengidentifikasi klaster tempat instans akan berada.  
Tipe: String  
Diperlukan: Ya

 ** DBInstanceClass **   
Kapasitas komputasi dan memori instans; misalnya, `db.r5.large`.   
Tipe: String  
Diperlukan: Ya

 ** DBInstanceIdentifier **   
Pengidentifikasi instans. Parameter ini disimpan sebagai string huruf kecil.  
Batas:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Contoh: `mydbinstance`   
Tipe: String  
Diperlukan: Ya

 ** Engine **   
Nama mesin basis data yang akan digunakan untuk instans ini.  
Nilai valid: `docdb`   
Tipe: String  
Diperlukan: Ya

 ** AutoMinorVersionUpgrade **   
Parameter ini tidak berlaku untuk Amazon DocumentDB. Amazon DocumentDB tidak melakukan peningkatan versi minor terlepas dari nilai yang ditetapkan.  
Default: `false`   
Jenis: Boolean  
Wajib: Tidak

 ** AvailabilityZone **   
Availability Zone Amazon EC2 tempat instans dibuat.   
Default: Availability Zone acak yang dipilih sistem di titik akhir. Wilayah AWS  
Contoh: `us-east-1d`   
Tipe: String  
Wajib: Tidak

 ** CACertificateIdentifier **   
Pengidentifikasi sertifikat CA yang akan digunakan untuk sertifikat server instans DB.  
*Untuk informasi selengkapnya, lihat [Memperbarui Sertifikat Amazon DocumentDB TLS Anda](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) [dan Mengenkripsi Data dalam Transit di](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) Panduan Pengembang Amazon DocumentDB.*  
Tipe: String  
Wajib: Tidak

 ** CopyTagsToSnapshot **   
Nilai yang menunjukkan apakah akan menyalin tanda dari instans DB untuk snapshot instans DB. Secara default, tanda tidak disalin.  
Tipe: Boolean  
Wajib: Tidak

 ** EnablePerformanceInsights **   
Nilai yang menunjukkan apakah akan mengaktifkan Performance Insights untuk Instans DB. Untuk informasi selengkapnya, lihat [Menggunakan Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).  
Tipe: Boolean  
Wajib: Tidak

 ** PerformanceInsightsKMSKeyId **   
Pengenal AWS KMS kunci untuk enkripsi data Performance Insights.  
Pengidentifikasi AWS KMS kunci adalah kunci ARN, ID kunci, alias ARN, atau nama alias untuk kunci KMS.  
Jika Anda tidak menentukan nilai untuk PerformanceInsights KMSKey Id, maka Amazon DocumentDB menggunakan kunci KMS default Anda. Ada kunci KMS default untuk akun Amazon Web Services Anda. Akun Amazon Web Services Anda memiliki kunci KMS default yang berbeda untuk setiap wilayah Amazon Web Services.  
Tipe: String  
Wajib: Tidak

 ** PreferredMaintenanceWindow **   
Rentang waktu setiap minggu untuk melakukan pemeliharaan sistem, dalam Waktu Universal Terkoordinasi (UTC).  
 Format: `ddd:hh24:mi-ddd:hh24:mi`   
Defaultnya adalah jendela 30 menit yang dipilih secara acak dari blok waktu 8 jam untuk masing-masing Wilayah AWS, terjadi pada hari acak dalam seminggu.   
Hari yang valid: Sen, Sel, Rab, Kam, Jum, Sab, Min  
Kendala: Minimum 30 menit jendela.  
Tipe: String  
Wajib: Tidak

 ** PromotionTier **   
Nilai yang menentukan urutan di mana replika Amazon DocumentDB dipromosikan ke instans primer setelah kegagalan instans primer yang ada.  
Default: 1  
Nilai yang valid: 0-15  
Tipe: Integer  
Wajib: Tidak

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke instans. Anda dapat menetapkan hingga 10 tag ke sebuah instans.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

## Elemen Respons
<a name="API_CreateDBInstance_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBInstance **   
Informasi mendetail tentang sebuah instans.   
Tipe: Objek [DBInstance](API_DBInstance.md)

## Kesalahan
<a name="API_CreateDBInstance_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AuthorizationNotFound **   
Grup keamanan CIDR IP atau Amazon EC2 yang ditentukan tidak diotorisasi untuk grup keamanan yang ditentukan.  
Amazon DocumentDB juga mungkin tidak diizinkan untuk melakukan tindakan yang diperlukan atas nama Anda menggunakan IAM.  
Kode Status HTTP: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** DBInstanceAlreadyExists **   
Anda sudah memiliki instans dengan pengidentifikasi yang diberikan.  
Kode Status HTTP: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` tidak mengacu ke grup parameter yang ada.   
Kode Status HTTP: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` tidak mengacu ke grup keamanan yang ada.   
Kode Status HTTP: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnet dalam grup subnet harus mencakup setidaknya dua Availability Zone kecuali hanya ada satu Availability Zone.  
Kode Status HTTP: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` tidak mengacu ke grup subnet yang ada.   
Kode Status HTTP: 404

 ** InstanceQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah instans yang diizinkan.  
Kode Status HTTP: 400

 ** InsufficientDBInstanceCapacity **   
Kelas instans yang ditentukan tidak tersedia di Availability Zone yang ditentukan.  
Kode Status HTTP: 400

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidSubnet **   
Subnet yang diminta tidak valid, atau beberapa subnet yang diminta tidak semuanya berada dalam virtual private cloud (VPC) yang umum.  
Kode Status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
Grup subnet tidak mencakup semua Availability Zone setelah dibuat karena perubahan yang dibuat.  
Kode Status HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Terjadi kesalahan saat mengakses AWS KMS kunci.  
Kode Status HTTP: 400

 ** StorageQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah penyimpanan yang diizinkan yang tersedia di semua instans.  
Kode Status HTTP: 400

 ** StorageTypeNotSupported **   
Penyimpanan `StorageType` yang ditentukan tidak dapat dikaitkan dengan instans DB.   
Kode Status HTTP: 400

## Lihat Juga
<a name="API_CreateDBInstance_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBInstance) 

# CreateDBSubnetGroup
<a name="API_CreateDBSubnetGroup"></a>

Membuat grup subnet baru. Grup subnet harus berisi setidaknya satu subnet di setidaknya dua Availability Zone di Wilayah AWS.

## Parameter Permintaan
<a name="API_CreateDBSubnetGroup_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBSubnetGroupDescription **   
Deskripsi untuk grup subnet.  
Tipe: String  
Diperlukan: Ya

 ** DBSubnetGroupName **   
Nama grup subnet. Nilai ini disimpan sebagai string huruf kecil.  
Kendala: Harus berisi tidak lebih dari 255 huruf, angka, titik, garis bawah, spasi, atau tanda hubung. Tidak harus default.  
Contoh: `mySubnetgroup`   
Tipe: String  
Diperlukan: Ya

 **SubnetIds. SubnetIdentifier.N**   
Subnet Amazon EC2 IDs untuk grup subnet.  
Tipe: Array string  
Wajib: Ya

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke grup subnet.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

## Elemen Respons
<a name="API_CreateDBSubnetGroup_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBSubnetGroup **   
Informasi mendetail tentang grup subnet.   
Tipe: Objek [DBSubnetGroup](API_DBSubnetGroup.md)

## Kesalahan
<a name="API_CreateDBSubnetGroup_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBSubnetGroupAlreadyExists **   
 `DBSubnetGroupName` telah digunakan oleh grup subnet yang ada.   
Kode Status HTTP: 400

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnet dalam grup subnet harus mencakup setidaknya dua Availability Zone kecuali hanya ada satu Availability Zone.  
Kode Status HTTP: 400

 ** DBSubnetGroupQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah grup subnet yang diizinkan.  
Kode Status HTTP: 400

 ** DBSubnetQuotaExceededFault **   
Permintaan akan menyebabkan Anda melebihi jumlah subnet yang diizinkan dalam grup subnet.  
Kode Status HTTP: 400

 ** InvalidSubnet **   
Subnet yang diminta tidak valid, atau beberapa subnet yang diminta tidak semuanya berada dalam virtual private cloud (VPC) yang umum.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_CreateDBSubnetGroup_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBSubnetGroup) 

# CreateEventSubscription
<a name="API_CreateEventSubscription"></a>

Membuat langganan notifikasi peristiwa Amazon DocumentDB. Tindakan ini memerlukan topik Amazon Resource Name (ARN) yang dibuat dengan menggunakan konsol Amazon DocumentDB, konsol Amazon SNS, atau API Amazon SNS. Untuk mendapatkan ARN dengan Amazon SNS, Anda harus membuat topik di Amazon SNS dan berlangganan topik tersebut. ARN ditampilkan di konsol Amazon SNS.

Anda dapat menentukan jenis sumber (`SourceType`) yang Anda ingin untuk diberi tahu. Anda juga dapat memberikan daftar sumber Amazon DocumentDB (`SourceIds`) yang memicu peristiwa, dan Anda dapat memberikan daftar kategori peristiwa (`EventCategories`) untuk peristiwa yang Anda ingin untuk diberi tahu. Misalnya, Anda dapat menentukan `SourceType = db-instance`, `SourceIds = mydbinstance1, mydbinstance2` dan `EventCategories = Availability, Backup`.

Jika Anda menentukan `SourceType` dan `SourceIds`, (seperti `SourceType = db-instance` dan `SourceIdentifier = myDBInstance1`), Anda akan diberi tahu tentang semua peristiwa `db-instance` untuk sumber yang ditentukan. Jika Anda menentukan `SourceType`, tetapi tidak menentukan `SourceIdentifier`, Anda menerima pemberitahuan peristiwa untuk jenis sumber tersebut untuk semua sumber Amazon DocumentDB Anda. Jika Anda tidak menentukan `SourceType` atau `SourceIdentifier`, Anda menerima pemberitahuan tentang kejadian yang dihasilkan dari semua sumber Amazon DocumentDB milik akun pelanggan Anda.

## Parameter Permintaan
<a name="API_CreateEventSubscription_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** SnsTopicArn **   
Amazon Resource Name (ARN) dari topik SNS yang dibuat untuk notifikasi peristiwa. Amazon SNS membuat ARN saat Anda membuat topik dan berlangganan topik tersebut.  
Tipe: String  
Diperlukan: Ya

 ** SubscriptionName **   
Nama dari langganan.  
Kendala: Nama harus kurang dari 255 karakter.  
Tipe: String  
Diperlukan: Ya

 ** Enabled **   
 Nilai Boolean; atur ke `true` untuk mengaktifkan langganan, atur ke `false` untuk membuat langganan tetapi tidak mengaktifkannya.   
Tipe: Boolean  
Wajib: Tidak

 **EventCategories. EventCategory.N**   
 Daftar kategori peristiwa untuk `SourceType` yang ingin Anda langgani.   
Tipe: Array string  
Wajib: Tidak

 **SourceIds. SourceId.N**   
Daftar pengidentifikasi sumber acara yang acaranya dikembalikan. Jika tidak ditentukan, maka semua sumber disertakan dalam respons. Pengidentifikasi harus dimulai dengan huruf dan hanya boleh berisi huruf ASCII, angka, dan tanda hubung; tidak boleh diakhiri dengan tanda hubung atau berisi dua tanda hubung berturut-turut.  
Batas:  
+ Jika `SourceIds` disediakan, `SourceType` juga harus disediakan.
+ Jika jenis sumber adalah sebuah instans, `DBInstanceIdentifier` harus disediakan.
+ Jika jenis sumber adalah sebuah grup keamanan, `DBSecurityGroupName` harus disediakan.
+ Jika jenis sumber adalah sebuah grup parameter, `DBParameterGroupName` harus disediakan.
+ Jika jenis sumber adalah sebuah snapshot, `DBSnapshotIdentifier` harus disediakan.
Tipe: Array string  
Wajib: Tidak

 ** SourceType **   
Jenis sumber yang menghasilkan peristiwa. Misalnya, jika Anda ingin diberi tahu tentang peristiwa yang dihasilkan oleh sebuah instans, Anda akan mengatur parameter ini ke `db-instance`. Jika nilai ini tidak ditentukan, semua peristiwa dikembalikan.  
Nilai yang valid:`db-instance`,`db-cluster`,`db-parameter-group`,`db-security-group`, `db-cluster-snapshot`   
Tipe: String  
Wajib: Tidak

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke langganan acara.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

## Elemen Respons
<a name="API_CreateEventSubscription_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** EventSubscription **   
Informasi mendetail tentang peristiwa yang telah Anda langgani.  
Tipe: Objek [EventSubscription](API_EventSubscription.md)

## Kesalahan
<a name="API_CreateEventSubscription_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** EventSubscriptionQuotaExceeded **   
Anda telah mencapai jumlah maksimum langganan peristiwa.   
Kode Status HTTP: 400

 ** SNSInvalidTopic **   
Amazon SNS telah merespons bahwa ada masalah dengan topik yang ditentukan.   
Kode Status HTTP: 400

 ** SNSNoAuthorization **   
Anda tidak memiliki izin untuk memublikasikan ke Amazon Resource Name (ARN) topik SNS.   
Kode Status HTTP: 400

 ** SNSTopicArnNotFound **   
Amazon Resource Name (ARN) topik SNS tidak ada.   
Kode Status HTTP: 404

 ** SourceNotFound **   
Sumber yang diminta tidak dapat ditemukan.   
Kode Status HTTP: 404

 ** SubscriptionAlreadyExist **   
Nama langganan yang diberikan sudah ada.   
Kode Status HTTP: 400

 ** SubscriptionCategoryNotFound **   
Kategori yang diberikan tidak ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_CreateEventSubscription_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateEventSubscription) 

# CreateGlobalCluster
<a name="API_CreateGlobalCluster"></a>

Membuat klaster global Amazon DocumentDB yang dapat menjangkau beberapa Wilayah AWS. Cluster global berisi satu cluster primer dengan kemampuan baca-tulis, dan hingga 10 cluster sekunder read-only. Klaster global menggunakan replikasi cepat berbasis penyimpanan di seluruh wilayah dengan latensi kurang dari satu detik, menggunakan infrastruktur khusus tanpa memengaruhi performa beban kerja Anda.



Anda dapat membuat sebuah klaster global yang awalnya kosong, dan kemudian menambahkan primer dan sekunder ke dalamnya. Atau Anda dapat menentukan klaster yang ada selama operasi pembuatan, dan klaster ini menjadi yang primer dari klaster global. 

**catatan**  
Tindakan ini hanya berlaku untuk klaster Amazon DocumentDB.

## Parameter Permintaan
<a name="API_CreateGlobalCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Pengidentifikasi klaster dari klaster global baru.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Wajib: Ya

 ** DatabaseName **   
Nama untuk basis data Anda hingga 64 karakter alfanumerik. Jika Anda tidak memberikan nama, Amazon DocumentDB tidak akan membuat basis data di klaster global yang sedang Anda buat.  
Tipe: String  
Wajib: Tidak

 ** DeletionProtection **   
Pengaturan perlindungan penghapusan untuk klaster global baru. Klaster global tidak dapat dihapus saat perlindungan penghapusan diaktifkan.   
Tipe: Boolean  
Wajib: Tidak

 ** Engine **   
Nama mesin basis data yang akan digunakan untuk klaster ini.  
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Versi mesin dari klaster global.  
Tipe: String  
Wajib: Tidak

 ** SourceDBClusterIdentifier **   
Amazon Resource Name (ARN) untuk digunakan sebagai klaster primer dari klaster global. Parameter ini bersifat opsional.  
Tipe: String  
Wajib: Tidak

 ** StorageEncrypted **   
Pengaturan enkripsi penyimpanan untuk klaster global baru.   
Tipe: Boolean  
Wajib: Tidak

## Elemen Respons
<a name="API_CreateGlobalCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** GlobalCluster **   
Sebuah tipe data yang mewakili sebuah klaster global Amazon DocumentDB.  
Tipe: Objek [GlobalCluster](API_GlobalCluster.md)

## Kesalahan
<a name="API_CreateGlobalCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** GlobalClusterAlreadyExistsFault **   
Parameter `GlobalClusterIdentifier` sudah ada. Pilih pengidentifikasi klaster global baru (nama unik) untuk membuat klaster global baru.   
Kode Status HTTP: 400

 ** GlobalClusterQuotaExceededFault **   
Jumlah klaster global untuk akun ini sudah mencapai batas maksimum yang diizinkan.  
Kode Status HTTP: 400

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_CreateGlobalCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateGlobalCluster) 

# DeleteDBCluster
<a name="API_DeleteDBCluster"></a>

Menghapus klaster yang telah disediakan sebelumnya. Ketika Anda menghapus sebuah klaster, semua backup otomatis untuk kluster tersebut dihapus dan tidak dapat dipulihkan. Snapshot klaster DB manual dari klaster yang ditentukan tidak dihapus.



## Parameter Permintaan
<a name="API_DeleteDBCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Pengidentifikasi klaster untuk klaster yang akan dihapus. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus cocok dengan `DBClusterIdentifier` yang ada.
Tipe: String  
Diperlukan: Ya

 ** FinalDBSnapshotIdentifier **   
 Pengidentifikasi snapshot klaster dari snapshot klaster baru yang dibuat saat `SkipFinalSnapshot` diatur ke `false`.   
 Menentukan parameter ini dan juga mengatur parameter `SkipFinalShapshot` ke `true` menghasilkan kesalahan. 
Batas:  
+ Harus dari 1 sampai 255 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Tipe: String  
Wajib: Tidak

 ** SkipFinalSnapshot **   
 Menentukan apakah snapshot klaster akhir dibuat sebelum klaster dihapus. Jika `true` ditentukan, tidak ada snapshot klaster yang dibuat. Jika `false` ditentukan, snapshot klaster dibuat sebelum klaster DB dihapus.   
Jika `SkipFinalSnapshot` adalah `false`, Anda harus menentukan parameter `FinalDBSnapshotIdentifier`.
Default: `false`   
Jenis: Boolean  
Wajib: Tidak

## Elemen Respons
<a name="API_DeleteDBCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBCluster **   
Informasi mendetail tentang klaster.   
Tipe: Objek [DBCluster](API_DBCluster.md)

## Kesalahan
<a name="API_DeleteDBCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** DBClusterSnapshotAlreadyExistsFault **   
Anda sudah memiliki snapshot klaster dengan pengidentifikasi yang diberikan.  
Kode Status HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
Nilai yang diberikan bukan status snapshot klaster yang valid.  
Kode Status HTTP: 400

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** SnapshotQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah snapshot yang diizinkan.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_DeleteDBCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBCluster) 

# DeleteDBClusterParameterGroup
<a name="API_DeleteDBClusterParameterGroup"></a>

Menghapus grup parameter klaster tertentu. Grup parameter klaster yang akan dihapus tidak dapat dikaitkan dengan klaster mana pun.

## Parameter Permintaan
<a name="API_DeleteDBClusterParameterGroup_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nama grup parameter klaster.  
Batas:  
+ Harus nama grup parameter klaster yang ada.
+ Anda tidak dapat menghapus grup parameter klaster default.
+ Tidak dapat dikaitkan dengan klaster mana pun.
Tipe: String  
Diperlukan: Ya

## Kesalahan
<a name="API_DeleteDBClusterParameterGroup_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` tidak mengacu ke grup parameter yang ada.   
Kode Status HTTP: 404

 ** InvalidDBParameterGroupState **   
Grup parameter sedang digunakan, atau dalam keadaan tidak valid. Jika Anda mencoba menghapus grup parameter, Anda tidak dapat menghapusnya ketika grup parameter berada dalam keadaan ini.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_DeleteDBClusterParameterGroup_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 

# DeleteDBClusterSnapshot
<a name="API_DeleteDBClusterSnapshot"></a>

Menghapus snapshot klaster. Jika snapshot sedang disalin, operasi penyalinan dihentikan.

**catatan**  
Snapshot klaster harus dalam status `available` untuk dihapus.

## Parameter Permintaan
<a name="API_DeleteDBClusterSnapshot_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterSnapshotIdentifier **   
Pengidentifikasi snapshot klaster yang akan dihapus.  
Kendala: Harus berupa nama snapshot klaster yang ada dalam status `available`.  
Tipe: String  
Diperlukan: Ya

## Elemen Respons
<a name="API_DeleteDBClusterSnapshot_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBClusterSnapshot **   
Informasi mendetail tentang snapshot klaster.   
Tipe: Objek [DBClusterSnapshot](API_DBClusterSnapshot.md)

## Kesalahan
<a name="API_DeleteDBClusterSnapshot_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` tidak mengacu ke sebuah snapshot klaster yang ada.   
Kode Status HTTP: 404

 ** InvalidDBClusterSnapshotStateFault **   
Nilai yang diberikan bukan status snapshot klaster yang valid.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_DeleteDBClusterSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 

# DeleteDBInstance
<a name="API_DeleteDBInstance"></a>

Menghapus instans yang disediakan sebelumnya.

## Parameter Permintaan
<a name="API_DeleteDBInstance_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBInstanceIdentifier **   
Pengidentifikasi instans untuk instans yang akan dihapus. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus cocok dengan nama instans yang ada.
Tipe: String  
Diperlukan: Ya

## Elemen Respons
<a name="API_DeleteDBInstance_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBInstance **   
Informasi mendetail tentang sebuah instans.   
Tipe: Objek [DBInstance](API_DBInstance.md)

## Kesalahan
<a name="API_DeleteDBInstance_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` tidak mengacu ke sebuah instans yang ada.   
Kode Status HTTP: 404

 ** DBSnapshotAlreadyExists **   
 `DBSnapshotIdentifier` telah digunakan oleh snapshot yang ada.   
Kode Status HTTP: 400

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidDBInstanceState **   
 Instans yang ditentukan tidak dalam status *tersedia*.   
Kode Status HTTP: 400

 ** SnapshotQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah snapshot yang diizinkan.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_DeleteDBInstance_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBInstance) 

# DeleteDBSubnetGroup
<a name="API_DeleteDBSubnetGroup"></a>

Menghapus grup subnet.

**catatan**  
Grup subnet basis data yang ditentukan tidak boleh dikaitkan dengan instans DB apa pun.

## Parameter Permintaan
<a name="API_DeleteDBSubnetGroup_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBSubnetGroupName **   
Nama grup subnet basis data yang akan dihapus.  
Anda tidak dapat menghapus grup subnet default.
Batas:  
Harus cocok dengan nama `DBSubnetGroup` yang ada. Tidak harus default.  
Contoh: `mySubnetgroup`   
Tipe: String  
Diperlukan: Ya

## Kesalahan
<a name="API_DeleteDBSubnetGroup_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` tidak mengacu ke grup subnet yang ada.   
Kode Status HTTP: 404

 ** InvalidDBSubnetGroupStateFault **   
Grup subnet tidak dapat dihapus karena sedang digunakan.  
Kode Status HTTP: 400

 ** InvalidDBSubnetStateFault **   
 Subnet tidak dalam status *tersedia*.   
Kode Status HTTP: 400

## Lihat Juga
<a name="API_DeleteDBSubnetGroup_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBSubnetGroup) 

# DeleteEventSubscription
<a name="API_DeleteEventSubscription"></a>

Menghapus langganan notifikasi peristiwa Amazon DocumentDB.

## Parameter Permintaan
<a name="API_DeleteEventSubscription_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** SubscriptionName **   
Nama langganan notifikasi peristiwa Amazon DocumentDB yang ingin Anda hapus.  
Tipe: String  
Diperlukan: Ya

## Elemen Respons
<a name="API_DeleteEventSubscription_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** EventSubscription **   
Informasi mendetail tentang peristiwa yang telah Anda langgani.  
Tipe: Objek [EventSubscription](API_EventSubscription.md)

## Kesalahan
<a name="API_DeleteEventSubscription_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** InvalidEventSubscriptionState **   
Orang lain mungkin memodifikasi langganan. Tunggu beberapa detik, dan coba lagi.  
Kode Status HTTP: 400

 ** SubscriptionNotFound **   
Nama langganan tidak ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DeleteEventSubscription_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteEventSubscription) 

# DeleteGlobalCluster
<a name="API_DeleteGlobalCluster"></a>

Menghapus klaster global. Klaster primer dan sekunder harus sudah terlepas atau dihapus sebelum mencoba menghapus klaster global.

**catatan**  
Tindakan ini hanya berlaku untuk klaster Amazon DocumentDB.

## Parameter Permintaan
<a name="API_DeleteGlobalCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Pengidentifikasi klaster dari klaster global yang sedang dihapus.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Diperlukan: Ya

## Elemen Respons
<a name="API_DeleteGlobalCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** GlobalCluster **   
Sebuah tipe data yang mewakili sebuah klaster global Amazon DocumentDB.  
Tipe: Objek [GlobalCluster](API_GlobalCluster.md)

## Kesalahan
<a name="API_DeleteGlobalCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` tidak mengacu ke sebuah klaster global yang ada.  
Kode Status HTTP: 404

 ** InvalidGlobalClusterStateFault **   
Operasi yang diminta tidak dapat dilakukan saat klaster dalam keadaan ini.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_DeleteGlobalCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteGlobalCluster) 

# DescribeCertificates
<a name="API_DescribeCertificates"></a>

Mengembalikan daftar sertifikat otoritas sertifikat (CA) yang disediakan oleh Amazon DocumentDB untuk Akun AWS ini.

## Parameter Permintaan
<a name="API_DescribeCertificates_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** CertificateIdentifier **   
Pengidentifikasi sertifikat yang disediakan pengguna. Jika parameter ini ditentukan, informasi untuk hanya sertifikat tertentu dikembalikan. Jika parameter ini dihilangkan, daftar hingga `MaxRecords` sertifikat dikembalikan. Parameter ini tidak peka huruf besar kecil.  
Kendala  
+ Harus cocok dengan `CertificateIdentifier` yang ada.
Tipe: String  
Wajib: Tidak

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan `DescribeCertificates` sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination (pemberian nomor halaman) yang disebut penanda disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Batas:  
+ Minimum: 20
+ Maksimum: 100
Tipe: Integer  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeCertificates_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 **Sertifikat.Certificate.N**   
Daftar sertifikat untuk Akun AWS ini.  
Tipe: Array objek [Certificate](API_Certificate.md)

 ** Marker **   
Token pagination (pemberian nomor halaman) opsional disediakan jika jumlah catatan yang diambil lebih besar dari `MaxRecords`. Jika parameter ini ditentukan, penanda menentukan catatan berikutnya dalam daftar. Termasuk nilai `Marker` dalam panggilan berikutnya untuk hasil `DescribeCertificates` di halaman sertifikat berikutnya.  
Tipe: String

## Kesalahan
<a name="API_DescribeCertificates_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** CertificateNotFound **   
 `CertificateIdentifier` tidak mengacu ke sertifikat yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeCertificates_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeCertificates) 

# DescribeDBClusterParameterGroups
<a name="API_DescribeDBClusterParameterGroups"></a>

Mengembalikan daftar deskripsi `DBClusterParameterGroup`. Jika parameter `DBClusterParameterGroupName` ditentukan, daftar berisi hanya deskripsi grup parameter klaster yang ditentukan. 

## Parameter Permintaan
<a name="API_DescribeDBClusterParameterGroups_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nama grup parameter klaster tertentu yang detailnya dikembalikan.  
Batas:  
+ Jika disediakan, harus cocok dengan nama `DBClusterParameterGroup` yang ada.
Tipe: String  
Wajib: Tidak

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeDBClusterParameterGroups_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 **DBClusterParameterGroups. DBClusterParameterGroup.N**   
Daftar grup parameter klaster.  
Tipe: Array objek [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

## Kesalahan
<a name="API_DescribeDBClusterParameterGroups_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` tidak mengacu ke grup parameter yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeDBClusterParameterGroups_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 

# DescribeDBClusterParameters
<a name="API_DescribeDBClusterParameters"></a>

Mengembalikan daftar parameter mendetail untuk grup parameter klaster tertentu.

## Parameter Permintaan
<a name="API_DescribeDBClusterParameters_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nama grup parameter klaster tertentu yang detail parameternya dikembalikan.  
Batas:  
+ Jika disediakan, harus cocok dengan nama `DBClusterParameterGroup` yang ada.
Tipe: String  
Diperlukan: Ya

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

 ** Source **   
 Nilai yang menunjukkan untuk mengembalikan hanya parameter untuk sumber tertentu. Sumber parameter dapat berupa `engine`, `service`, atau `customer`.   
Tipe: String  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeDBClusterParameters_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

 **Parameter.Parameter.N**   
Menyediakan daftar parameter untuk grup parameter klaster.  
Tipe: Array objek [Parameter](API_Parameter.md)

## Kesalahan
<a name="API_DescribeDBClusterParameters_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` tidak mengacu ke grup parameter yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeDBClusterParameters_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameters) 

# DescribeDBClusters
<a name="API_DescribeDBClusters"></a>

Mengembalikan informasi tentang klaster Amazon DocumentDB yang disediakan. Operasi API ini mendukung pagination (pemberian nomor halaman). Untuk fitur manajemen tertentu seperti manajemen siklus hidup klaster dan instans, Amazon DocumentDB memanfaatkan teknologi operasional yang dibagikan dengan Amazon RDS dan Amazon Neptune. Gunakan parameter filter `filterName=engine,Values=docdb` untuk mengembalikan hanya klaster Amazon DocumentDB.

## Parameter Permintaan
<a name="API_DescribeDBClusters_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Pengidentifikasi klaster yang disediakan pengguna. Jika parameter ini ditentukan, informasi hanya dari klaster tertentu yang dikembalikan. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Jika disediakan, harus cocok dengan `DBClusterIdentifier` yang ada.
Tipe: String  
Wajib: Tidak

 **Filter.Filter.N**   
Filter yang menentukan satu atau lebih klaster untuk dideskripsikan.  
Filter yang didukung:  
+  `db-cluster-id`- Menerima pengidentifikasi cluster dan klaster Amazon Resource Names ()ARNs. Daftar hasil hanya mencakup informasi tentang cluster yang diidentifikasi oleh ini ARNs.
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeDBClusters_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 **DBClusters. DBCluster.N**   
Sebuah daftar klaster.  
Tipe: Array objek [DBCluster](API_DBCluster.md)

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

## Kesalahan
<a name="API_DescribeDBClusters_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeDBClusters_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusters) 

# DescribeDBClusterSnapshotAttributes
<a name="API_DescribeDBClusterSnapshotAttributes"></a>

Mengembalikan daftar nama dan nilai atribut snapshot klaster untuk snapshot klaster DB manual.

Saat Anda berbagi snapshot dengan yang lain Akun AWS, `DescribeDBClusterSnapshotAttributes` mengembalikan `restore` atribut dan daftar IDs untuk Akun AWS yang diizinkan untuk menyalin atau memulihkan snapshot cluster manual. Jika `all` disertakan dalam daftar nilai untuk atribut `restore`, maka snapshot klaster manual bersifat publik dan dapat disalin atau dipulihkan oleh semua Akun AWS.

## Parameter Permintaan
<a name="API_DescribeDBClusterSnapshotAttributes_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterSnapshotIdentifier **   
Pengidentifikasi untuk snapshot klaster untuk mendeskripsikan atributnya.  
Tipe: String  
Diperlukan: Ya

## Elemen Respons
<a name="API_DescribeDBClusterSnapshotAttributes_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBClusterSnapshotAttributesResult **   
Informasi mendetail tentang atribut yang terkait dengan snapshot klaster.  
Tipe: Objek [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)

## Kesalahan
<a name="API_DescribeDBClusterSnapshotAttributes_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` tidak mengacu ke sebuah snapshot klaster yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeDBClusterSnapshotAttributes_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 

# DescribeDBClusterSnapshots
<a name="API_DescribeDBClusterSnapshots"></a>

Mengembalikan informasi tentang snapshot klaster. Operasi API ini mendukung pagination (pemberian nomor halaman).

## Parameter Permintaan
<a name="API_DescribeDBClusterSnapshots_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
ID dari klaster untuk mengambil daftar snapshot klaster. Parameter ini tidak dapat digunakan dengan parameter `DBClusterSnapshotIdentifier`. Parameter ini tidak peka huruf besar kecil.   
Batas:  
+ Jika disediakan, harus cocok dengan pengidentifikasi `DBCluster` yang ada.
Tipe: String  
Wajib: Tidak

 ** DBClusterSnapshotIdentifier **   
Pengidentifikasi snapshot klaster tertentu untuk menggambarkan. Parameter ini tidak dapat digunakan dengan parameter `DBClusterIdentifier`. Nilai ini disimpan sebagai string huruf kecil.   
Batas:  
+ Jika disediakan, harus cocok dengan pengidentifikasi `DBClusterSnapshot` yang ada.
+ Jika pengidentifikasi ini adalah untuk snapshot otomatis, parameter `SnapshotType` juga harus ditentukan.
Tipe: String  
Wajib: Tidak

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** IncludePublic **   
Setel `true` untuk menyertakan snapshot cluster manual yang bersifat publik dan dapat disalin atau dipulihkan oleh siapa pun Akun AWS, dan sebaliknya. `false` Defaultnya adalah `false`.  
Tipe: Boolean  
Wajib: Tidak

 ** IncludeShared **   
Setel `true` untuk menyertakan snapshot cluster manual bersama dari Akun AWS yang lain yang Akun AWS telah diberi izin untuk menyalin atau memulihkan, dan sebaliknya`false`. Defaultnya adalah `false`.  
Tipe: Boolean  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

 ** SnapshotType **   
Jenis snapshot klaster untuk dikembalikan. Anda dapat menentukan salah satu nilai berikut:  
+  `automated` - Mengembalikan semua snapshot klaster yang telah dibuat secara otomatis oleh Amazon DocumentDB untuk Akun AWS Anda.
+  `manual` - Mengembalikan semua snapshot klaster yang telah Anda buat secara manual untuk Akun AWS Anda.
+  `shared` - Mengembalikan semua snapshot klaster manual yang telah dibagikan ke Akun AWS Anda.
+  `public` - Mengembalikan semua snapshot klaster yang telah ditandai sebagai publik.
Jika Anda tidak menentukan nilai `SnapshotType`, maka baik snapshot klaster otomatis dan manual dikembalikan. Anda dapat menyertakan snapshot klaster bersama dengan hasil ini dengan mengatur parameter `IncludeShared` ke `true`. Anda dapat menyertakan snapshot klaster publik dengan hasil ini dengan mengatur parameter `IncludePublic` ke `true`.  
Parameter `IncludeShared` dan `IncludePublic` tidak berlaku untuk nilai `SnapshotType` dari `manual` atau `automated`. Parameter `IncludePublic` tidak berlaku bila `SnapshotType` diatur ke `shared`. Parameter `IncludeShared` tidak berlaku bila `SnapshotType` diatur ke `public`.  
Tipe: String  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeDBClusterSnapshots_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 **DBClusterCuplikan. DBClusterSnapshot.N**   
Menyediakan daftar snapshot klaster.  
Tipe: Array objek [DBClusterSnapshot](API_DBClusterSnapshot.md)

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

## Kesalahan
<a name="API_DescribeDBClusterSnapshots_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` tidak mengacu ke sebuah snapshot klaster yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeDBClusterSnapshots_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 

# DescribeDBEngineVersions
<a name="API_DescribeDBEngineVersions"></a>

Mengembalikan daftar dari mesin yang tersedia.

## Parameter Permintaan
<a name="API_DescribeDBEngineVersions_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBParameterGroupFamily **   
Nama famili grup parameter tertentu yang detailnya dikembalikan.  
Batas:  
+ Jika disediakan, harus cocok dengan `DBParameterGroupFamily` yang ada.
Tipe: String  
Wajib: Tidak

 ** DefaultOnly **   
Menunjukkan bahwa hanya versi default dari mesin tertentu atau mesin dan kombinasi versi utama dikembalikan.  
Tipe: Boolean  
Wajib: Tidak

 ** Engine **   
Mesin basis data untuk mengembalikan.  
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Versi mesin basis data untuk mengembalikan.  
Contoh: `3.6.0`   
Tipe: String  
Wajib: Tidak

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** ListSupportedCharacterSets **   
Jika parameter ini ditentukan dan mesin yang diminta mendukung parameter `CharacterSetName` untuk `CreateDBInstance`, responsnya mencakup daftar set karakter yang didukung untuk setiap versi mesin.   
Tipe: Boolean  
Wajib: Tidak

 ** ListSupportedTimezones **   
Jika parameter ini ditentukan dan mesin yang diminta mendukung parameter `TimeZone` untuk `CreateDBInstance`, responsnya mencakup daftar zona waktu yang didukung untuk setiap versi mesin.   
Tipe: Boolean  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeDBEngineVersions_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 **DBEngineVersi. DBEngine**Versi.N   
Informasi mendetail tentang satu atau lebih versi mesin.  
Tipe: Array objek [DBEngineVersion](API_DBEngineVersion.md)

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

## Kesalahan
<a name="API_DescribeDBEngineVersions_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

## Lihat Juga
<a name="API_DescribeDBEngineVersions_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBEngineVersions) 

# DescribeDBInstances
<a name="API_DescribeDBInstances"></a>

Mengembalikan informasi tentang instans Amazon DocumentDB yang disediakan. API ini mendukung pagination (pemberian nomor halaman).

## Parameter Permintaan
<a name="API_DescribeDBInstances_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBInstanceIdentifier **   
Pengidentifikasi instans yang disediakan pengguna. Jika parameter ini ditentukan, informasi hanya dari instans tertentu yang dikembalikan. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Jika disediakan, harus cocok dengan pengidentifikasi `DBInstance` yang ada.
Tipe: String  
Wajib: Tidak

 **Filter.Filter.N**   
Filter yang menentukan satu atau lebih instans untuk dideskripsikan.  
Filter yang didukung:  
+  `db-cluster-id`- Menerima pengidentifikasi cluster dan klaster Amazon Resource Names ()ARNs. Daftar hasil hanya mencakup informasi tentang contoh yang terkait dengan cluster yang diidentifikasi oleh ini. ARNs
+  `db-instance-id`- Menerima pengidentifikasi instance dan instance. ARNs Daftar hasil hanya mencakup informasi tentang contoh yang diidentifikasi oleh ini ARNs.
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeDBInstances_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 **DBInstances. DBInstance.N**   
Informasi mendetail tentang satu atau lebih instans.   
Tipe: Array objek [DBInstance](API_DBInstance.md)

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

## Kesalahan
<a name="API_DescribeDBInstances_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` tidak mengacu ke sebuah instans yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeDBInstances_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances) 

# DescribeDBSubnetGroups
<a name="API_DescribeDBSubnetGroups"></a>

Mengembalikan daftar deskripsi `DBSubnetGroup`. Jika `DBSubnetGroupName` ditentukan, daftar akan berisi hanya deskripsi dari `DBSubnetGroup` yang ditentukan.

## Parameter Permintaan
<a name="API_DescribeDBSubnetGroups_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBSubnetGroupName **   
Nama grup subnet yang akan dikembalikan detailnya.  
Tipe: String  
Wajib: Tidak

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeDBSubnetGroups_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 **DBSubnetGrup. DBSubnetGrup.N**   
Informasi mendetail tentang satu atau lebih grup subnet.  
Tipe: Array objek [DBSubnetGroup](API_DBSubnetGroup.md)

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

## Kesalahan
<a name="API_DescribeDBSubnetGroups_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` tidak mengacu ke grup subnet yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeDBSubnetGroups_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBSubnetGroups) 

# DescribeEngineDefaultClusterParameters
<a name="API_DescribeEngineDefaultClusterParameters"></a>

Mengembalikan mesin default dan informasi parameter sistem untuk mesin basis data klaster.

## Parameter Permintaan
<a name="API_DescribeEngineDefaultClusterParameters_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBParameterGroupFamily **   
Nama famili grup parameter klaster untuk mengembalikan informasi parameter mesin.  
Tipe: String  
Diperlukan: Ya

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeEngineDefaultClusterParameters_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** EngineDefaults **   
Berisi hasil pemanggilan operasi `DescribeEngineDefaultClusterParameters` yang berhasil.   
Tipe: Objek [EngineDefaults](API_EngineDefaults.md)

## Kesalahan
<a name="API_DescribeEngineDefaultClusterParameters_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

## Lihat Juga
<a name="API_DescribeEngineDefaultClusterParameters_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 

# DescribeEventCategories
<a name="API_DescribeEventCategories"></a>

Menampilkan daftar kategori untuk semua jenis sumber peristiwa, atau, jika ditentukan, untuk jenis sumber tertentu. 

## Parameter Permintaan
<a name="API_DescribeEventCategories_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** SourceType **   
Jenis sumber yang menghasilkan acara.  
Nilai valid: `db-instance`, `db-parameter-group`, `db-security-group`   
Tipe: String  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeEventCategories_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 **EventCategoriesMapList. EventCategoriesMap.N**   
Daftar peta kategori peristiwa.  
Tipe: Array objek [EventCategoriesMap](API_EventCategoriesMap.md)

## Kesalahan
<a name="API_DescribeEventCategories_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

## Lihat Juga
<a name="API_DescribeEventCategories_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventCategories) 

# DescribeEvents
<a name="API_DescribeEvents"></a>

Mengembalikan peristiwa yang terkait dengan instans, grup keamanan, snapshot, dan grup parameter DB selama 14 hari terakhir. Anda dapat memperoleh peristiwa khusus untuk instans DB, grup keamanan, snapshot, atau grup parameter tertentu dengan memberikan nama sebagai parameter. Secara default, peristiwa jam terakhir dikembalikan.

## Parameter Permintaan
<a name="API_DescribeEvents_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** Duration **   
Jumlah menit untuk mengambil peristiwa.  
Default: 60  
Tipe: Integer  
Wajib: Tidak

 ** EndTime **   
 Akhir interval waktu untuk mengambil peristiwa, ditentukan dalam format ISO 8601.   
Contoh: 2009-07-08T18:00Z  
Tipe: Timestamp  
Wajib: Tidak

 **EventCategories. EventCategory.N**   
Daftar kategori peristiwa yang memicu notifikasi untuk langganan notifikasi peristiwa.  
Tipe: Array string  
Wajib: Tidak

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

 ** SourceIdentifier **   
Pengidentifikasi sumber peristiwa yang peristiwanya dikembalikan. Jika tidak ditentukan, maka semua sumber disertakan dalam respons.  
Batas:  
+ Jika `SourceIdentifier` disediakan, `SourceType` juga harus disediakan.
+ Jika jenis sumber adalah `DBInstance`, sebuah `DBInstanceIdentifier` harus disediakan.
+ Jika jenis sumber adalah `DBSecurityGroup`, sebuah `DBSecurityGroupName` harus disediakan.
+ Jika jenis sumber adalah `DBParameterGroup`, sebuah `DBParameterGroupName` harus disediakan.
+ Jika jenis sumber adalah `DBSnapshot`, sebuah `DBSnapshotIdentifier` harus disediakan.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Tipe: String  
Wajib: Tidak

 ** SourceType **   
Sumber peristiwa untuk mengambil peristiwa. Jika tidak ada nilai yang ditentukan, semua peristiwa dikembalikan.  
Tipe: String  
Nilai yang Valid: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
Wajib: Tidak

 ** StartTime **   
 Awal interval waktu untuk mengambil peristiwa, ditentukan dalam format ISO 8601.   
Contoh: 2009-07-08T18:00Z  
Tipe: Timestamp  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeEvents_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 **Peristiwa.Event.N**   
Informasi mendetail tentang satu atau lebih peristiwa.   
Tipe: Array objek [Event](API_Event.md)

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

## Kesalahan
<a name="API_DescribeEvents_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

## Lihat Juga
<a name="API_DescribeEvents_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEvents) 

# DescribeEventSubscriptions
<a name="API_DescribeEventSubscriptions"></a>

Mencantumkan semua deskripsi langganan untuk akun pelanggan. Deskripsi untuk berlangganan termasuk `SubscriptionName`, `SNSTopicARN`, `CustomerID`, `SourceType`, `SourceID`, `CreationTime`, dan `Status`.

Jika Anda menentukan `SubscriptionName`, cantumkan deskripsi untuk langganan tersebut.

## Parameter Permintaan
<a name="API_DescribeEventSubscriptions_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

 ** SubscriptionName **   
Nama langganan notifikasi peristiwa Amazon DocumentDB yang ingin Anda deskripsikan.  
Tipe: String  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeEventSubscriptions_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 **EventSubscriptionsList. EventSubscription.N**   
Daftar langganan peristiwa.  
Tipe: Array objek [EventSubscription](API_EventSubscription.md)

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

## Kesalahan
<a name="API_DescribeEventSubscriptions_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** SubscriptionNotFound **   
Nama langganan tidak ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeEventSubscriptions_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventSubscriptions) 

# DescribeGlobalClusters
<a name="API_DescribeGlobalClusters"></a>

Mengembalikan informasi tentang klaster global Amazon DocumentDB. API ini mendukung pagination (pemberian nomor halaman).

**catatan**  
Tindakan ini hanya berlaku untuk klaster Amazon DocumentDB.

## Parameter Permintaan
<a name="API_DescribeGlobalClusters_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 **Filter.Filter.N**   
Filter yang menentukan satu atau lebih klaster DB global untuk dideskripsikan.  
Filter yang didukung: `db-cluster-id` menerima pengidentifikasi klaster dan mengelompokkan Nama Sumber Daya Amazon ()ARNs. Daftar hasil hanya akan mencakup informasi tentang cluster yang diidentifikasi oleh ini ARNs.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** GlobalClusterIdentifier **   
Pengidentifikasi klaster yang disediakan pengguna. Jika parameter ini ditentukan, informasi hanya dari klaster tertentu yang dikembalikan. Parameter ini tidak peka huruf besar kecil.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan `DescribeGlobalClusters` sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination (pemberian nomor halaman) yang disebut penanda disertakan dalam respons sehingga Anda dapat mengambil hasil yang tersisa.   
Tipe: Integer  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeGlobalClusters_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 **GlobalClusters. GlobalClusterMember.N**   
  
Tipe: Array objek [GlobalCluster](API_GlobalCluster.md)

 ** Marker **   
  
Tipe: String

## Kesalahan
<a name="API_DescribeGlobalClusters_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` tidak mengacu ke sebuah klaster global yang ada.  
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeGlobalClusters_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeGlobalClusters) 

# DescribeOrderableDBInstanceOptions
<a name="API_DescribeOrderableDBInstanceOptions"></a>

Mengembalikan daftar opsi instans yang dapat dipesan untuk mesin yang ditentukan.

## Parameter Permintaan
<a name="API_DescribeOrderableDBInstanceOptions_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** Engine **   
Nama dari mesin untuk mengambil opsi instans.  
Tipe: String  
Diperlukan: Ya

 ** DBInstanceClass **   
Nilai filter kelas instans. Tentukan parameter ini untuk hanya menampilkan penawaran yang tersedia yang cocok dengan kelas instans yang ditentukan.  
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Nilai filter versi mesin. Tentukan parameter ini untuk hanya menampilkan penawaran yang tersedia yang cocok dengan versi mesin yang ditentukan.  
Tipe: String  
Wajib: Tidak

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** LicenseModel **   
Nilai filter model lisensi. Tentukan parameter ini untuk hanya menampilkan penawaran yang tersedia yang cocok dengan model lisensi yang ditentukan.  
Tipe: String  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

 ** Vpc **   
Nilai filter virtual private cloud (VPC). Tentukan parameter ini untuk hanya menampilkan penawaran VPC atau non-VPC yang tersedia.  
Tipe: Boolean  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribeOrderableDBInstanceOptions_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

 **Opsi yang Dapat Dipesan. Opsi yang Dapat DBInstance Dipesankan.N DBInstance**   
Opsi yang tersedia untuk instans tertentu yang dapat dipesan.  
Tipe: Array objek [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md)

## Kesalahan
<a name="API_DescribeOrderableDBInstanceOptions_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

## Lihat Juga
<a name="API_DescribeOrderableDBInstanceOptions_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 

# DescribePendingMaintenanceActions
<a name="API_DescribePendingMaintenanceActions"></a>

Mengembalikan daftar sumber daya (misalnya, instans) yang memiliki setidaknya satu tindakan pemeliharaan tertunda.

## Parameter Permintaan
<a name="API_DescribePendingMaintenanceActions_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 **Filter.Filter.N**   
Filter yang menentukan satu atau lebih sumber daya untuk mengembalikan tindakan pemeliharaan yang tertunda.  
Filter yang didukung:  
+  `db-cluster-id`- Menerima pengidentifikasi cluster dan klaster Amazon Resource Names ()ARNs. Daftar hasil hanya mencakup tindakan pemeliharaan yang tertunda untuk klaster yang diidentifikasi oleh ini ARNs.
+  `db-instance-id`- Menerima pengidentifikasi instance dan instance. ARNs Daftar hasil hanya mencakup tindakan pemeliharaan yang tertunda untuk instans DB yang diidentifikasi oleh ini ARNs.
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** MaxRecords **   
 Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai `MaxRecords` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Default: 100  
Kendala: Minimum 20, maksimum 100.  
Tipe: Integer  
Wajib: Tidak

 ** ResourceIdentifier **   
ARN dari sumber daya untuk mengembalikan tindakan pemeliharaan yang tertunda.  
Tipe: String  
Wajib: Tidak

## Elemen Respons
<a name="API_DescribePendingMaintenanceActions_ResponseElements"></a>

Elemen-elemen berikut dikembalikan oleh layanan.

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String

 **PendingMaintenanceActions. ResourcePendingMaintenanceActions.N**   
Tindakan pemeliharaan yang akan diterapkan.  
Tipe: Array objek [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)

## Kesalahan
<a name="API_DescribePendingMaintenanceActions_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** ResourceNotFoundFault **   
ID sumber daya yang ditentukan tidak ditemukan.  
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribePendingMaintenanceActions_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 

# FailoverDBCluster
<a name="API_FailoverDBCluster"></a>

Memaksa failover untuk sebuah klaster.

Failover untuk klaster mempromosikan salah satu replika Amazon DocumentDB (instans hanya-baca) di klaster menjadi instans primer (penulis klaster).

Jika instans primer gagal, Amazon DocumentDB secara otomatis gagal ke replika Amazon DocumentDB, jika ada. Anda dapat memaksa failover saat ingin mensimulasikan kegagalan instans primer untuk pengujian.

## Parameter Permintaan
<a name="API_FailoverDBCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Pengidentifikasi klaster untuk memaksa failover. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus cocok dengan pengidentifikasi `DBCluster` yang ada.
Tipe: String  
Wajib: Tidak

 ** TargetDBInstanceIdentifier **   
Nama instans yang akan dipromosikan ke instans primer.  
Anda harus menentukan pengidentifikasi instans untuk replika Amazon DocumentDB di klaster. Misalnya, `mydbcluster-replica1`.  
Tipe: String  
Wajib: Tidak

## Elemen Respons
<a name="API_FailoverDBCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBCluster **   
Informasi mendetail tentang klaster.   
Tipe: Objek [DBCluster](API_DBCluster.md)

## Kesalahan
<a name="API_FailoverDBCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidDBInstanceState **   
 Instans yang ditentukan tidak dalam status *tersedia*.   
Kode Status HTTP: 400

## Lihat Juga
<a name="API_FailoverDBCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster) 

# FailoverGlobalCluster
<a name="API_FailoverGlobalCluster"></a>

Mempromosikan cluster DB sekunder yang ditentukan untuk menjadi cluster DB utama di cluster global ketika kegagalan atas cluster global terjadi.

Gunakan operasi ini untuk menanggapi peristiwa yang tidak direncanakan, seperti bencana regional di wilayah primer. Kegagalan dapat mengakibatkan hilangnya data transaksi tulis yang tidak direplikasi ke sekunder yang dipilih sebelum peristiwa failover terjadi. Namun, proses pemulihan yang mempromosikan instans DB pada cluster DB hari kedua yang dipilih menjadi instans DB penulis utama menjamin bahwa data dalam keadaan konsisten secara transaksional.

## Parameter Permintaan
<a name="API_FailoverGlobalCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Pengidentifikasi cluster global Amazon DocumentDB untuk menerapkan operasi ini. Identifier adalah kunci unik yang ditetapkan oleh pengguna saat cluster dibuat. Dengan kata lain, itu adalah nama cluster global.  
Batas:  
+ Harus cocok dengan pengidentifikasi klaster global yang ada.
+ Panjang minimum 1. Panjang maksimum 255.
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Wajib: Ya

 ** TargetDbClusterIdentifier **   
Pengidentifikasi klaster Amazon DocumentDB sekunder yang ingin Anda promosikan ke klaster utama untuk klaster global. Gunakan Amazon Resource Name (ARN) untuk pengidentifikasi sehingga Amazon DocumentDB dapat menemukan cluster di wilayahnya. AWS   
Batas:  
+ Harus cocok dengan identifier dari cluster sekunder yang ada.
+ Panjang minimum 1. Panjang maksimum 255.
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Wajib: Ya

 ** AllowDataLoss **   
Menentukan apakah untuk memungkinkan kehilangan data untuk operasi cluster global ini. Mengizinkan kehilangan data memicu operasi failover global.  
Jika Anda tidak menentukan`AllowDataLoss`, operasi cluster global default ke switchover.  
Batas:  
+ Tidak dapat ditentukan bersama dengan `Switchover` parameter.
Tipe: Boolean  
Wajib: Tidak

 ** Switchover **   
Menentukan apakah akan beralih ke cluster database global ini.  
Batas:  
+ Tidak dapat ditentukan bersama dengan `AllowDataLoss` parameter.
Tipe: Boolean  
Wajib: Tidak

## Elemen Respons
<a name="API_FailoverGlobalCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** GlobalCluster **   
Sebuah tipe data yang mewakili sebuah klaster global Amazon DocumentDB.  
Tipe: Objek [GlobalCluster](API_GlobalCluster.md)

## Kesalahan
<a name="API_FailoverGlobalCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` tidak mengacu ke sebuah klaster global yang ada.  
Kode Status HTTP: 404

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidGlobalClusterStateFault **   
Operasi yang diminta tidak dapat dilakukan saat klaster dalam keadaan ini.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_FailoverGlobalCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverGlobalCluster) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Mencantumkan semua tag pada sumber daya Amazon DocumentDB.

## Parameter Permintaan
<a name="API_ListTagsForResource_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** ResourceName **   
Sumber daya Amazon DocumentDB dengan tag untuk dicantumkan. Nilai ini adalah sebuah Amazon Resource Name (ARN).  
Tipe: String  
Diperlukan: Ya

 **Filter.Filter.N**   
Parameter ini saat ini tidak didukung.  
Tipe: Array objek [Filter](API_Filter.md)  
Wajib: Tidak

## Elemen Respons
<a name="API_ListTagsForResource_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 **TagList.Tag.N**   
Daftar dari satu atau beberapa tag.  
Tipe: Array objek [Tag](API_Tag.md)

## Kesalahan
<a name="API_ListTagsForResource_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` tidak mengacu ke sebuah instans yang ada.   
Kode Status HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` tidak mengacu ke sebuah snapshot yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_ListTagsForResource_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ListTagsForResource) 

# ModifyDBCluster
<a name="API_ModifyDBCluster"></a>

Memodifikasi pengaturan untuk klaster Amazon DocumentDB. Anda dapat mengubah satu atau lebih parameter konfigurasi basis data dengan menentukan parameter ini dan nilai-nilai baru dalam permintaan. 

## Parameter Permintaan
<a name="API_ModifyDBCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Pengidentifikasi klaster untuk klaster yang sedang dimodifikasi. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus cocok dengan pengidentifikasi `DBCluster` yang ada.
Tipe: String  
Diperlukan: Ya

 ** AllowMajorVersionUpgrade **   
Nilai yang menunjukkan apakah pembaruan versi utama diizinkan.  
Batas:  
+ Anda harus mengizinkan upgrade versi mayor saat menentukan nilai untuk `EngineVersion` parameter yang merupakan versi mayor yang berbeda dari versi cluster saat ini.
+ Karena beberapa parameter bersifat spesifik versi, mengubahnya memerlukan eksekusi panggilan `ModifyDBCluster` API baru setelah MVU di tempat selesai.
Melakukan MVU secara langsung berdampak pada parameter berikut:  
+  `MasterUserPassword` 
+  `NewDBClusterIdentifier` 
+  `VpcSecurityGroupIds` 
+  `Port` 
Tipe: Boolean  
Wajib: Tidak

 ** ApplyImmediately **   
Nilai yang menentukan apakah perubahan dalam permintaan ini dan perubahan yang tertunda diterapkan secara asinkron sesegera mungkin, terlepas dari pengaturan `PreferredMaintenanceWindow` untuk klaster. Jika parameter ini diatur ke `false`, perubahan ke klaster diterapkan selama jendela pemeliharaan berikutnya.  
Parameter `ApplyImmediately` memengaruhi hanya nilai `NewDBClusterIdentifier` dan `MasterUserPassword`. Jika Anda mengatur nilai parameter ini ke `false`, perubahan nilai `NewDBClusterIdentifier` dan `MasterUserPassword` diterapkan selama jendela pemeliharaan berikutnya. Semua perubahan lainnya akan diterapkan dengan segera, terlepas dari nilai parameter `ApplyImmediately`.  
Default: `false`   
Jenis: Boolean  
Wajib: Tidak

 ** BackupRetentionPeriod **   
Jumlah hari penyimpanan cadangan otomatis. Anda harus menentukan nilai minimum 1.  
Default: 1  
Batas:  
+ Harus berupa nilai dari 1 hingga 35.
Tipe: Integer  
Wajib: Tidak

 ** CloudwatchLogsExportConfiguration **   
Pengaturan konfigurasi untuk jenis log yang akan diaktifkan untuk diekspor ke Amazon CloudWatch Logs untuk instance atau cluster tertentu. `DisableLogTypes`Array `EnableLogTypes` dan menentukan log mana yang diekspor (atau tidak diekspor) ke Log. CloudWatch   
Tipe: Objek [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md)  
Wajib: Tidak

 ** DBClusterParameterGroupName **   
Nama grup parameter klaster yang digunakan untuk klaster.  
Tipe: String  
Wajib: Tidak

 ** DeletionProtection **   
Menentukan apakah klaster ini dapat dihapus. Jika `DeletionProtection` diaktifkan, klaster tidak dapat dihapus kecuali jika diubah dan `DeletionProtection` dinonaktifkan. `DeletionProtection` melindungi klaster agar tidak terhapus secara tidak sengaja.  
Tipe: Boolean  
Wajib: Tidak

 ** EngineVersion **   
Nomor versi mesin basis data yang ingin Anda tingkatkan. Mengubah parameter ini menghasilkan pemadaman. Perubahan diterapkan selama jendela pemeliharaan berikutnya kecuali `ApplyImmediately` diaktifkan.  
Untuk daftar semua versi engine yang tersedia untuk Amazon DocumentDB gunakan perintah berikut:  
 `aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"`   
Tipe: String  
Wajib: Tidak

 ** ManageMasterUserPassword **   
Menentukan apakah akan mengelola kata sandi pengguna utama dengan Amazon Web Services Secrets Manager. Jika klaster tidak mengelola kata sandi pengguna utama dengan Amazon Web Services Secrets Manager, Anda dapat mengaktifkan manajemen ini. Dalam hal ini, Anda tidak dapat menentukan`MasterUserPassword`. Jika cluster sudah mengelola kata sandi pengguna master dengan Amazon Web Services Secrets Manager, dan Anda menentukan bahwa kata sandi pengguna master tidak dikelola dengan Amazon Web Services Secrets Manager, maka Anda harus menentukan`MasterUserPassword`. Dalam hal ini, Amazon DocumentDB menghapus rahasia dan menggunakan kata sandi baru untuk pengguna utama yang ditentukan oleh. `MasterUserPassword`  
Tipe: Boolean  
Wajib: Tidak

 ** MasterUserPassword **   
Kata sandi untuk pengguna basis data utama. Kata sandi ini dapat berisi karakter ASCII apa pun yang dapat dicetak kecuali garis miring (/), tanda kutip ganda ("), atau simbol "at" (@).  
Kendala: Harus berisi dari 8 hingga 100 karakter.  
Tipe: String  
Wajib: Tidak

 ** MasterUserSecretKmsKeyId **   
Pengidentifikasi kunci Amazon Web Services KMS untuk mengenkripsi rahasia yang dibuat dan dikelola secara otomatis di Amazon Web Services Secrets Manager.  
Pengaturan ini hanya berlaku jika kedua kondisi berikut terpenuhi:  
+ Cluster tidak mengelola kata sandi pengguna utama di Amazon Web Services Secrets Manager. Jika cluster sudah mengelola kata sandi pengguna utama di Amazon Web Services Secrets Manager, Anda tidak dapat mengubah kunci KMS yang digunakan untuk mengenkripsi rahasia.
+ Anda memungkinkan `ManageMasterUserPassword` untuk mengelola kata sandi pengguna utama di Amazon Web Services Secrets Manager. Jika Anda menyalakan `ManageMasterUserPassword` dan tidak menentukan`MasterUserSecretKmsKeyId`, maka kunci `aws/secretsmanager` KMS digunakan untuk mengenkripsi rahasia. Jika rahasianya ada di akun Amazon Web Services yang berbeda, maka Anda tidak dapat menggunakan kunci `aws/secretsmanager` KMS untuk mengenkripsi rahasia, dan Anda harus menggunakan kunci KMS yang dikelola pelanggan.
Pengidentifikasi kunci Amazon Web Services KMS adalah kunci ARN, ID kunci, alias ARN, atau nama alias untuk kunci KMS. Untuk menggunakan kunci KMS di akun Amazon Web Services yang berbeda, tentukan kunci ARN atau alias ARN.  
Ada kunci KMS default untuk akun Amazon Web Services Anda. Akun Amazon Web Services Anda memiliki kunci KMS default yang berbeda untuk setiap Wilayah Amazon Web Services.  
Tipe: String  
Wajib: Tidak

 ** NetworkType **   
Jenis jaringan cluster.  
Jenis jaringan ditentukan oleh yang `DBSubnetGroup` ditentukan untuk cluster. A hanya `DBSubnetGroup` dapat mendukung IPv4 protokol atau IPv4 dan IPv6 protokol ()`DUAL`.  
Untuk informasi selengkapnya, lihat [cluster DocumentDB di VPC di Panduan Pengembang Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html).  
Nilai Valid: `IPV4` \$1 `DUAL`   
Tipe: String  
Wajib: Tidak

 ** NewDBClusterIdentifier **   
Pengidentifikasi klaster baru untuk klaster ketika mengubah nama klaster. Nilai ini disimpan sebagai string huruf kecil.  
Kendala:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Contoh: `my-cluster2`   
Tipe: String  
Wajib: Tidak

 ** Port **   
Nomor port tempat klaster menerima koneksi.  
Kendala: Harus berupa nilai dari `1150` hingga `65535`.   
Default: Port yang sama dengan klaster asli.  
Tipe: Integer  
Wajib: Tidak

 ** PreferredBackupWindow **   
Kisaran waktu harian selama backup otomatis dibuat jika backup otomatis diaktifkan, menggunakan parameter `BackupRetentionPeriod`.   
Defaultnya adalah jendela 30 menit yang dipilih secara acak dari blok waktu 8 jam untuk masing-masing. Wilayah AWS  
Batas:  
+ Harus dalam format `hh24:mi-hh24:mi`.
+ Harus dalam Waktu Universal Terkoordinasi (UTC).
+ Tidak boleh bertentangan dengan jendela pemeliharaan yang diinginkan.
+ Harus setidaknya 30 menit.
Tipe: String  
Wajib: Tidak

 ** PreferredMaintenanceWindow **   
Rentang waktu mingguan selama pemeliharaan sistem dapat terjadi, dalam Waktu Universal Terkoordinasi (UTC).  
Format: `ddd:hh24:mi-ddd:hh24:mi`   
Defaultnya adalah jendela 30 menit yang dipilih secara acak dari blok waktu 8 jam untuk masing-masing Wilayah AWS, terjadi pada hari acak dalam seminggu.   
Hari yang valid: Sen, Sel, Rab, Kam, Jum, Sab, Min  
Kendala: Minimum 30 menit jendela.  
Tipe: String  
Wajib: Tidak

 ** RotateMasterUserPassword **   
Menentukan apakah akan memutar rahasia yang dikelola oleh Amazon Web Services Secrets Manager untuk kata sandi pengguna utama.  
Pengaturan ini hanya berlaku jika kata sandi pengguna utama dikelola oleh Amazon DocumentDB di Amazon Web Services Secrets Manager untuk cluster. Nilai rahasia berisi kata sandi yang diperbarui.  
Kendala: Anda harus segera menerapkan perubahan saat memutar kata sandi pengguna utama.  
Tipe: Boolean  
Wajib: Tidak

 ** ServerlessV2ScalingConfiguration **   
Berisi konfigurasi penskalaan cluster Amazon DocumentDB Tanpa Server.  
Tipe: Objek [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Wajib: Tidak

 ** StorageType **   
Jenis penyimpanan untuk dikaitkan dengan cluster DB.  
Untuk informasi tentang jenis penyimpanan untuk klaster Amazon DocumentDB, lihat Konfigurasi penyimpanan klaster di Panduan Pengembang *Amazon* DocumentDB.  
Nilai yang valid untuk jenis penyimpanan - `standard | iopt1`   
Nilai default adalah `standard `   
Tipe: String  
Wajib: Tidak

 **VpcSecurityGroupIds. VpcSecurityGroupId.N**   
Daftar grup keamanan virtual private cloud (VPC) tempat klaster akan berada.  
Tipe: Array string  
Wajib: Tidak

## Elemen Respons
<a name="API_ModifyDBCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBCluster **   
Informasi mendetail tentang klaster.   
Tipe: Objek [DBCluster](API_DBCluster.md)

## Kesalahan
<a name="API_ModifyDBCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
Anda sudah memiliki klaster dengan pengidentifikasi yang diberikan.  
Kode Status HTTP: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` tidak mengacu ke grup parameter klaster yang ada.   
Kode Status HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` tidak mengacu ke grup subnet yang ada.   
Kode Status HTTP: 404

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidDBInstanceState **   
 Instans yang ditentukan tidak dalam status *tersedia*.   
Kode Status HTTP: 400

 ** InvalidDBSecurityGroupState **   
Status grup keamanan tidak mengizinkan penghapusan.  
Kode Status HTTP: 400

 ** InvalidDBSubnetGroupStateFault **   
Grup subnet tidak dapat dihapus karena sedang digunakan.  
Kode Status HTTP: 400

 ** InvalidSubnet **   
Subnet yang diminta tidak valid, atau beberapa subnet yang diminta tidak semuanya berada dalam virtual private cloud (VPC) yang umum.  
Kode Status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
Grup subnet tidak mencakup semua Availability Zone setelah dibuat karena perubahan yang dibuat.  
Kode Status HTTP: 400

 ** NetworkTypeNotSupported **   
Jenis jaringan tidak didukung oleh salah satu `DBSubnetGroup` atau versi mesin DB.  
Kode Status HTTP: 400

 ** StorageQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah penyimpanan yang diizinkan yang tersedia di semua instans.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_ModifyDBCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster) 

# ModifyDBClusterParameterGroup
<a name="API_ModifyDBClusterParameterGroup"></a>

 Memodifikasi parameter dari grup parameter klaster. Untuk mengubah lebih dari satu parameter, kirimkan daftar berikut ini: `ParameterName`, `ParameterValue`, dan `ApplyMethod`. Maksimum 20 parameter dapat dimodifikasi dalam satu permintaan. 

**catatan**  
Perubahan pada parameter dinamis diterapkan segera. Perubahan pada parameter statis memerlukan boot ulang atau jendela pemeliharaan sebelum perubahan dapat diterapkan.

**penting**  
Setelah Anda membuat grup parameter klaster, Anda harus menunggu setidaknya 5 menit sebelum membuat klaster pertama Anda yang menggunakan grup parameter klaster tersebut sebagai grup parameter default. Ini memungkinkan Amazon DocumentDB untuk menyelesaikan sepenuhnya tindakan pembuatan sebelum grup parameter digunakan sebagai default untuk klaster baru. Langkah ini sangat penting untuk parameter yang sangat penting saat membuat basis data default untuk sebuah klaster, seperti kumpulan karakter untuk basis data default yang ditentukan oleh parameter `character_set_database`.

## Parameter Permintaan
<a name="API_ModifyDBClusterParameterGroup_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nama grup parameter klaster yang akan dimodifikasi.  
Tipe: String  
Diperlukan: Ya

 **Parameter.Parameter.N**   
Daftar parameter dalam grup parameter klaster untuk dimodifikasi.  
Tipe: Array objek [Parameter](API_Parameter.md)  
Wajib: Ya

## Elemen Respons
<a name="API_ModifyDBClusterParameterGroup_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBClusterParameterGroupName **   
Nama sebuah grup parameter klaster.  
Batas:  
+ Harus dari 1 hingga 255 huruf atau angka.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Nilai ini disimpan sebagai string huruf kecil.
Tipe: String

## Kesalahan
<a name="API_ModifyDBClusterParameterGroup_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` tidak mengacu ke grup parameter yang ada.   
Kode Status HTTP: 404

 ** InvalidDBParameterGroupState **   
Grup parameter sedang digunakan, atau dalam keadaan tidak valid. Jika Anda mencoba menghapus grup parameter, Anda tidak dapat menghapusnya ketika grup parameter berada dalam keadaan ini.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_ModifyDBClusterParameterGroup_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 

# ModifyDBClusterSnapshotAttribute
<a name="API_ModifyDBClusterSnapshotAttribute"></a>

Menambahkan atribut dan nilai-nilai ke, atau menghapus atribut dan nilai-nilai dari, snapshot klaster manual.

Untuk berbagi snapshot cluster manual dengan yang lain Akun AWS, tentukan `restore` sebagai`AttributeName`, dan gunakan `ValuesToAdd` parameter untuk menambahkan IDs daftar Akun AWS yang diizinkan untuk memulihkan snapshot cluster manual. Gunakan nilai `all` untuk membuat snapshot klaster manual menjadi publik, yang berarti bahwa itu dapat disalin atau dipulihkan oleh semua Akun AWS. Jangan menambahkan nilai `all` untuk setiap snapshot klaster manual yang berisi informasi privat yang Anda tidak ingin tersedia untuk semua Akun AWS. Jika snapshot cluster manual dienkripsi, itu dapat dibagikan, tetapi hanya dengan menentukan daftar yang Akun AWS IDs diotorisasi untuk parameter. `ValuesToAdd` Anda tidak dapat menggunakan `all` sebagai nilai untuk parameter tersebut dalam kasus ini.

## Parameter Permintaan
<a name="API_ModifyDBClusterSnapshotAttribute_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** AttributeName **   
Nama dari atribut snapshot klaster yang akan diubah.  
Untuk mengelola otorisasi bagi orang lain Akun AWS untuk menyalin atau memulihkan snapshot cluster manual, tetapkan nilai ini ke. `restore`  
Tipe: String  
Diperlukan: Ya

 ** DBClusterSnapshotIdentifier **   
Pengidentifikasi untuk snapshot klaster untuk memodifikasi atributnya.  
Tipe: String  
Diperlukan: Ya

 **ValuesToAdd. AttributeValue.N**   
Daftar atribut snapshot klaster untuk ditambahkan ke atribut yang ditentukan oleh `AttributeName`.  
Untuk mengotorisasi Akun AWS orang lain untuk menyalin atau memulihkan snapshot cluster manual, atur daftar ini untuk menyertakan satu atau lebih. Akun AWS IDs Untuk membuat snapshot cluster manual dapat dipulihkan oleh siapa pun Akun AWS, setel ke. `all` Jangan menambahkan nilai `all` untuk setiap snapshot klaster manual yang berisi informasi privat yang Anda tidak ingin menjadi tersedia untuk semua Akun AWS.  
Tipe: Array string  
Wajib: Tidak

 **ValuesToRemove. AttributeValue.N**   
Daftar atribut snapshot klaster untuk dihapus dari atribut yang ditentukan oleh `AttributeName`.  
Untuk menghapus otorisasi bagi orang lain Akun AWS untuk menyalin atau memulihkan snapshot cluster manual, atur daftar ini untuk menyertakan satu atau beberapa Akun AWS pengidentifikasi. Untuk menghapus otorisasi Akun AWS untuk menyalin atau memulihkan snapshot cluster, atur ke. `all` Jika Anda menentukan`all`, ID Akun AWS akunnya secara eksplisit ditambahkan ke `restore` atribut masih dapat menyalin atau memulihkan snapshot cluster manual.  
Tipe: Array string  
Wajib: Tidak

## Elemen Respons
<a name="API_ModifyDBClusterSnapshotAttribute_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBClusterSnapshotAttributesResult **   
Informasi mendetail tentang atribut yang terkait dengan snapshot klaster.  
Tipe: Objek [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)

## Kesalahan
<a name="API_ModifyDBClusterSnapshotAttribute_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` tidak mengacu ke sebuah snapshot klaster yang ada.   
Kode Status HTTP: 404

 ** InvalidDBClusterSnapshotStateFault **   
Nilai yang diberikan bukan status snapshot klaster yang valid.  
Kode Status HTTP: 400

 ** SharedSnapshotQuotaExceeded **   
Anda telah melampaui jumlah maksimum akun yang dapat Anda bagikan snapshot DB manual.   
Kode Status HTTP: 400

## Lihat Juga
<a name="API_ModifyDBClusterSnapshotAttribute_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 

# ModifyDBInstance
<a name="API_ModifyDBInstance"></a>

Memodifikasi pengaturan untuk sebuah instans. Anda dapat mengubah satu atau lebih parameter konfigurasi basis data dengan menentukan parameter ini dan nilai-nilai baru dalam permintaan.

## Parameter Permintaan
<a name="API_ModifyDBInstance_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBInstanceIdentifier **   
Pengidentifikasi instans. Nilai ini disimpan sebagai string huruf kecil.  
Batas:  
+ Harus cocok dengan pengidentifikasi `DBInstance` yang ada.
Tipe: String  
Diperlukan: Ya

 ** ApplyImmediately **   
Menentukan apakah modifikasi dalam permintaan ini dan modifikasi yang tertunda diterapkan secara asinkron sesegera mungkin, terlepas dari pengaturan `PreferredMaintenanceWindow` untuk instans.   
 Jika parameter ini diatur ke `false`, perubahan ke instans diterapkan selama jendela pemeliharaan berikutnya. Beberapa perubahan parameter dapat menyebabkan pemadaman dan diterapkan pada boot ulang berikutnya.  
Default: `false`   
Jenis: Boolean  
Wajib: Tidak

 ** AutoMinorVersionUpgrade **   
Parameter ini tidak berlaku untuk Amazon DocumentDB. Amazon DocumentDB tidak melakukan peningkatan versi minor terlepas dari nilai yang ditetapkan.  
Tipe: Boolean  
Wajib: Tidak

 ** CACertificateIdentifier **   
Menunjukkan sertifikat yang perlu dikaitkan dengan instans.  
Tipe: String  
Wajib: Tidak

 ** CertificateRotationRestart **   
Menentukan apakah instans DB dimulai ulang ketika Anda memutar sertifikat Anda. SSL/TLS   
Secara default, instans DB dimulai ulang saat Anda memutar sertifikat Anda. SSL/TLS Sertifikat tidak diperbarui sampai instans DB dimulai ulang.  
Atur parameter ini hanya jika Anda *tidak* menggunakan SSL/TLS untuk terhubung ke instans DB.
*Jika Anda menggunakan SSL/TLS untuk menyambung ke instans DB, lihat [Memperbarui Sertifikat Amazon DocumentDB TLS Anda](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) [dan Mengenkripsi Data dalam Transit di](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) Panduan Pengembang Amazon DocumentDB.*  
Tipe: Boolean  
Wajib: Tidak

 ** CopyTagsToSnapshot **   
Nilai yang menunjukkan apakah akan menyalin semua tag dari instans DB ke snapshot dari instans DB. Secara default, tanda tidak disalin.  
Tipe: Boolean  
Wajib: Tidak

 ** DBInstanceClass **   
Kapasitas komputasi dan memori baru dari instans; misalnya, `db.r5.large`. Tidak semua kelas instans tersedia di semua Wilayah AWS.   
Jika Anda memodifikasi kelas instans, pemadaman terjadi selama perubahan. Perubahan diterapkan selama jendela pemeliharaan berikutnya, kecuali `ApplyImmediately` ditentukan sebagai `true` untuk permintaan ini.   
Default: Menggunakan pengaturan yang ada.  
Tipe: String  
Wajib: Tidak

 ** EnablePerformanceInsights **   
Nilai yang menunjukkan apakah akan mengaktifkan Performance Insights untuk Instans DB. Untuk informasi selengkapnya, lihat [Menggunakan Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).  
Tipe: Boolean  
Wajib: Tidak

 ** NewDBInstanceIdentifier **   
 Pengidentifikasi instans baru untuk instans saat mengganti nama instans. Ketika Anda mengubah pengidentifikasi instans, boot ulang instans terjadi segera jika Anda mengatur `Apply Immediately` ke `true`. Ini terjadi selama jendela pemeliharaan berikutnya jika Anda mengatur `Apply Immediately` ke `false`. Nilai ini disimpan sebagai string huruf kecil.   
Kendala:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Contoh: `mydbinstance`   
Tipe: String  
Wajib: Tidak

 ** PerformanceInsightsKMSKeyId **   
Pengenal AWS KMS kunci untuk enkripsi data Performance Insights.  
Pengidentifikasi AWS KMS kunci adalah ARN kunci, ID kunci, alias ARN, atau nama alias untuk kunci KMS.  
Jika Anda tidak menentukan nilai untuk PerformanceInsights KMSKey Id, maka Amazon DocumentDB menggunakan kunci KMS default Anda. Ada kunci KMS default untuk akun Amazon Web Services Anda. Akun Amazon Web Services Anda memiliki kunci KMS default yang berbeda untuk setiap wilayah Amazon Web Services.  
Tipe: String  
Wajib: Tidak

 ** PreferredMaintenanceWindow **   
Rentang waktu mingguan (dalam UTC) untuk melakukan pemeliharaan sistem dapat terjadi, yang dapat mengakibatkan pemadaman. Mengubah parameter ini tidak mengakibatkan pemadaman kecuali dalam situasi berikut, dan perubahan diterapkan secara asinkron sesegera mungkin. Jika ada tindakan tertunda yang menyebabkan boot ulang, dan jendela pemeliharaan diubah untuk menyertakan waktu saat ini, mengubah parameter ini akan menyebabkan boot ulang instans. Jika Anda memindahkan jendela ke waktu saat ini, harus ada minimal 30 menit antara waktu saat ini dan waktu selesai jendela untuk memastikan bahwa setiap perubahan yang tertunda sudah diterapkan.  
Default: Menggunakan pengaturan yang ada.  
Format: `ddd:hh24:mi-ddd:hh24:mi`   
Hari yang valid: Sen, Sel, Rab, Kam, Jum, Sab, Min  
Kendala: Harus setidaknya 30 menit.  
Tipe: String  
Wajib: Tidak

 ** PromotionTier **   
Nilai yang menentukan urutan di mana replika Amazon DocumentDB dipromosikan ke instans primer setelah kegagalan instans primer yang ada.  
Default: 1  
Nilai yang valid: 0-15  
Tipe: Integer  
Wajib: Tidak

## Elemen Respons
<a name="API_ModifyDBInstance_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBInstance **   
Informasi mendetail tentang sebuah instans.   
Tipe: Objek [DBInstance](API_DBInstance.md)

## Kesalahan
<a name="API_ModifyDBInstance_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AuthorizationNotFound **   
Grup keamanan CIDR IP atau Amazon EC2 yang ditentukan tidak diotorisasi untuk grup keamanan yang ditentukan.  
Amazon DocumentDB juga mungkin tidak diizinkan untuk melakukan tindakan yang diperlukan atas nama Anda menggunakan IAM.  
Kode Status HTTP: 404

 ** CertificateNotFound **   
 `CertificateIdentifier` tidak mengacu ke sertifikat yang ada.   
Kode Status HTTP: 404

 ** DBInstanceAlreadyExists **   
Anda sudah memiliki instans dengan pengidentifikasi yang diberikan.  
Kode Status HTTP: 400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` tidak mengacu ke sebuah instans yang ada.   
Kode Status HTTP: 404

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` tidak mengacu ke grup parameter yang ada.   
Kode Status HTTP: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` tidak mengacu ke grup keamanan yang ada.   
Kode Status HTTP: 404

 ** DBUpgradeDependencyFailure **   
Peningkatan gagal karena sumber daya yang tempat bergantung tidak dapat diubah.  
Kode Status HTTP: 400

 ** InsufficientDBInstanceCapacity **   
Kelas instans yang ditentukan tidak tersedia di Availability Zone yang ditentukan.  
Kode Status HTTP: 400

 ** InvalidDBInstanceState **   
 Instans yang ditentukan tidak dalam status *tersedia*.   
Kode Status HTTP: 400

 ** InvalidDBSecurityGroupState **   
Status grup keamanan tidak mengizinkan penghapusan.  
Kode Status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
Grup subnet tidak mencakup semua Availability Zone setelah dibuat karena perubahan yang dibuat.  
Kode Status HTTP: 400

 ** StorageQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah penyimpanan yang diizinkan yang tersedia di semua instans.  
Kode Status HTTP: 400

 ** StorageTypeNotSupported **   
Penyimpanan `StorageType` yang ditentukan tidak dapat dikaitkan dengan instans DB.   
Kode Status HTTP: 400

## Lihat Juga
<a name="API_ModifyDBInstance_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBInstance) 

# ModifyDBSubnetGroup
<a name="API_ModifyDBSubnetGroup"></a>

Memodifikasi grup subnet yang ada. Grup subnet harus berisi setidaknya satu subnet di setidaknya dua Availability Zone di Wilayah AWS.

## Parameter Permintaan
<a name="API_ModifyDBSubnetGroup_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBSubnetGroupName **   
Nama grup subnet. Nilai ini disimpan sebagai string huruf kecil. Anda tidak dapat memodifikasi grup subnet default.   
Kendala: Harus cocok dengan nama `DBSubnetGroup` yang ada. Tidak harus default.  
Contoh: `mySubnetgroup`   
Tipe: String  
Diperlukan: Ya

 **SubnetIds. SubnetIdentifier.N**   
Subnet Amazon EC2 IDs untuk grup subnet.  
Tipe: Array string  
Wajib: Ya

 ** DBSubnetGroupDescription **   
Deskripsi untuk grup subnet.  
Tipe: String  
Wajib: Tidak

## Elemen Respons
<a name="API_ModifyDBSubnetGroup_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBSubnetGroup **   
Informasi mendetail tentang grup subnet.   
Tipe: Objek [DBSubnetGroup](API_DBSubnetGroup.md)

## Kesalahan
<a name="API_ModifyDBSubnetGroup_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
Subnet dalam grup subnet harus mencakup setidaknya dua Availability Zone kecuali hanya ada satu Availability Zone.  
Kode Status HTTP: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` tidak mengacu ke grup subnet yang ada.   
Kode Status HTTP: 404

 ** DBSubnetQuotaExceededFault **   
Permintaan akan menyebabkan Anda melebihi jumlah subnet yang diizinkan dalam grup subnet.  
Kode Status HTTP: 400

 ** InvalidSubnet **   
Subnet yang diminta tidak valid, atau beberapa subnet yang diminta tidak semuanya berada dalam virtual private cloud (VPC) yang umum.  
Kode Status HTTP: 400

 ** SubnetAlreadyInUse **   
Subnet sudah digunakan di Availability Zone.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_ModifyDBSubnetGroup_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBSubnetGroup) 

# ModifyEventSubscription
<a name="API_ModifyEventSubscription"></a>

memodifikasi langganan notifikasi peristiwa Amazon DocumentDB yang ada.

## Parameter Permintaan
<a name="API_ModifyEventSubscription_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** SubscriptionName **   
Nama langganan notifikasi peristiwa Amazon DocumentDB.  
Tipe: String  
Diperlukan: Ya

 ** Enabled **   
 Nilai Boolean; atur ke `true` untuk mengaktifkan langganan.   
Tipe: Boolean  
Wajib: Tidak

 **EventCategories. EventCategory.N**   
 Daftar kategori peristiwa untuk `SourceType` yang ingin Anda langgani.  
Tipe: Array string  
Wajib: Tidak

 ** SnsTopicArn **   
Amazon Resource Name (ARN) dari topik SNS yang dibuat untuk notifikasi acara. ARN dibuat oleh Amazon SNS saat Anda membuat topik dan berlangganan topik tersebut.  
Tipe: String  
Wajib: Tidak

 ** SourceType **   
Jenis sumber yang menghasilkan acara. Misalnya, jika Anda ingin diberi tahu tentang peristiwa yang dihasilkan oleh sebuah instans, atur parameter ini ke `db-instance`. Jika nilai ini tidak ditentukan, semua peristiwa dikembalikan.  
Nilai valid: `db-instance`, `db-parameter-group`, `db-security-group`   
Tipe: String  
Wajib: Tidak

## Elemen Respons
<a name="API_ModifyEventSubscription_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** EventSubscription **   
Informasi mendetail tentang peristiwa yang telah Anda langgani.  
Tipe: Objek [EventSubscription](API_EventSubscription.md)

## Kesalahan
<a name="API_ModifyEventSubscription_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** EventSubscriptionQuotaExceeded **   
Anda telah mencapai jumlah maksimum langganan peristiwa.   
Kode Status HTTP: 400

 ** SNSInvalidTopic **   
Amazon SNS telah merespons bahwa ada masalah dengan topik yang ditentukan.   
Kode Status HTTP: 400

 ** SNSNoAuthorization **   
Anda tidak memiliki izin untuk memublikasikan ke Amazon Resource Name (ARN) topik SNS.   
Kode Status HTTP: 400

 ** SNSTopicArnNotFound **   
Amazon Resource Name (ARN) topik SNS tidak ada.   
Kode Status HTTP: 404

 ** SubscriptionCategoryNotFound **   
Kategori yang diberikan tidak ada.   
Kode Status HTTP: 404

 ** SubscriptionNotFound **   
Nama langganan tidak ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_ModifyEventSubscription_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyEventSubscription) 

# ModifyGlobalCluster
<a name="API_ModifyGlobalCluster"></a>

Modifikasi pengaturan untuk klaster global Amazon DocumentDB. Anda dapat mengubah satu atau lebih parameter konfigurasi (misalnya: perlindungan penghapusan), atau pengidentifikasi klaster global dengan menentukan parameter ini dan nilai-nilai baru dalam permintaan.

**catatan**  
Tindakan ini hanya berlaku untuk klaster Amazon DocumentDB.

## Parameter Permintaan
<a name="API_ModifyGlobalCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Pengidentifikasi untuk kluster global yang sedang dimodifikasi. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus cocok dengan pengidentifikasi klaster global yang ada.
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Wajib: Ya

 ** DeletionProtection **   
Menunjukkan jika klaster global memiliki perlindungan penghapusan yang diaktifkan. Klaster global tidak dapat dihapus saat perlindungan penghapusan diaktifkan.   
Tipe: Boolean  
Wajib: Tidak

 ** NewGlobalClusterIdentifier **   
Pengidentifikasi baru untuk klaster global saat Anda mengubah klaster global. Nilai ini disimpan sebagai string huruf kecil.  
+ Harus berisi 1 sampai 63 huruf, angka, atau tanda hubung

  Karakter pertama harus berupa huruf

  Tidak dapat diakhiri dengan sebuah tanda hubung atau mengandung dua tanda hubung berturut-turut
Contoh: `my-cluster2`   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Diperlukan: Tidak

## Elemen Respons
<a name="API_ModifyGlobalCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** GlobalCluster **   
Sebuah tipe data yang mewakili sebuah klaster global Amazon DocumentDB.  
Tipe: Objek [GlobalCluster](API_GlobalCluster.md)

## Kesalahan
<a name="API_ModifyGlobalCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` tidak mengacu ke sebuah klaster global yang ada.  
Kode Status HTTP: 404

 ** InvalidGlobalClusterStateFault **   
Operasi yang diminta tidak dapat dilakukan saat klaster dalam keadaan ini.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_ModifyGlobalCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyGlobalCluster) 

# RebootDBInstance
<a name="API_RebootDBInstance"></a>

Anda mungkin perlu me-restart instans Anda, biasanya untuk alasan pemeliharaan. Misalnya, jika Anda melakukan perubahan tertentu, atau jika Anda mengubah grup parameter klaster yang terkait dengan instans, Anda harus mem-boot ulang instans agar perubahan diterapkan. 

Menyalakan ulang instans akan memulai ulang layanan mesin basis data. Menyalakan ulang instans akan menyebabkan matinya sementara, selama status instans diatur *menyalakan ulang*. 

## Parameter Permintaan
<a name="API_RebootDBInstance_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBInstanceIdentifier **   
Pengidentifikasi instans. Parameter ini disimpan sebagai string huruf kecil.  
Batas:  
+ Harus cocok dengan pengidentifikasi `DBInstance` yang ada.
Tipe: String  
Diperlukan: Ya

 ** ForceFailover **   
 Saat `true`, boot ulang dilakukan melalui failover multi-AZ.   
Kendala: Anda tidak dapat menentukan `true` jika instans tidak dikonfigurasi untuk Multi-AZ.  
Tipe: Boolean  
Wajib: Tidak

## Elemen Respons
<a name="API_RebootDBInstance_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBInstance **   
Informasi mendetail tentang sebuah instans.   
Tipe: Objek [DBInstance](API_DBInstance.md)

## Kesalahan
<a name="API_RebootDBInstance_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` tidak mengacu ke sebuah instans yang ada.   
Kode Status HTTP: 404

 ** InvalidDBInstanceState **   
 Instans yang ditentukan tidak dalam status *tersedia*.   
Kode Status HTTP: 400

## Lihat Juga
<a name="API_RebootDBInstance_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RebootDBInstance) 

# RemoveFromGlobalCluster
<a name="API_RemoveFromGlobalCluster"></a>

Melepaskan klaster sekunder Amazon DocumentDB dari klaster global. Klaster menjadi klaster mandiri dengan kemampuan baca-tulis alih-alih menjadi hanya-baca dan menerima data dari klaster primer di wilayah yang berbeda. 

**catatan**  
Tindakan ini hanya berlaku untuk klaster Amazon DocumentDB.

## Parameter Permintaan
<a name="API_RemoveFromGlobalCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DbClusterIdentifier **   
Amazon Resource Name (ARN) mengidentifikasi klaster yang terlepas dari klaster global Amazon DocumentDB.   
Tipe: String  
Diperlukan: Ya

 ** GlobalClusterIdentifier **   
Pengidentifikasi klaster untuk dilepaskan dari klaster global Amazon DocumentDB.   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Diperlukan: Ya

## Elemen Respons
<a name="API_RemoveFromGlobalCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** GlobalCluster **   
Sebuah tipe data yang mewakili sebuah klaster global Amazon DocumentDB.  
Tipe: Objek [GlobalCluster](API_GlobalCluster.md)

## Kesalahan
<a name="API_RemoveFromGlobalCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` tidak mengacu ke sebuah klaster global yang ada.  
Kode Status HTTP: 404

 ** InvalidGlobalClusterStateFault **   
Operasi yang diminta tidak dapat dilakukan saat klaster dalam keadaan ini.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_RemoveFromGlobalCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveFromGlobalCluster) 

# RemoveSourceIdentifierFromSubscription
<a name="API_RemoveSourceIdentifierFromSubscription"></a>

Menghapus pengidentifikasi sumber dari langganan notifikasi peristiwa Amazon DocumentDB yang ada.

## Parameter Permintaan
<a name="API_RemoveSourceIdentifierFromSubscription_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** SourceIdentifier **   
 Pengidentifikasi sumber yang akan dihapus dari langganan, seperti pengidentifikasi instans untuk instans, atau nama grup keamanan.   
Tipe: String  
Diperlukan: Ya

 ** SubscriptionName **   
Nama langganan notifikasi peristiwa Amazon DocumentDB yang ingin Anda hapus pengidentifikasi sumbernya.  
Tipe: String  
Diperlukan: Ya

## Elemen Respons
<a name="API_RemoveSourceIdentifierFromSubscription_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** EventSubscription **   
Informasi mendetail tentang peristiwa yang telah Anda langgani.  
Tipe: Objek [EventSubscription](API_EventSubscription.md)

## Kesalahan
<a name="API_RemoveSourceIdentifierFromSubscription_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** SourceNotFound **   
Sumber yang diminta tidak dapat ditemukan.   
Kode Status HTTP: 404

 ** SubscriptionNotFound **   
Nama langganan tidak ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_RemoveSourceIdentifierFromSubscription_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

Menghapus tag metadata dari sumber daya Amazon DocumentDB.

## Parameter Permintaan
<a name="API_RemoveTagsFromResource_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** ResourceName **   
Sumber daya Amazon DocumentDB tempat tag dihapus. Nilai ini adalah sebuah Amazon Resource Name (ARN).  
Tipe: String  
Diperlukan: Ya

 **TagKeys.member.n**   
Kunci tag (nama) dari tag yang akan dihapus.  
Tipe: Array string  
Wajib: Ya

## Kesalahan
<a name="API_RemoveTagsFromResource_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` tidak mengacu ke sebuah instans yang ada.   
Kode Status HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` tidak mengacu ke sebuah snapshot yang ada.   
Kode Status HTTP: 404

## Lihat Juga
<a name="API_RemoveTagsFromResource_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveTagsFromResource) 

# ResetDBClusterParameterGroup
<a name="API_ResetDBClusterParameterGroup"></a>

 Memodifikasi parameter grup parameter klaster ke nilai default. Untuk mereset parameter tertentu, kirimkan daftar berikut ini: `ParameterName` dan `ApplyMethod`. Untuk mereset seluruh grup parameter cluster, tentukan parameter `DBClusterParameterGroupName` dan `ResetAllParameters`. 

 Ketika Anda mereset seluruh grup, parameter dinamis diperbarui segera dan parameter statis diatur ke `pending-reboot` untuk berlaku pada boot ulang instans DB berikutnya.

## Parameter Permintaan
<a name="API_ResetDBClusterParameterGroup_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterParameterGroupName **   
Nama grup parameter klaster yang akan direset.  
Tipe: String  
Diperlukan: Ya

 **Parameter.Parameter.N**   
Daftar nama parameter dalam grup parameter klaster untuk direset ke nilai default. Anda tidak dapat menggunakan parameter ini jika parameter `ResetAllParameters` diatur ke `true`.  
Tipe: Array objek [Parameter](API_Parameter.md)  
Wajib: Tidak

 ** ResetAllParameters **   
Nilai yang diatur ke `true` untuk me-reset semua parameter dalam grup parameter klaster ke nilai defaultnya, dan `false` sebaliknya. Anda tidak dapat menggunakan parameter ini jika ada daftar nama parameter yang ditentukan untuk parameter `Parameters`.  
Tipe: Boolean  
Wajib: Tidak

## Elemen Respons
<a name="API_ResetDBClusterParameterGroup_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBClusterParameterGroupName **   
Nama sebuah grup parameter klaster.  
Batas:  
+ Harus dari 1 hingga 255 huruf atau angka.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Nilai ini disimpan sebagai string huruf kecil.
Tipe: String

## Kesalahan
<a name="API_ResetDBClusterParameterGroup_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` tidak mengacu ke grup parameter yang ada.   
Kode Status HTTP: 404

 ** InvalidDBParameterGroupState **   
Grup parameter sedang digunakan, atau dalam keadaan tidak valid. Jika Anda mencoba menghapus grup parameter, Anda tidak dapat menghapusnya ketika grup parameter berada dalam keadaan ini.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_ResetDBClusterParameterGroup_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 

# RestoreDBClusterFromSnapshot
<a name="API_RestoreDBClusterFromSnapshot"></a>

Membuat klaster baru dari snapshot atau snapshot klaster.

Jika snapshot ditentukan, klaster target dibuat dari snapshot DB sumber dengan konfigurasi default dan grup keamanan default.

Jika snapshot klaster ditentukan, klaster target dibuat dari titik pemulihan klaster sumber dengan konfigurasi yang sama seperti klaster DB sumber asli, kecuali klaster baru dibuat dengan grup keamanan default.

## Parameter Permintaan
<a name="API_RestoreDBClusterFromSnapshot_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Nama klaster yang akan dibuat dari snapshot atau snapshot klaster. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Contoh: `my-snapshot-id`   
Tipe: String  
Diperlukan: Ya

 ** Engine **   
Mesin basis data yang akan digunakan untuk klaster baru.  
Default: Sama seperti sumber.  
Kendala: Harus kompatibel dengan mesin sumber.  
Tipe: String  
Diperlukan: Ya

 ** SnapshotIdentifier **   
Pengidentifikasi untuk snapshot atau snapshot klaster yang akan dipulihkan.  
Anda dapat menggunakan nama atau Amazon Resource Name (ARN) untuk menentukan snapshot klaster. Namun, Anda dapat menggunakan hanya ARN untuk menentukan snapshot.  
Batas:  
+ Harus cocok dengan pengidentifikasi snapshot yang ada.
Tipe: String  
Diperlukan: Ya

 **AvailabilityZones. AvailabilityZone.N**   
Menyediakan daftar Availability Zone Amazon EC2 tempat instans dalam klaster DB yang dipulihkan dapat dibuat.  
Tipe: Array string  
Wajib: Tidak

 ** DBClusterParameterGroupName **   
Nama grup parameter klaster yang akan dikaitkan dengan klaster DB ini.  
 *Tipe*: String.       *Diperlukan:* Tidak.  
Jika argumen ini dihilangkan, grup parameter cluster DB default digunakan. Jika disediakan, harus cocok dengan nama grup parameter cluster DB default yang ada. String harus terdiri dari 1 hingga 255 huruf, angka atau tanda hubung. Karakter pertamanya harus berupa huruf, dan tidak dapat diakhiri dengan tanda hubung atau berisi dua tanda hubung berturut-turut.  
Tipe: String  
Wajib: Tidak

 ** DBSubnetGroupName **   
Nama grup subnet yang akan digunakan untuk klaster baru.  
Kendala: Jika disediakan, harus cocok dengan nama `DBSubnetGroup` yang ada.  
Contoh: `mySubnetgroup`   
Tipe: String  
Wajib: Tidak

 ** DeletionProtection **   
Menentukan apakah klaster ini dapat dihapus. Jika `DeletionProtection` diaktifkan, klaster tidak dapat dihapus kecuali jika diubah dan `DeletionProtection` dinonaktifkan. `DeletionProtection` melindungi klaster agar tidak terhapus secara tidak sengaja.  
Tipe: Boolean  
Wajib: Tidak

 **EnableCloudwatchLogsExports.member.n**   
Daftar jenis log yang harus diaktifkan untuk mengekspor ke Amazon CloudWatch Logs.  
Tipe: Array string  
Wajib: Tidak

 ** EngineVersion **   
Versi mesin basis data yang akan digunakan untuk klaster baru.  
Tipe: String  
Wajib: Tidak

 ** KmsKeyId **   
Pengidentifikasi AWS KMS kunci yang akan digunakan saat memulihkan cluster terenkripsi dari snapshot DB atau snapshot cluster.  
Pengidentifikasi AWS KMS kunci adalah Amazon Resource Name (ARN) untuk kunci enkripsi AWS KMS . Jika Anda memulihkan cluster dengan yang sama Akun AWS yang memiliki kunci AWS KMS enkripsi yang digunakan untuk mengenkripsi cluster baru, maka Anda dapat menggunakan alias AWS KMS kunci alih-alih ARN untuk kunci enkripsi. AWS KMS   
Jika Anda tidak menentukan nilai untuk parameter `KmsKeyId`, maka hal berikut akan terjadi:  
+ Jika snapshot atau snapshot cluster `SnapshotIdentifier` dienkripsi, maka cluster yang dipulihkan dienkripsi menggunakan AWS KMS kunci yang digunakan untuk mengenkripsi snapshot atau snapshot cluster.
+ Jika snapshot atau snapshot klaster di `SnapshotIdentifier` tidak dienkripsi, maka klaster DB yang dipulihkan tidak dienkripsi.
Tipe: String  
Wajib: Tidak

 ** NetworkType **   
Jenis jaringan cluster.  
Jenis jaringan ditentukan oleh yang `DBSubnetGroup` ditentukan untuk cluster. A hanya `DBSubnetGroup` dapat mendukung IPv4 protokol atau IPv4 dan IPv6 protokol ()`DUAL`.  
Untuk informasi selengkapnya, lihat [cluster DocumentDB di VPC di Panduan Pengembang Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html).  
Nilai Valid: `IPV4` \$1 `DUAL`   
Tipe: String  
Wajib: Tidak

 ** Port **   
Nomor port tempat klaster baru menerima koneksi.  
Kendala: Harus berupa nilai dari `1150` hingga `65535`.  
Default: Port yang sama dengan klaster asli.  
Tipe: Integer  
Wajib: Tidak

 ** ServerlessV2ScalingConfiguration **   
Berisi konfigurasi penskalaan cluster Amazon DocumentDB Tanpa Server.  
Tipe: Objek [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Wajib: Tidak

 ** StorageType **   
Jenis penyimpanan untuk mengasosiasikan dengan cluster DB.  
Untuk informasi tentang jenis penyimpanan untuk klaster Amazon DocumentDB, lihat Konfigurasi penyimpanan klaster di Panduan Pengembang *Amazon* DocumentDB.  
Nilai yang valid untuk jenis penyimpanan - `standard | iopt1`   
Nilai default adalah `standard `   
Tipe: String  
Wajib: Tidak

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke klaster yang dipulihkan.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

 **VpcSecurityGroupIds. VpcSecurityGroupId.N**   
Daftar grup keamanan virtual private cloud (VPC) tempat klaster baru akan berada.  
Tipe: Array string  
Wajib: Tidak

## Elemen Respons
<a name="API_RestoreDBClusterFromSnapshot_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBCluster **   
Informasi mendetail tentang klaster.   
Tipe: Objek [DBCluster](API_DBCluster.md)

## Kesalahan
<a name="API_RestoreDBClusterFromSnapshot_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
Anda sudah memiliki klaster dengan pengidentifikasi yang diberikan.  
Kode Status HTTP: 400

 ** DBClusterQuotaExceededFault **   
Klaster tidak dapat dibuat karena Anda telah mencapai kuota maksimum klaster yang diizinkan.  
Kode Status HTTP: 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` tidak mengacu ke sebuah snapshot klaster yang ada.   
Kode Status HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` tidak mengacu ke sebuah snapshot yang ada.   
Kode Status HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` tidak mengacu ke grup subnet yang ada.   
Kode Status HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` tidak mengacu ke grup subnet yang ada.   
Kode Status HTTP: 404

 ** InsufficientDBClusterCapacityFault **   
Klaster tidak memiliki kapasitas yang cukup untuk operasi saat ini.  
Kode Status HTTP: 403

 ** InsufficientStorageClusterCapacity **   
Tidak ada cukup penyimpanan yang tersedia untuk tindakan saat ini. Anda mungkin dapat mengatasi kesalahan ini dengan memperbarui grup subnet Anda untuk menggunakan Availability Zone berbeda yang memiliki lebih banyak penyimpanan yang tersedia.   
Kode Status HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
Nilai yang diberikan bukan status snapshot klaster yang valid.  
Kode Status HTTP: 400

 ** InvalidDBSnapshotState **   
Status snapshot tidak mengizinkan penghapusan.  
Kode Status HTTP: 400

 ** InvalidRestoreFault **   
Anda tidak dapat memulihkan dari backup virtual private cloud (VPC) ke instans DB non-VPC.  
Kode Status HTTP: 400

 ** InvalidSubnet **   
Subnet yang diminta tidak valid, atau beberapa subnet yang diminta tidak semuanya berada dalam virtual private cloud (VPC) yang umum.  
Kode Status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
Grup subnet tidak mencakup semua Availability Zone setelah dibuat karena perubahan yang dibuat.  
Kode Status HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Terjadi kesalahan saat mengakses AWS KMS kunci.  
Kode Status HTTP: 400

 ** NetworkTypeNotSupported **   
Jenis jaringan tidak didukung oleh salah satu `DBSubnetGroup` atau versi mesin DB.  
Kode Status HTTP: 400

 ** StorageQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah penyimpanan yang diizinkan yang tersedia di semua instans.  
Kode Status HTTP: 400

 ** StorageQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah penyimpanan yang diizinkan yang tersedia di semua instans.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_RestoreDBClusterFromSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 

# RestoreDBClusterToPointInTime
<a name="API_RestoreDBClusterToPointInTime"></a>

Memulihkan klaster ke titik waktu yang arbitrer. Pengguna dapat memulihkan ke titik waktu mana pun sebelum `LatestRestorableTime` hingga `BackupRetentionPeriod` hari. Klaster target dibuat dari klaster sumber dengan konfigurasi yang sama seperti klaster asli, kecuali klaster baru dibuat dengan grup keamanan default. 

## Parameter Permintaan
<a name="API_RestoreDBClusterToPointInTime_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Nama klaster baru yang akan dibuat.  
Batas:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Tipe: String  
Diperlukan: Ya

 ** SourceDBClusterIdentifier **   
Pengidentifikasi klaster sumber yang akan dipulihkan.  
Batas:  
+ Harus cocok dengan pengidentifikasi `DBCluster` yang ada.
Tipe: String  
Diperlukan: Ya

 ** DBSubnetGroupName **   
Nama grup subnet yang akan digunakan untuk klaster baru.  
Kendala: Jika disediakan, harus cocok dengan nama `DBSubnetGroup` yang ada.  
Contoh: `mySubnetgroup`   
Tipe: String  
Wajib: Tidak

 ** DeletionProtection **   
Menentukan apakah klaster ini dapat dihapus. Jika `DeletionProtection` diaktifkan, klaster tidak dapat dihapus kecuali jika diubah dan `DeletionProtection` dinonaktifkan. `DeletionProtection` melindungi klaster agar tidak terhapus secara tidak sengaja.  
Tipe: Boolean  
Wajib: Tidak

 **EnableCloudwatchLogsExports.member.n**   
Daftar jenis log yang harus diaktifkan untuk mengekspor ke Amazon CloudWatch Logs.  
Tipe: Array string  
Wajib: Tidak

 ** KmsKeyId **   
Pengidentifikasi AWS KMS kunci yang akan digunakan saat memulihkan cluster terenkripsi dari cluster terenkripsi.  
Pengidentifikasi AWS KMS kunci adalah Amazon Resource Name (ARN) untuk kunci enkripsi AWS KMS . Jika Anda memulihkan cluster dengan yang sama Akun AWS yang memiliki kunci AWS KMS enkripsi yang digunakan untuk mengenkripsi cluster baru, maka Anda dapat menggunakan alias AWS KMS kunci alih-alih ARN untuk kunci enkripsi. AWS KMS   
Anda dapat mengembalikan ke cluster baru dan mengenkripsi cluster baru dengan AWS KMS kunci yang berbeda dari AWS KMS kunci yang digunakan untuk mengenkripsi cluster sumber. Cluster DB baru dienkripsi dengan AWS KMS kunci yang diidentifikasi oleh parameter. `KmsKeyId`  
Jika Anda tidak menentukan nilai untuk parameter `KmsKeyId`, maka hal berikut akan terjadi:  
+ Jika cluster dienkripsi, maka cluster yang dipulihkan dienkripsi menggunakan AWS KMS kunci yang digunakan untuk mengenkripsi cluster sumber.
+ Jika klaster tidak dienkripsi, maka klaster yang dipulihkan tidak dienkripsi.
Jika `DBClusterIdentifier` mengacu pada sebuah klaster yang tidak dienkripsi, maka permintaan pemulihan ditolak.  
Tipe: String  
Wajib: Tidak

 ** NetworkType **   
Jenis jaringan cluster.  
Jenis jaringan ditentukan oleh yang `DBSubnetGroup` ditentukan untuk cluster. A hanya `DBSubnetGroup` dapat mendukung IPv4 protokol atau IPv4 dan IPv6 protokol ()`DUAL`.  
Untuk informasi selengkapnya, lihat [cluster DocumentDB di VPC di Panduan Pengembang Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html).  
Nilai Valid: `IPV4` \$1 `DUAL`   
Tipe: String  
Wajib: Tidak

 ** Port **   
Nomor port tempat klaster baru menerima koneksi.  
Kendala: Harus berupa nilai dari `1150` hingga `65535`.   
Default: Port default untuk mesin.  
Tipe: Integer  
Wajib: Tidak

 ** RestoreToTime **   
Tanggal dan waktu untuk memulihkan klaster.  
Nilai yang valid: Waktu dalam format Waktu Universal Terkoordinasi (UTC).  
Batas:  
+ Harus sebelum waktu pemulihan terbaru untuk instans.
+ Harus ditentukan jika parameter `UseLatestRestorableTime` tidak disediakan.
+ Tidak dapat ditentukan jika parameter `UseLatestRestorableTime` adalah `true`.
+ Tidak dapat ditentukan jika parameter `RestoreType` adalah `copy-on-write`.
Contoh: `2015-03-07T23:45:00Z`   
Tipe: Timestamp  
Wajib: Tidak

 ** RestoreType **   
Tipe pemulihan yang akan dilakukan. Anda dapat menentukan salah satu nilai berikut:  
+  `full-copy` - Klaster DB baru dipulihkan sebagai salinan lengkap dari klaster DB sumber.
+  `copy-on-write` - Klaster DB baru dipulihkan sebagai klon dari klaster DB sumber.
Kendala: Anda tidak dapat menentukan `copy-on-write` jika versi mesin klaster DB sumber lebih awal dari 1,11.  
Jika Anda tidak menentukan `RestoreType` nilai, maka klaster DB baru dipulihkan sebagai salinan lengkap klaster DB sumber.  
Tipe: String  
Wajib: Tidak

 ** ServerlessV2ScalingConfiguration **   
Berisi konfigurasi penskalaan cluster Amazon DocumentDB Tanpa Server.  
Tipe: Objek [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Wajib: Tidak

 ** StorageType **   
Jenis penyimpanan untuk dikaitkan dengan cluster DB.  
Untuk informasi tentang jenis penyimpanan untuk klaster Amazon DocumentDB, lihat Konfigurasi penyimpanan klaster di Panduan Pengembang *Amazon* DocumentDB.  
Nilai yang valid untuk jenis penyimpanan - `standard | iopt1`   
Nilai default adalah `standard `   
Tipe: String  
Wajib: Tidak

 **Tags.Tag.N**   
Tag yang akan ditetapkan ke klaster yang dipulihkan.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

 ** UseLatestRestorableTime **   
Nilai yang diatur ke `true` untuk memulihkan klaster ke waktu backup terbaru yang dapat dipulihkan, dan `false` sebaliknya.   
Default: `false`   
Kendala: Tidak dapat ditentukan jika parameter `RestoreToTime` disediakan.  
Tipe: Boolean  
Wajib: Tidak

 **VpcSecurityGroupIds. VpcSecurityGroupId.N**   
Daftar grup keamanan VPC tempat klaster baru berada.  
Tipe: Array string  
Wajib: Tidak

## Elemen Respons
<a name="API_RestoreDBClusterToPointInTime_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBCluster **   
Informasi mendetail tentang klaster.   
Tipe: Objek [DBCluster](API_DBCluster.md)

## Kesalahan
<a name="API_RestoreDBClusterToPointInTime_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
Anda sudah memiliki klaster dengan pengidentifikasi yang diberikan.  
Kode Status HTTP: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** DBClusterQuotaExceededFault **   
Klaster tidak dapat dibuat karena Anda telah mencapai kuota maksimum klaster yang diizinkan.  
Kode Status HTTP: 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` tidak mengacu ke sebuah snapshot klaster yang ada.   
Kode Status HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` tidak mengacu ke grup subnet yang ada.   
Kode Status HTTP: 404

 ** InsufficientDBClusterCapacityFault **   
Klaster tidak memiliki kapasitas yang cukup untuk operasi saat ini.  
Kode Status HTTP: 403

 ** InsufficientStorageClusterCapacity **   
Tidak ada cukup penyimpanan yang tersedia untuk tindakan saat ini. Anda mungkin dapat mengatasi kesalahan ini dengan memperbarui grup subnet Anda untuk menggunakan Availability Zone berbeda yang memiliki lebih banyak penyimpanan yang tersedia.   
Kode Status HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
Nilai yang diberikan bukan status snapshot klaster yang valid.  
Kode Status HTTP: 400

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidDBSnapshotState **   
Status snapshot tidak mengizinkan penghapusan.  
Kode Status HTTP: 400

 ** InvalidRestoreFault **   
Anda tidak dapat memulihkan dari backup virtual private cloud (VPC) ke instans DB non-VPC.  
Kode Status HTTP: 400

 ** InvalidSubnet **   
Subnet yang diminta tidak valid, atau beberapa subnet yang diminta tidak semuanya berada dalam virtual private cloud (VPC) yang umum.  
Kode Status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
Grup subnet tidak mencakup semua Availability Zone setelah dibuat karena perubahan yang dibuat.  
Kode Status HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Terjadi kesalahan saat mengakses AWS KMS kunci.  
Kode Status HTTP: 400

 ** NetworkTypeNotSupported **   
Jenis jaringan tidak didukung oleh salah satu `DBSubnetGroup` atau versi mesin DB.  
Kode Status HTTP: 400

 ** StorageQuotaExceeded **   
Permintaan akan menyebabkan Anda melebihi jumlah penyimpanan yang diizinkan yang tersedia di semua instans.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_RestoreDBClusterToPointInTime_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 

# StartDBCluster
<a name="API_StartDBCluster"></a>

Mulai ulang klaster yang terhenti yang ditentukan oleh `DBClusterIdentifier`. Untuk informasi selengkapnya, lihat [Penghentian dan Pemulaian Klaster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).

## Parameter Permintaan
<a name="API_StartDBCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Pengidentifikasi dari klaster untuk dimulai ulang. Contoh: `docdb-2019-05-28-15-24-52`   
Tipe: String  
Diperlukan: Ya

## Elemen Respons
<a name="API_StartDBCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBCluster **   
Informasi mendetail tentang klaster.   
Tipe: Objek [DBCluster](API_DBCluster.md)

## Kesalahan
<a name="API_StartDBCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidDBInstanceState **   
 Instans yang ditentukan tidak dalam status *tersedia*.   
Kode Status HTTP: 400

## Lihat Juga
<a name="API_StartDBCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StartDBCluster) 

# StopDBCluster
<a name="API_StopDBCluster"></a>

Menghentikan klaster yang sedang berjalan yang ditentukan oleh `DBClusterIdentifier`. Klaster harus dalam status *tersedia*. Untuk informasi selengkapnya, lihat [Penghentian dan Pemulaian Klaster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).

## Parameter Permintaan
<a name="API_StopDBCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** DBClusterIdentifier **   
Pengidentifikasi klaster untuk dihentikan. Contoh: `docdb-2019-05-28-15-24-52`   
Tipe: String  
Diperlukan: Ya

## Elemen Respons
<a name="API_StopDBCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** DBCluster **   
Informasi mendetail tentang klaster.   
Tipe: Objek [DBCluster](API_DBCluster.md)

## Kesalahan
<a name="API_StopDBCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidDBInstanceState **   
 Instans yang ditentukan tidak dalam status *tersedia*.   
Kode Status HTTP: 400

## Lihat Juga
<a name="API_StopDBCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StopDBCluster) 

# SwitchoverGlobalCluster
<a name="API_SwitchoverGlobalCluster"></a>

Mengalihkan klaster Amazon DocumentDB sekunder yang ditentukan menjadi klaster Amazon DocumentDB utama baru di kluster database global.

## Parameter Permintaan
<a name="API_SwitchoverGlobalCluster_RequestParameters"></a>

 Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

 ** GlobalClusterIdentifier **   
Pengidentifikasi cluster database global Amazon DocumentDB untuk beralih. Identifier adalah kunci unik yang ditetapkan oleh pengguna saat cluster dibuat. Dengan kata lain, itu adalah nama cluster global. Parameter ini tidak peka huruf besar/kecil.  
Batas:  
+ Harus cocok dengan pengidentifikasi klaster global yang ada (database global Amazon DocumentDB).
+ Panjang minimum 1. Panjang maksimum 255.
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Wajib: Ya

 ** TargetDbClusterIdentifier **   
Pengidentifikasi cluster Amazon DocumentDB sekunder untuk mempromosikan ke primer baru untuk cluster database global. Gunakan Amazon Resource Name (ARN) untuk pengidentifikasi sehingga Amazon DocumentDB dapat menemukan cluster di wilayahnya. AWS   
Batas:  
+ Harus cocok dengan pengidentifikasi cluster sekunder yang ada.
+ Panjang minimum 1. Panjang maksimum 255.
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Diperlukan: Ya

## Elemen Respons
<a name="API_SwitchoverGlobalCluster_ResponseElements"></a>

Elemen berikut dikembalikan oleh layanan.

 ** GlobalCluster **   
Sebuah tipe data yang mewakili sebuah klaster global Amazon DocumentDB.  
Tipe: Objek [GlobalCluster](API_GlobalCluster.md)

## Kesalahan
<a name="API_SwitchoverGlobalCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` tidak mengacu ke sebuah klaster yang ada.   
Kode Status HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` tidak mengacu ke sebuah klaster global yang ada.  
Kode Status HTTP: 404

 ** InvalidDBClusterStateFault **   
Klaster tidak dalam status valid.  
Kode Status HTTP: 400

 ** InvalidGlobalClusterStateFault **   
Operasi yang diminta tidak dapat dilakukan saat klaster dalam keadaan ini.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_SwitchoverGlobalCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/SwitchoverGlobalCluster) 

# Cluster Elastis Amazon DocumentDB
<a name="API_Operations_Amazon_DocumentDB_Elastic_Clusters"></a>

Tindakan berikut didukung oleh Amazon DocumentDB Elastic Clusters:
+  [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) 
+  [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) 
+  [CreateCluster](API_elastic_CreateCluster.md) 
+  [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) 
+  [DeleteCluster](API_elastic_DeleteCluster.md) 
+  [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) 
+  [GetCluster](API_elastic_GetCluster.md) 
+  [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) 
+  [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) 
+  [ListClusters](API_elastic_ListClusters.md) 
+  [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) 
+  [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) 
+  [ListTagsForResource](API_elastic_ListTagsForResource.md) 
+  [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) 
+  [StartCluster](API_elastic_StartCluster.md) 
+  [StopCluster](API_elastic_StopCluster.md) 
+  [TagResource](API_elastic_TagResource.md) 
+  [UntagResource](API_elastic_UntagResource.md) 
+  [UpdateCluster](API_elastic_UpdateCluster.md) 

# ApplyPendingMaintenanceAction
<a name="API_elastic_ApplyPendingMaintenanceAction"></a>

Jenis tindakan pemeliharaan tertunda yang akan diterapkan ke sumber daya.

## Minta Sintaks
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestSyntax"></a>

```
POST /pending-action HTTP/1.1
Content-type: application/json

{
   "applyAction": "string",
   "applyOn": "string",
   "optInType": "string",
   "resourceArn": "string"
}
```

## Parameter Permintaan URI
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestParameters"></a>

Permintaan tidak menggunakan parameter URI apa pun.

## Isi Permintaan
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyAction"></a>
Tindakan pemeliharaan yang tertunda untuk diterapkan ke sumber daya.  
Tindakan yang valid adalah:  
+  `ENGINE_UPDATE ` 
+  `ENGINE_UPGRADE` 
+  `SECURITY_UPDATE` 
+  `OS_UPDATE` 
+  `MASTER_USER_PASSWORD_UPDATE` 
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Wajib: Ya

 ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-optInType"></a>
Nilai yang menentukan jenis permintaan opt-in atau membatalkan permintaan opt-in. Permintaan opt-in dari jenis `IMMEDIATE` tidak dapat dibatalkan.  
Tipe: String  
Nilai yang Valid: `IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN`   
Wajib: Ya

 ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-resourceArn"></a>
Nama Sumber Daya Amazon DocumentDB Amazon (ARN) dari sumber daya tempat tindakan pemeliharaan tertunda berlaku.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Wajib: Ya

 ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyOn"></a>
Tanggal tertentu untuk menerapkan tindakan pemeliharaan yang tertunda. Diperlukan jika opt-in-type adalah `APPLY_ON`. Format: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}
```

## Elemen Respons
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
Output dari tindakan pemeliharaan tertunda yang diterapkan.  
Tipe: Objek [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

## Kesalahan
<a name="API_elastic_ApplyPendingMaintenanceAction_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang tempat pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_ApplyPendingMaintenanceAction_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 

# CopyClusterSnapshot
<a name="API_elastic_CopyClusterSnapshot"></a>

Menyalin snapshot dari cluster elastis.

## Minta Sintaks
<a name="API_elastic_CopyClusterSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot/snapshotArn/copy HTTP/1.1
Content-type: application/json

{
   "copyTags": boolean,
   "kmsKeyId": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetSnapshotName": "string"
}
```

## Parameter Permintaan URI
<a name="API_elastic_CopyClusterSnapshot_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-uri-snapshotArn"></a>
Pengidentifikasi Amazon Resource Name (ARN) dari snapshot cluster elastis.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_CopyClusterSnapshot_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-targetSnapshotName"></a>
Pengidentifikasi snapshot cluster elastis baru untuk dibuat dari snapshot cluster sumber. Parameter ini tidak peka huruf besar kecil.  
Batas:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Contoh: `elastic-cluster-snapshot-5`   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 63.  
Wajib: Ya

 ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-copyTags"></a>
Setel `true` untuk menyalin semua tag dari snapshot cluster sumber ke snapshot cluster elastis target. Defaultnya adalah `false`.  
Tipe: Boolean  
Wajib: Tidak

 ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-kmsKeyId"></a>
ID kunci AWS KMS untuk snapshot cluster elastis terenkripsi. ID kunci AWS KMS adalah Nama Sumber Daya Amazon (ARN) AWS , pengidentifikasi kunci KMS, atau alias kunci KMS AWS untuk kunci enkripsi KMS. AWS   
Jika Anda menyalin snapshot cluster elastis terenkripsi dari AWS akun Anda, Anda dapat menentukan nilai `KmsKeyId` untuk mengenkripsi salinan dengan kunci enkripsi AWS S KMS baru. Jika Anda tidak menentukan nilai untuk`KmsKeyId`, maka salinan snapshot cluster elastis dienkripsi dengan kunci `AWS` KMS yang sama dengan snapshot cluster elastis sumber.  
Jika Anda menyalin snapshot cluster elastis yang tidak terenkripsi dan menentukan nilai untuk `KmsKeyId` parameter, kesalahan akan dikembalikan.  
Tipe: String  
Wajib: Tidak

 ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-tags"></a>
Tag yang akan ditetapkan ke snapshot cluster elastis.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_CopyClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_CopyClusterSnapshot_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-response-snapshot"></a>
Mengembalikan informasi tentang snapshot cluster elastis tertentu.  
Tipe: Objek [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

## Kesalahan
<a name="API_elastic_CopyClusterSnapshot_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ServiceQuotaExceededException **   
Kuota layanan untuk tindakan terlampaui.  
Kode Status HTTP: 402

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_CopyClusterSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 

# CreateCluster
<a name="API_elastic_CreateCluster"></a>

Membuat cluster elastis Amazon DocumentDB baru dan mengembalikan struktur klasternya.

## Minta Sintaks
<a name="API_elastic_CreateCluster_RequestSyntax"></a>

```
POST /cluster HTTP/1.1
Content-type: application/json

{
   "adminUserName": "string",
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "clusterName": "string",
   "kmsKeyId": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

## Parameter Permintaan URI
<a name="API_elastic_CreateCluster_RequestParameters"></a>

Permintaan tidak menggunakan parameter URI apa pun.

## Isi Permintaan
<a name="API_elastic_CreateCluster_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserName"></a>
Nama administrator cluster elastis Amazon DocumentDB.  
 *Kendala*:  
+ Harus dari 1 hingga 63 huruf atau angka.
+ Karakter pertama harus berupa surat.
+ Tidak dapat berupa kata yang dicadangkan.
Tipe: String  
Diperlukan: Ya

 ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserPassword"></a>
Kata sandi untuk administrator cluster elastis Amazon DocumentDB. Kata sandi dapat berisi karakter ASCII yang dapat dicetak.  
 *Kendala*:  
+ Harus berisi 8 hingga 100 karakter.
+ Tidak dapat berisi garis miring (/), tanda kutip ganda (“), atau simbol “at” (@).
Tipe: String  
Diperlukan: Ya

 ** [authType](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-authType"></a>
Jenis otentikasi yang digunakan untuk menentukan di mana untuk mengambil password yang digunakan untuk mengakses cluster elastis. Jenis yang valid adalah `PLAIN_TEXT` atau`SECRET_ARN`.  
Tipe: String  
Nilai yang Valid: `PLAIN_TEXT | SECRET_ARN`   
Wajib: Ya

 ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clusterName"></a>
Nama cluster elastis baru. Parameter ini disimpan sebagai string huruf kecil.  
 *Kendala*:  
+ Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
+ Karakter pertama harus berupa surat.
+ Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
 *Contoh*: `my-cluster`   
Tipe: String  
Diperlukan: Ya

 ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCapacity"></a>
Jumlah v yang CPUs ditetapkan untuk setiap pecahan cluster elastis. Maksimal adalah 64. Nilai yang diizinkan adalah 2, 4, 8, 16, 32, 64.  
Jenis: Integer  
Wajib: Ya

 ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCount"></a>
Jumlah pecahan yang ditugaskan ke cluster elastis. Maksimal adalah 32.  
Jenis: Integer  
Wajib: Ya

 ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-backupRetentionPeriod"></a>
Jumlah hari di mana snapshot otomatis dipertahankan.  
Tipe: Integer  
Wajib: Tidak

 ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clientToken"></a>
Token klien untuk cluster elastis.  
Tipe: String  
Wajib: Tidak

 ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-kmsKeyId"></a>
Pengidentifikasi kunci KMS yang digunakan untuk mengenkripsi cluster elastis baru.  
Pengidentifikasi kunci KMS adalah Amazon Resource Name (ARN) untuk kunci enkripsi KMS. Jika Anda membuat cluster menggunakan akun Amazon yang sama yang memiliki kunci enkripsi KMS ini, Anda dapat menggunakan alias kunci KMS alih-alih ARN sebagai kunci enkripsi KMS.  
Jika kunci enkripsi tidak ditentukan, Amazon DocumentDB menggunakan kunci enkripsi default yang dibuat KMS untuk akun Anda. Akun Anda memiliki kunci enkripsi default yang berbeda untuk setiap Wilayah Amazon.  
Tipe: String  
Wajib: Tidak

 ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredBackupWindow"></a>
Rentang waktu harian di mana pencadangan otomatis dibuat jika pencadangan otomatis diaktifkan, sebagaimana ditentukan oleh. `backupRetentionPeriod`  
Tipe: String  
Wajib: Tidak

 ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredMaintenanceWindow"></a>
Rentang waktu mingguan selama pemeliharaan sistem dapat terjadi, dalam Waktu Universal Terkoordinasi (UTC).  
 *Format*: `ddd:hh24:mi-ddd:hh24:mi`   
 *Default*: jendela 30 menit yang dipilih secara acak dari blok waktu 8 jam untuk masing-masing Wilayah AWS, terjadi pada hari acak dalam seminggu.  
 *Hari yang berlaku*: Senin, Sel, Rabu, Kam, Jumat, Sabtu, Minggu  
 *Kendala: Jendela* minimum 30 menit.  
Tipe: String  
Wajib: Tidak

 ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardInstanceCount"></a>
Jumlah contoh replika yang berlaku untuk semua pecahan di cluster elastis. `shardInstanceCount`Nilai 1 berarti ada satu contoh penulis, dan setiap contoh tambahan adalah replika yang dapat digunakan untuk membaca dan untuk meningkatkan ketersediaan.  
Tipe: Integer  
Wajib: Tidak

 ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-subnetIds"></a>
Subnet Amazon EC2 IDs untuk cluster elastis baru.  
Tipe: Array string  
Wajib: Tidak

 ** [tags](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-tags"></a>
Tag yang akan ditetapkan ke cluster elastis baru.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Wajib: Tidak

 ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-vpcSecurityGroupIds"></a>
Daftar grup keamanan VPC EC2 untuk diasosiasikan dengan cluster elastis baru.  
Tipe: Array string  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_CreateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_CreateCluster_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) **   <a name="documentdb-elastic_CreateCluster-response-cluster"></a>
Cluster elastis baru yang telah dibuat.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

## Kesalahan
<a name="API_elastic_CreateCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ServiceQuotaExceededException **   
Kuota layanan untuk tindakan terlampaui.  
Kode Status HTTP: 402

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_CreateCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) 

# CreateClusterSnapshot
<a name="API_elastic_CreateClusterSnapshot"></a>

Membuat snapshot dari cluster elastis.

## Minta Sintaks
<a name="API_elastic_CreateClusterSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot HTTP/1.1
Content-type: application/json

{
   "clusterArn": "string",
   "snapshotName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Parameter Permintaan URI
<a name="API_elastic_CreateClusterSnapshot_RequestParameters"></a>

Permintaan tidak menggunakan parameter URI apa pun.

## Isi Permintaan
<a name="API_elastic_CreateClusterSnapshot_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis yang ingin Anda buat snapshot.  
Tipe: String  
Diperlukan: Ya

 ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-snapshotName"></a>
Nama snapshot cluster elastis baru.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 63.  
Wajib: Ya

 ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-tags"></a>
Tag yang akan ditetapkan ke snapshot cluster elastis baru.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_CreateClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_CreateClusterSnapshot_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-response-snapshot"></a>
Mengembalikan informasi tentang snapshot cluster elastis baru.  
Tipe: Objek [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

## Kesalahan
<a name="API_elastic_CreateClusterSnapshot_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ServiceQuotaExceededException **   
Kuota layanan untuk tindakan terlampaui.  
Kode Status HTTP: 402

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_CreateClusterSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 

# DeleteCluster
<a name="API_elastic_DeleteCluster"></a>

Hapus cluster elastis.

## Minta Sintaks
<a name="API_elastic_DeleteCluster_RequestSyntax"></a>

```
DELETE /cluster/clusterArn HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_DeleteCluster_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) **   <a name="documentdb-elastic_DeleteCluster-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis yang akan dihapus.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_DeleteCluster_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_DeleteCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_DeleteCluster_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) **   <a name="documentdb-elastic_DeleteCluster-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis yang baru dihapus.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

## Kesalahan
<a name="API_elastic_DeleteCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_DeleteCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) 

# DeleteClusterSnapshot
<a name="API_elastic_DeleteClusterSnapshot"></a>

Hapus snapshot cluster elastis.

## Minta Sintaks
<a name="API_elastic_DeleteClusterSnapshot_RequestSyntax"></a>

```
DELETE /cluster-snapshot/snapshotArn HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_DeleteClusterSnapshot_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-request-uri-snapshotArn"></a>
Pengidentifikasi ARN dari snapshot cluster elastis yang akan dihapus.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_DeleteClusterSnapshot_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_DeleteClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_DeleteClusterSnapshot_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-response-snapshot"></a>
Mengembalikan informasi tentang snapshot cluster elastis yang baru dihapus.  
Tipe: Objek [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

## Kesalahan
<a name="API_elastic_DeleteClusterSnapshot_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang tempat pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_DeleteClusterSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 

# GetCluster
<a name="API_elastic_GetCluster"></a>

Mengembalikan informasi tentang cluster elastis tertentu.

## Minta Sintaks
<a name="API_elastic_GetCluster_RequestSyntax"></a>

```
GET /cluster/clusterArn HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_GetCluster_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) **   <a name="documentdb-elastic_GetCluster-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_GetCluster_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_GetCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_GetCluster_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) **   <a name="documentdb-elastic_GetCluster-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis tertentu.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

## Kesalahan
<a name="API_elastic_GetCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_GetCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) 

# GetClusterSnapshot
<a name="API_elastic_GetClusterSnapshot"></a>

Mengembalikan informasi tentang snapshot cluster elastis tertentu

## Minta Sintaks
<a name="API_elastic_GetClusterSnapshot_RequestSyntax"></a>

```
GET /cluster-snapshot/snapshotArn HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_GetClusterSnapshot_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-request-uri-snapshotArn"></a>
Pengidentifikasi ARN dari snapshot cluster elastis.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_GetClusterSnapshot_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_GetClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_GetClusterSnapshot_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-response-snapshot"></a>
Mengembalikan informasi tentang snapshot cluster elastis tertentu.  
Tipe: Objek [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

## Kesalahan
<a name="API_elastic_GetClusterSnapshot_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_GetClusterSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 

# GetPendingMaintenanceAction
<a name="API_elastic_GetPendingMaintenanceAction"></a>

Mengambil semua tindakan pemeliharaan yang tertunda.

## Minta Sintaks
<a name="API_elastic_GetPendingMaintenanceAction_RequestSyntax"></a>

```
GET /pending-action/resourceArn HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_GetPendingMaintenanceAction_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-request-uri-resourceArn"></a>
Mengambil tindakan pemeliharaan yang tertunda untuk Nama Sumber Daya Amazon (ARN) tertentu.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_GetPendingMaintenanceAction_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_GetPendingMaintenanceAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}
```

## Elemen Respons
<a name="API_elastic_GetPendingMaintenanceAction_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
Menyediakan informasi tentang tindakan pemeliharaan yang tertunda untuk sumber daya.  
Tipe: Objek [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

## Kesalahan
<a name="API_elastic_GetPendingMaintenanceAction_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_GetPendingMaintenanceAction_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 

# ListClusters
<a name="API_elastic_ListClusters"></a>

Mengembalikan informasi tentang klaster elastis Amazon DocumentDB yang disediakan.

## Minta Sintaks
<a name="API_elastic_ListClusters_RequestSyntax"></a>

```
GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_ListClusters_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-maxResults"></a>
Jumlah maksimum hasil snapshot cluster elastis yang diterima dalam respons.  
Rentang yang Valid: Nilai minimum 1. Nilai maksimum 100.

 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-nextToken"></a>
Token pagination yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya mencakup catatan di luar token ini, hingga nilai yang ditentukan oleh`max-results`.  
Jika tidak ada lagi data dalam respons, tidak `nextToken` akan dikembalikan.

## Isi Permintaan
<a name="API_elastic_ListClusters_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_ListClusters_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "clusters": [ 
      { 
         "clusterArn": "string",
         "clusterName": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elemen Respons
<a name="API_elastic_ListClusters_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-clusters"></a>
Daftar cluster elastis Amazon DocumentDB.  
Tipe: Array objek [ClusterInList](API_elastic_ClusterInList.md)

 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-nextToken"></a>
Token pagination yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya mencakup catatan di luar token ini, hingga nilai yang ditentukan oleh`max-results`.  
Jika tidak ada lagi data dalam respons, tidak `nextToken` akan dikembalikan.  
Tipe: String

## Kesalahan
<a name="API_elastic_ListClusters_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_ListClusters_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) 

# ListClusterSnapshots
<a name="API_elastic_ListClusterSnapshots"></a>

Mengembalikan informasi tentang snapshot untuk cluster elastis tertentu.

## Minta Sintaks
<a name="API_elastic_ListClusterSnapshots_RequestSyntax"></a>

```
GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_ListClusterSnapshots_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.

 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-maxResults"></a>
Jumlah maksimum hasil snapshot cluster elastis yang diterima dalam respons.  
Rentang Valid: Nilai minimum 20. Nilai maksimum 100.

 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-nextToken"></a>
Token pagination yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya mencakup catatan di luar token ini, hingga nilai yang ditentukan oleh`max-results`.  
Jika tidak ada lagi data dalam respons, tidak `nextToken` akan dikembalikan.

 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-snapshotType"></a>
Jenis snapshot klaster untuk dikembalikan. Anda dapat menentukan salah satu nilai berikut:  
+  `automated`- Kembalikan semua snapshot cluster yang Amazon DocumentDB telah secara otomatis dibuat untuk akun Anda. AWS 
+  `manual`- Kembalikan semua snapshot cluster yang telah Anda buat secara manual untuk AWS akun Anda.

## Isi Permintaan
<a name="API_elastic_ListClusterSnapshots_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_ListClusterSnapshots_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "clusterArn": "string",
         "snapshotArn": "string",
         "snapshotCreationTime": "string",
         "snapshotName": "string",
         "status": "string"
      }
   ]
}
```

## Elemen Respons
<a name="API_elastic_ListClusterSnapshots_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-nextToken"></a>
Token pagination yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya mencakup catatan di luar token ini, hingga nilai yang ditentukan oleh`max-results`.  
Jika tidak ada lagi data dalam respons, tidak `nextToken` akan dikembalikan.  
Tipe: String

 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-snapshots"></a>
Daftar snapshot untuk cluster elastis tertentu.  
Tipe: Array objek [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md)

## Kesalahan
<a name="API_elastic_ListClusterSnapshots_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang tempat pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_ListClusterSnapshots_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 

# ListPendingMaintenanceActions
<a name="API_elastic_ListPendingMaintenanceActions"></a>

Mengambil daftar semua tindakan pemeliharaan yang tertunda.

## Minta Sintaks
<a name="API_elastic_ListPendingMaintenanceActions_RequestSyntax"></a>

```
GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_ListPendingMaintenanceActions_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-maxResults"></a>
Jumlah maksimum hasil untuk dimasukkan dalam respons. Jika lebih banyak catatan ada daripada nilai `maxResults` yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.  
Rentang yang Valid: Nilai minimum 1. Nilai maksimum 100.

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-nextToken"></a>
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `maxResults`.

## Isi Permintaan
<a name="API_elastic_ListPendingMaintenanceActions_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_ListPendingMaintenanceActions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "resourcePendingMaintenanceActions": [ 
      { 
         "pendingMaintenanceActionDetails": [ 
            { 
               "action": "string",
               "autoAppliedAfterDate": "string",
               "currentApplyDate": "string",
               "description": "string",
               "forcedApplyDate": "string",
               "optInStatus": "string"
            }
         ],
         "resourceArn": "string"
      }
   ]
}
```

## Elemen Respons
<a name="API_elastic_ListPendingMaintenanceActions_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-resourcePendingMaintenanceActions"></a>
Menyediakan informasi tentang tindakan pemeliharaan yang tertunda untuk sumber daya.  
Tipe: Array objek [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-nextToken"></a>
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditampilkan, tanggapan hanya akan menyertakan catatan di luar penanda, hingga nilai yang ditentukan oleh`maxResults`.  
Tipe: String

## Kesalahan
<a name="API_elastic_ListPendingMaintenanceActions_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_ListPendingMaintenanceActions_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 

# ListTagsForResource
<a name="API_elastic_ListTagsForResource"></a>

Daftar semua tag pada sumber daya cluster elastis

## Minta Sintaks
<a name="API_elastic_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_ListTagsForResource_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) **   <a name="documentdb-elastic_ListTagsForResource-request-uri-resourceArn"></a>
Pengidentifikasi ARN dari sumber daya cluster elastis.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 1011.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_ListTagsForResource_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Elemen Respons
<a name="API_elastic_ListTagsForResource_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) **   <a name="documentdb-elastic_ListTagsForResource-response-tags"></a>
Daftar tag untuk sumber daya cluster elastis yang ditentukan.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.

## Kesalahan
<a name="API_elastic_ListTagsForResource_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_ListTagsForResource_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) 

# RestoreClusterFromSnapshot
<a name="API_elastic_RestoreClusterFromSnapshot"></a>

Mengembalikan cluster elastis dari snapshot.

## Minta Sintaks
<a name="API_elastic_RestoreClusterFromSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot/snapshotArn/restore HTTP/1.1
Content-type: application/json

{
   "clusterName": "string",
   "kmsKeyId": "string",
   "shardCapacity": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

## Parameter Permintaan URI
<a name="API_elastic_RestoreClusterFromSnapshot_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-uri-snapshotArn"></a>
Pengidentifikasi ARN dari snapshot cluster elastis.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_RestoreClusterFromSnapshot_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-clusterName"></a>
Nama cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-kmsKeyId"></a>
Pengidentifikasi kunci KMS yang digunakan untuk mengenkripsi cluster elastis Amazon DocumentDB baru.  
Pengidentifikasi kunci KMS adalah Amazon Resource Name (ARN) untuk kunci enkripsi KMS. Jika Anda membuat cluster menggunakan akun Amazon yang sama yang memiliki kunci enkripsi KMS ini, Anda dapat menggunakan alias kunci KMS alih-alih ARN sebagai kunci enkripsi KMS.  
Jika kunci enkripsi tidak ditentukan di sini, Amazon DocumentDB menggunakan kunci enkripsi default yang dibuat KMS untuk akun Anda. Akun Anda memiliki kunci enkripsi default yang berbeda untuk setiap Wilayah Amazon.  
Tipe: String  
Wajib: Tidak

 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardCapacity"></a>
Kapasitas setiap pecahan dalam cluster elastis baru yang dipulihkan.  
Tipe: Integer  
Wajib: Tidak

 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardInstanceCount"></a>
Jumlah contoh replika yang berlaku untuk semua pecahan di cluster elastis. `shardInstanceCount`Nilai 1 berarti ada satu contoh penulis, dan setiap contoh tambahan adalah replika yang dapat digunakan untuk membaca dan untuk meningkatkan ketersediaan.  
Tipe: Integer  
Wajib: Tidak

 ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-subnetIds"></a>
Subnet Amazon EC2 IDs untuk cluster elastis.  
Tipe: Array string  
Wajib: Tidak

 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-tags"></a>
Daftar nama tag yang akan ditetapkan ke cluster elastis yang dipulihkan, dalam bentuk array pasangan kunci-nilai di mana kuncinya adalah nama tag dan nilainya adalah nilai kunci.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Wajib: Tidak

 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-vpcSecurityGroupIds"></a>
Daftar grup keamanan VPC EC2 untuk diasosiasikan dengan cluster elastis.  
Tipe: Array string  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis dipulihkan.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

## Kesalahan
<a name="API_elastic_RestoreClusterFromSnapshot_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ServiceQuotaExceededException **   
Kuota layanan untuk tindakan terlampaui.  
Kode Status HTTP: 402

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_RestoreClusterFromSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 

# StartCluster
<a name="API_elastic_StartCluster"></a>

Memulai ulang cluster elastis berhenti yang ditentukan oleh`clusterARN`.

## Minta Sintaks
<a name="API_elastic_StartCluster_RequestSyntax"></a>

```
POST /cluster/clusterArn/start HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_StartCluster_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) **   <a name="documentdb-elastic_StartCluster-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_StartCluster_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_StartCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_StartCluster_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) **   <a name="documentdb-elastic_StartCluster-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis tertentu.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

## Kesalahan
<a name="API_elastic_StartCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang tempat pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_StartCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) 

# StopCluster
<a name="API_elastic_StopCluster"></a>

Menghentikan cluster elastis yang berjalan yang ditentukan oleh`clusterArn`. Cluster elastis harus dalam keadaan *tersedia*. 

## Minta Sintaks
<a name="API_elastic_StopCluster_RequestSyntax"></a>

```
POST /cluster/clusterArn/stop HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_StopCluster_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) **   <a name="documentdb-elastic_StopCluster-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_StopCluster_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_StopCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_StopCluster_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) **   <a name="documentdb-elastic_StopCluster-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis tertentu.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

## Kesalahan
<a name="API_elastic_StopCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_StopCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) 

# TagResource
<a name="API_elastic_TagResource"></a>

Menambahkan tag metadata ke sumber daya cluster elastis

## Minta Sintaks
<a name="API_elastic_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Parameter Permintaan URI
<a name="API_elastic_TagResource_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-uri-resourceArn"></a>
Pengidentifikasi ARN dari sumber daya cluster elastis.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 1011.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_TagResource_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [tags](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-tags"></a>
Tag yang ditetapkan ke sumber daya cluster elastis.  
Tipe: Peta string ke string  
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.  
Pola Kunci: `(?!aws:)[a-zA-Z+-=._:/]+`   
Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.  
Wajib: Ya

## Sintaksis Respons
<a name="API_elastic_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elemen Respons
<a name="API_elastic_TagResource_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200 dengan isi HTTP kosong.

## Kesalahan
<a name="API_elastic_TagResource_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_TagResource_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) 

# UntagResource
<a name="API_elastic_UntagResource"></a>

Menghapus tag metadata dari sumber daya cluster elastis

## Minta Sintaks
<a name="API_elastic_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## Parameter Permintaan URI
<a name="API_elastic_UntagResource_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-resourceArn"></a>
Pengidentifikasi ARN dari sumber daya cluster elastis.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 1011.  
Wajib: Ya

 ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-tagKeys"></a>
Kunci tag yang akan dihapus dari sumber daya cluster elastis.  
Anggota Array: Jumlah minimum 0 item. Jumlah maksimum 50 item.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.  
Pola: `(?!aws:)[a-zA-Z+-=._:/]+`   
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_UntagResource_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<a name="API_elastic_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elemen Respons
<a name="API_elastic_UntagResource_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200 dengan isi HTTP kosong.

## Kesalahan
<a name="API_elastic_UntagResource_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_UntagResource_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) 

# UpdateCluster
<a name="API_elastic_UpdateCluster"></a>

Memodifikasi cluster elastis. Ini termasuk memperbarui admin-username/password, memutakhirkan versi API, dan menyiapkan jendela cadangan dan jendela pemeliharaan

## Minta Sintaks
<a name="API_elastic_UpdateCluster_RequestSyntax"></a>

```
PUT /cluster/clusterArn HTTP/1.1
Content-type: application/json

{
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "vpcSecurityGroupIds": [ "string" ]
}
```

## Parameter Permintaan URI
<a name="API_elastic_UpdateCluster_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-uri-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Wajib: Ya

## Isi Permintaan
<a name="API_elastic_UpdateCluster_RequestBody"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-adminUserPassword"></a>
Kata sandi yang terkait dengan administrator cluster elastis. Kata sandi ini dapat berisi karakter ASCII apa pun yang dapat dicetak kecuali garis miring (/), tanda kutip ganda ("), atau simbol "at" (@).  
 *Kendala*: Harus berisi dari 8 hingga 100 karakter.  
Tipe: String  
Wajib: Tidak

 ** [authType](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-authType"></a>
Jenis otentikasi yang digunakan untuk menentukan di mana untuk mengambil password yang digunakan untuk mengakses cluster elastis. Jenis yang valid adalah `PLAIN_TEXT` atau`SECRET_ARN`.  
Tipe: String  
Nilai yang Valid: `PLAIN_TEXT | SECRET_ARN`   
Wajib: Tidak

 ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-backupRetentionPeriod"></a>
Jumlah hari di mana snapshot otomatis dipertahankan.  
Tipe: Integer  
Wajib: Tidak

 ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-clientToken"></a>
Token klien untuk cluster elastis.  
Tipe: String  
Wajib: Tidak

 ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredBackupWindow"></a>
Rentang waktu harian di mana pencadangan otomatis dibuat jika pencadangan otomatis diaktifkan, sebagaimana ditentukan oleh. `backupRetentionPeriod`  
Tipe: String  
Wajib: Tidak

 ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredMaintenanceWindow"></a>
Rentang waktu mingguan selama pemeliharaan sistem dapat terjadi, dalam Waktu Universal Terkoordinasi (UTC).  
 *Format*: `ddd:hh24:mi-ddd:hh24:mi`   
 *Default*: jendela 30 menit yang dipilih secara acak dari blok waktu 8 jam untuk masing-masing Wilayah AWS, terjadi pada hari acak dalam seminggu.  
 *Hari yang berlaku*: Senin, Sel, Rabu, Kam, Jumat, Sabtu, Minggu  
 *Kendala: Jendela* minimum 30 menit.  
Tipe: String  
Wajib: Tidak

 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCapacity"></a>
Jumlah v yang CPUs ditetapkan untuk setiap pecahan cluster elastis. Maksimal adalah 64. Nilai yang diizinkan adalah 2, 4, 8, 16, 32, 64.  
Tipe: Integer  
Wajib: Tidak

 ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCount"></a>
Jumlah pecahan yang ditugaskan ke cluster elastis. Maksimal adalah 32.  
Tipe: Integer  
Wajib: Tidak

 ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardInstanceCount"></a>
Jumlah contoh replika yang berlaku untuk semua pecahan di cluster elastis. `shardInstanceCount`Nilai 1 berarti ada satu contoh penulis, dan setiap contoh tambahan adalah replika yang dapat digunakan untuk membaca dan untuk meningkatkan ketersediaan.  
Tipe: Integer  
Wajib: Tidak

 ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-subnetIds"></a>
Subnet Amazon EC2 IDs untuk cluster elastis.  
Tipe: Array string  
Wajib: Tidak

 ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-vpcSecurityGroupIds"></a>
Daftar grup keamanan VPC EC2 untuk diasosiasikan dengan cluster elastis.  
Tipe: Array string  
Wajib: Tidak

## Sintaksis Respons
<a name="API_elastic_UpdateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elemen Respons
<a name="API_elastic_UpdateCluster_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **   <a name="documentdb-elastic_UpdateCluster-response-cluster"></a>
Mengembalikan informasi tentang cluster elastis diperbarui.  
Tipe: Objek [Cluster](API_elastic_Cluster.md)

## Kesalahan
<a name="API_elastic_UpdateCluster_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** AccessDeniedException **   
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.    
 ** message **   
Pesan kesalahan yang menjelaskan mengapa akses ditolak.
Kode Status HTTP: 403

 ** ConflictException **   
Terjadi konflik akses.    
 ** resourceId **   
ID sumber daya di mana ada konflik akses.  
 ** resourceType **   
Jenis sumber daya di mana ada konflik akses.
Kode Status HTTP: 409

 ** InternalServerException **   
Ada kesalahan server internal.  
Kode Status HTTP: 500

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak dapat ditemukan.    
 ** message **   
Pesan kesalahan yang menjelaskan kegagalan.  
 ** resourceId **   
ID sumber daya yang tidak dapat ditemukan.  
 ** resourceType **   
Jenis sumber daya yang tidak dapat ditemukan.
Kode Status HTTP: 404

 ** ThrottlingException **   
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.    
 ** retryAfterSeconds **   
Jumlah detik untuk menunggu sebelum mencoba kembali operasi.
Kode Status HTTP: 429

 ** ValidationException **   
Struktur yang mendefinisikan pengecualian validasi.    
 ** fieldList **   
Daftar bidang di mana pengecualian validasi terjadi.  
 ** message **   
Pesan kesalahan yang menjelaskan pengecualian validasi.  
 ** reason **   
Alasan mengapa pengecualian validasi terjadi (salah satu`unknownOperation`,, `cannotParse``fieldValidationFailed`, atau`other`).
Kode Status HTTP: 400

## Lihat Juga
<a name="API_elastic_UpdateCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster) 

# Tipe Data
<a name="API_Types"></a>

Tipe data berikut didukung oleh Amazon DocumentDB (with MongoDB compatibility):
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [Certificate](API_Certificate.md) 
+  [CertificateDetails](API_CertificateDetails.md) 
+  [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 
+  [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 
+  [DBCluster](API_DBCluster.md) 
+  [DBClusterMember](API_DBClusterMember.md) 
+  [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 
+  [DBClusterRole](API_DBClusterRole.md) 
+  [DBClusterSnapshot](API_DBClusterSnapshot.md) 
+  [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 
+  [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 
+  [DBEngineVersion](API_DBEngineVersion.md) 
+  [DBInstance](API_DBInstance.md) 
+  [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 
+  [DBSubnetGroup](API_DBSubnetGroup.md) 
+  [Endpoint](API_Endpoint.md) 
+  [EngineDefaults](API_EngineDefaults.md) 
+  [Event](API_Event.md) 
+  [EventCategoriesMap](API_EventCategoriesMap.md) 
+  [EventSubscription](API_EventSubscription.md) 
+  [FailoverState](API_FailoverState.md) 
+  [Filter](API_Filter.md) 
+  [GlobalCluster](API_GlobalCluster.md) 
+  [GlobalClusterMember](API_GlobalClusterMember.md) 
+  [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 
+  [Parameter](API_Parameter.md) 
+  [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 
+  [PendingMaintenanceAction](API_PendingMaintenanceAction.md) 
+  [PendingModifiedValues](API_PendingModifiedValues.md) 
+  [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 
+  [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 
+  [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 
+  [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 
+  [Subnet](API_Subnet.md) 
+  [Tag](API_Tag.md) 
+  [UpgradeTarget](API_UpgradeTarget.md) 
+  [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 

Tipe data berikut didukung oleh Amazon DocumentDB Elastic Clusters:
+  [Cluster](API_elastic_Cluster.md) 
+  [ClusterInList](API_elastic_ClusterInList.md) 
+  [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 
+  [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 
+  [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 
+  [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 
+  [Shard](API_elastic_Shard.md) 
+  [ValidationExceptionField](API_elastic_ValidationExceptionField.md) 

# Amazon DocumentDB (with MongoDB compatibility)
<a name="API_Types_Amazon_DocumentDB_with_MongoDB_compatibility"></a>

Tipe data berikut didukung oleh Amazon DocumentDB (with MongoDB compatibility):
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [Certificate](API_Certificate.md) 
+  [CertificateDetails](API_CertificateDetails.md) 
+  [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 
+  [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 
+  [DBCluster](API_DBCluster.md) 
+  [DBClusterMember](API_DBClusterMember.md) 
+  [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 
+  [DBClusterRole](API_DBClusterRole.md) 
+  [DBClusterSnapshot](API_DBClusterSnapshot.md) 
+  [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 
+  [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 
+  [DBEngineVersion](API_DBEngineVersion.md) 
+  [DBInstance](API_DBInstance.md) 
+  [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 
+  [DBSubnetGroup](API_DBSubnetGroup.md) 
+  [Endpoint](API_Endpoint.md) 
+  [EngineDefaults](API_EngineDefaults.md) 
+  [Event](API_Event.md) 
+  [EventCategoriesMap](API_EventCategoriesMap.md) 
+  [EventSubscription](API_EventSubscription.md) 
+  [FailoverState](API_FailoverState.md) 
+  [Filter](API_Filter.md) 
+  [GlobalCluster](API_GlobalCluster.md) 
+  [GlobalClusterMember](API_GlobalClusterMember.md) 
+  [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 
+  [Parameter](API_Parameter.md) 
+  [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 
+  [PendingMaintenanceAction](API_PendingMaintenanceAction.md) 
+  [PendingModifiedValues](API_PendingModifiedValues.md) 
+  [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 
+  [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 
+  [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 
+  [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 
+  [Subnet](API_Subnet.md) 
+  [Tag](API_Tag.md) 
+  [UpgradeTarget](API_UpgradeTarget.md) 
+  [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 

# AvailabilityZone
<a name="API_AvailabilityZone"></a>

Informasi tentang Availability Zone.

## Daftar Isi
<a name="API_AvailabilityZone_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** Name **   
Nama Availability Zone.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_AvailabilityZone_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AvailabilityZone) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AvailabilityZone) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AvailabilityZone) 

# Certificate
<a name="API_Certificate"></a>

Sertifikat otoritas sertifikat (CA) untuk Akun AWS.

## Daftar Isi
<a name="API_Certificate_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** CertificateArn **   
Amazon Resource Name (ARN) untuk sertifikat.  
Contoh: `arn:aws:rds:us-east-1::cert:rds-ca-2019`   
Tipe: String  
Wajib: Tidak

 ** CertificateIdentifier **   
Kunci unik yang mengidentifikasi sertifikat.  
Contoh: `rds-ca-2019`   
Tipe: String  
Wajib: Tidak

 ** CertificateType **   
Jenis dari sertifikat.  
Contoh: `CA`   
Tipe: String  
Wajib: Tidak

 ** Thumbprint **   
Cap jempol dari sertifikat.  
Tipe: String  
Wajib: Tidak

 ** ValidFrom **   
Tanggal-waktu mulai yang mana sertifikat valid.  
Contoh: `2019-07-31T17:57:09Z`   
Tipe: Timestamp  
Wajib: Tidak

 ** ValidTill **   
Tanggal-waktu setelah sertifikat tidak valid lagi.  
Contoh: `2024-07-31T17:57:09Z`   
Tipe: Timestamp  
Wajib: Tidak

## Lihat Juga
<a name="API_Certificate_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Certificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Certificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Certificate) 

# CertificateDetails
<a name="API_CertificateDetails"></a>

Mengembalikan rincian sertifikat server instans DB.

*Untuk informasi selengkapnya, lihat [Memperbarui Sertifikat Amazon DocumentDB TLS Anda](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) [dan Mengenkripsi Data dalam Transit di](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) Panduan Pengembang Amazon DocumentDB.*

## Daftar Isi
<a name="API_CertificateDetails_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** CAIdentifier **   
Pengidentifikasi CA dari sertifikat CA yang digunakan untuk sertifikat server instans DB.  
Tipe: String  
Wajib: Tidak

 ** ValidTill **   
Tanggal kedaluwarsa sertifikat server instans DB.  
Tipe: Timestamp  
Wajib: Tidak

## Lihat Juga
<a name="API_CertificateDetails_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CertificateDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CertificateDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CertificateDetails) 

# CloudwatchLogsExportConfiguration
<a name="API_CloudwatchLogsExportConfiguration"></a>

Pengaturan konfigurasi untuk jenis log yang akan diaktifkan untuk diekspor ke Amazon CloudWatch Logs untuk instance atau cluster tertentu.

`DisableLogTypes`Array `EnableLogTypes` dan menentukan log mana yang diekspor (atau tidak diekspor) ke Log. CloudWatch Nilai-nilai dalam array ini tergantung pada mesin yang sedang digunakan.

## Daftar Isi
<a name="API_CloudwatchLogsExportConfiguration_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** DisableLogTypes.member.N **   
Daftar jenis log yang akan dinonaktifkan.  
Tipe: Array string  
Wajib: Tidak

 ** EnableLogTypes.member.N **   
Daftar jenis log yang akan diaktifkan.  
Tipe: Array string  
Wajib: Tidak

## Lihat Juga
<a name="API_CloudwatchLogsExportConfiguration_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 

# ClusterMasterUserSecret
<a name="API_ClusterMasterUserSecret"></a>

Berisi rahasia yang dikelola oleh Amazon DocumentDB di Secrets AWS Manager untuk kata sandi pengguna utama.

## Daftar Isi
<a name="API_ClusterMasterUserSecret_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** KmsKeyId **   
Pengidentifikasi kunci AWS KMS yang digunakan untuk mengenkripsi rahasia.  
Tipe: String  
Wajib: Tidak

 ** SecretArn **   
Nama Sumber Daya Amazon (ARN) dari rahasianya.  
Tipe: String  
Wajib: Tidak

 ** SecretStatus **   
Status rahasianya.  
Kemungkinan nilai statusnya meliputi:  
+ menciptakan - Rahasia sedang dibuat.
+ aktif - Rahasianya tersedia untuk penggunaan normal dan rotasi.
+ berputar - Rahasianya sedang diputar.
+ gangguan - Rahasia dapat digunakan untuk mengakses kredensi database, tetapi tidak dapat diputar. Sebuah rahasia mungkin memiliki status ini jika, misalnya, izin diubah sehingga Amazon DocumentDB tidak dapat lagi mengakses rahasia atau kunci KMS untuk rahasia tersebut.

  Ketika rahasia memiliki status ini, Anda dapat memperbaiki kondisi yang menyebabkan status tersebut. Atau, memodifikasi instance untuk mematikan manajemen otomatis kredenal database, dan kemudian memodifikasi instance lagi untuk mengaktifkan manajemen otomatis kredenal database.
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_ClusterMasterUserSecret_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ClusterMasterUserSecret) 

# DBCluster
<a name="API_DBCluster"></a>

Informasi mendetail tentang klaster. 

## Daftar Isi
<a name="API_DBCluster_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** AssociatedRoles.DBClusterRole.N **   
Menyediakan daftar peran AWS Identity and Access Management (IAM) yang terkait dengan cluster. (IAM) peran yang terkait dengan izin pemberian klaster untuk klaster untuk mengakses AWS layanan lain atas nama Anda.  
Tipe: Array objek [DBClusterRole](API_DBClusterRole.md)  
Wajib: Tidak

 ** AvailabilityZones.AvailabilityZone.N **   
Menyediakan daftar Zona EC2 Ketersediaan Amazon tempat instance di cluster dapat dibuat.  
Tipe: Array string  
Wajib: Tidak

 ** BackupRetentionPeriod **   
Menentukan jumlah hari yang mana snapshot otomatis dipertahankan.  
Tipe: Integer  
Wajib: Tidak

 ** CloneGroupId **   
Mengidentifikasi grup klon yang terkait dengan klaster DB.  
Tipe: String  
Wajib: Tidak

 ** ClusterCreateTime **   
Menentukan waktu saat klaster dibuat, dalam Waktu Universal Terkoordinasi (UTC).  
Tipe: Timestamp  
Wajib: Tidak

 ** DBClusterArn **   
Amazon Resource Name (ARN) untuk klaster.  
Tipe: String  
Wajib: Tidak

 ** DBClusterIdentifier **   
Berisi pengidentifikasi klaster yang disediakan pengguna. Pengidentifikasi ini adalah kunci unik yang mengidentifikasi sebuah klaster.  
Tipe: String  
Wajib: Tidak

 ** DBClusterMembers.DBClusterMember.N **   
Menyediakan daftar instans yang membentuk klaster.  
Tipe: Array objek [DBClusterMember](API_DBClusterMember.md)  
Wajib: Tidak

 ** DBClusterParameterGroup **   
Menentukan nama grup parameter klaster untuk klaster.  
Tipe: String  
Wajib: Tidak

 ** DbClusterResourceId **   
Pengidentifikasi Wilayah AWS-unik dan tidak dapat diubah untuk cluster. Pengenal ini ditemukan di entri AWS CloudTrail log setiap kali AWS KMS kunci untuk cluster diakses.  
Tipe: String  
Wajib: Tidak

 ** DBSubnetGroup **   
Menentukan informasi tentang grup subnet yang terkait dengan klaster, termasuk nama, deskripsi, dan subnet dalam grup subnet.  
Tipe: String  
Wajib: Tidak

 ** DeletionProtection **   
Menentukan apakah klaster ini dapat dihapus. Jika `DeletionProtection` diaktifkan, klaster tidak dapat dihapus kecuali jika diubah dan `DeletionProtection` dinonaktifkan. `DeletionProtection` melindungi klaster agar tidak terhapus secara tidak sengaja.  
Tipe: Boolean  
Wajib: Tidak

 ** EarliestRestorableTime **   
Waktu paling awal dimana database dapat dipulihkan dengan point-in-time restore.  
Tipe: Timestamp  
Wajib: Tidak

 ** EnabledCloudwatchLogsExports.member.N **   
Daftar jenis log yang dikonfigurasi oleh cluster ini untuk diekspor ke Amazon CloudWatch Logs.  
Tipe: Array string  
Wajib: Tidak

 ** Endpoint **   
Menentukan titik akhir koneksi untuk instans primer klaster.  
Tipe: String  
Wajib: Tidak

 ** Engine **   
Menyediakan nama mesin basis data yang akan digunakan untuk klaster ini.  
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Menunjukkan versi mesin basis data.  
Tipe: String  
Wajib: Tidak

 ** HostedZoneId **   
Menentukan ID yang ditetapkan Amazon Route 53 saat Anda membuat zona yang di-hosting.  
Tipe: String  
Wajib: Tidak

 ** IOOptimizedNextAllowedModificationTime **   
Lain kali Anda dapat memodifikasi cluster Amazon DocumentDB untuk menggunakan jenis penyimpanan iopt1.  
Tipe: Timestamp  
Wajib: Tidak

 ** KmsKeyId **   
Jika `StorageEncrypted` ya`true`, pengidentifikasi AWS KMS kunci untuk cluster terenkripsi.  
Tipe: String  
Wajib: Tidak

 ** LatestRestorableTime **   
Menentukan waktu terbaru yang database dapat dipulihkan dengan point-in-time restore.  
Tipe: Timestamp  
Wajib: Tidak

 ** MasterUsername **   
Berisi nama pengguna utama untuk klaster.  
Tipe: String  
Wajib: Tidak

 ** MasterUserSecret **   
Rahasia yang dikelola oleh Amazon DocumentDB di Secrets AWS Manager untuk kata sandi pengguna utama.  
Tipe: Objek [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md)  
Wajib: Tidak

 ** MultiAZ **   
Menentukan apakah klaster memiliki instans di beberapa Availability Zone.  
Tipe: Boolean  
Wajib: Tidak

 ** NetworkType **   
Jenis jaringan cluster.  
Jenis jaringan ditentukan oleh yang `DBSubnetGroup` ditentukan untuk cluster. A hanya `DBSubnetGroup` dapat mendukung IPv4 protokol atau IPv4 dan IPv6 protokol ()`DUAL`.  
Untuk informasi selengkapnya, lihat [cluster DocumentDB di VPC di Panduan Pengembang Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html).  
Nilai Valid: `IPV4` \$1 `DUAL`   
Tipe: String  
Wajib: Tidak

 ** PercentProgress **   
Menentukan kemajuan operasi sebagai persentase.  
Tipe: String  
Wajib: Tidak

 ** Port **   
Menentukan port yang didengarkan oleh mesin basis data.  
Tipe: Integer  
Wajib: Tidak

 ** PreferredBackupWindow **   
Menentukan rentang waktu harian selama pencadangan otomatis dibuat jika pencadangan otomatis diaktifkan, seperti yang ditentukan oleh `BackupRetentionPeriod`.   
Tipe: String  
Wajib: Tidak

 ** PreferredMaintenanceWindow **   
Menentukan rentang waktu mingguan untuk melakukan pemeliharaan sistem, dalam Waktu Universal Terkoordinasi (UTC).  
Tipe: String  
Wajib: Tidak

 ** ReaderEndpoint **   
Reader endpoint untuk klaster. Reader endpoint untuk koneksi menyeimbangkan beban klaster di seluruh replika Amazon DocumentDB yang tersedia dalam klaster. Saat klien meminta koneksi baru ke reader endpoint, Amazon DocumentDB mendistribusikan permintaan koneksi di antara replika Amazon DocumentDB di klaster. Fungsionalitas ini dapat membantu menyeimbangkan beban kerja baca Anda di beberapa replika Amazon DocumentDB di klaster Anda.   
Jika terjadi failover, dan replika Amazon DocumentDB yang terhubung dengan Anda dipromosikan menjadi instans primer, koneksi Anda dijatuhkan. Untuk terus mengirimkan beban kerja baca Anda ke replika Amazon DocumentDB lainnya di klaster, Anda kemudian dapat menyambungkan kembali ke reader endpoint.  
Tipe: String  
Wajib: Tidak

 ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N **   
Berisi satu atau lebih pengidentifikasi klaster sekunder yang terkait dengan klaster ini.  
Tipe: Array string  
Wajib: Tidak

 ** ReplicationSourceIdentifier **   
Berisi pengidentifikasi klaster sumber jika klaster ini adalah klaster sekunder.  
Tipe: String  
Wajib: Tidak

 ** ServerlessV2ScalingConfiguration **   
Konfigurasi penskalaan cluster Amazon DocumentDB Tanpa Server.  
Tipe: Objek [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md)  
Wajib: Tidak

 ** Status **   
Menentukan status saat ini dari klaster ini.  
Tipe: String  
Wajib: Tidak

 ** StorageEncrypted **   
Menentukan apakah klaster dienkripsi.  
Tipe: Boolean  
Wajib: Tidak

 ** StorageType **   
Jenis penyimpanan yang terkait dengan cluster Anda  
Untuk informasi tentang jenis penyimpanan untuk klaster Amazon DocumentDB, lihat Konfigurasi penyimpanan klaster di Panduan Pengembang *Amazon* DocumentDB.  
Nilai yang valid untuk jenis penyimpanan - `standard | iopt1`   
Nilai default adalah `standard `   
Tipe: String  
Wajib: Tidak

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
Menyediakan daftar grup keamanan virtual private cloud (VPC) yang dimiliki klaster.  
Tipe: Array objek [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)  
Wajib: Tidak

## Lihat Juga
<a name="API_DBCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster) 

# DBClusterMember
<a name="API_DBClusterMember"></a>

Berisi informasi tentang sebuah instans yang merupakan bagian dari sebuah klaster.

## Daftar Isi
<a name="API_DBClusterMember_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** DBClusterParameterGroupStatus **   
Menentukan status grup parameter klaster untuk anggota klaster DB ini.  
Tipe: String  
Wajib: Tidak

 ** DBInstanceIdentifier **   
Menentukan pengidentifikasi instans untuk anggota klaster ini.  
Tipe: String  
Wajib: Tidak

 ** IsClusterWriter **   
Sebuah nilai yang `true` jika anggota klaster adalah instans primer untuk klaster dan `false` sebaliknya.  
Tipe: Boolean  
Wajib: Tidak

 ** PromotionTier **   
Nilai yang menentukan urutan di mana replika Amazon DocumentDB dipromosikan ke instans primer setelah kegagalan instans primer yang ada.   
Tipe: Integer  
Wajib: Tidak

## Lihat Juga
<a name="API_DBClusterMember_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterMember) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterMember) 

# DBClusterParameterGroup
<a name="API_DBClusterParameterGroup"></a>

Informasi mendetail tentang grup parameter klaster. 

## Daftar Isi
<a name="API_DBClusterParameterGroup_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** DBClusterParameterGroupArn **   
Amazon Resource Name (ARN) untuk grup parameter klaster.  
Tipe: String  
Wajib: Tidak

 ** DBClusterParameterGroupName **   
Menyediakan nama grup parameter klaster.  
Tipe: String  
Wajib: Tidak

 ** DBParameterGroupFamily **   
Menyediakan nama famili grup parameter yang kompatibel dengan grup parameter klaster ini.  
Tipe: String  
Wajib: Tidak

 ** Description **   
Menyediakan deskripsi yang ditentukan pelanggan untuk grup parameter klaster ini.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_DBClusterParameterGroup_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterParameterGroup) 

# DBClusterRole
<a name="API_DBClusterRole"></a>

Menjelaskan peran AWS Identity and Access Management (IAM) yang terkait dengan cluster.

## Daftar Isi
<a name="API_DBClusterRole_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** RoleArn **   
Nama Sumber Daya Amazon (ARN) dari IAMrole yang terkait dengan cluster DB.  
Tipe: String  
Wajib: Tidak

 ** Status **   
Menjelaskan keadaan asosiasi antara cluster IAMrole dan cluster. Properti `Status` mengembalikan salah satu nilai berikut:  
+  `ACTIVE`- IAMrole ARN dikaitkan dengan cluster dan dapat digunakan untuk mengakses AWS layanan lain atas nama Anda.
+  `PENDING`- IAMrole ARN sedang dikaitkan dengan cluster.
+  `INVALID`- IAMrole ARN dikaitkan dengan cluster, tetapi cluster tidak dapat mengasumsikan IAMrole untuk mengakses AWS layanan lain atas nama Anda.
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_DBClusterRole_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterRole) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterRole) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterRole) 

# DBClusterSnapshot
<a name="API_DBClusterSnapshot"></a>

Informasi mendetail tentang snapshot klaster. 

## Daftar Isi
<a name="API_DBClusterSnapshot_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** AvailabilityZones.AvailabilityZone.N **   
Menyediakan daftar Zona EC2 Ketersediaan Amazon tempat instance dalam snapshot klaster dapat dipulihkan.  
Tipe: Array string  
Wajib: Tidak

 ** ClusterCreateTime **   
Menentukan waktu saat klaster dibuat, dalam Waktu Universal Terkoordinasi (UTC).  
Tipe: Timestamp  
Wajib: Tidak

 ** DBClusterIdentifier **   
Menentukan pengidentifikasi klaster dari klaster tempat snapshot klaster ini dibuat.  
Tipe: String  
Wajib: Tidak

 ** DBClusterSnapshotArn **   
Amazon Resource Name (ARN) untuk snapshot klaster.  
Tipe: String  
Wajib: Tidak

 ** DBClusterSnapshotIdentifier **   
Menentukan pengidentifikasi untuk snapshot klaster.  
Tipe: String  
Wajib: Tidak

 ** Engine **   
Menentukan nama mesin basis data.  
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Menyediakan versi mesin basis data untuk snapshot klaster ini.  
Tipe: String  
Wajib: Tidak

 ** KmsKeyId **   
Jika `StorageEncrypted` ya`true`, pengenal AWS KMS kunci untuk snapshot cluster terenkripsi.  
Tipe: String  
Wajib: Tidak

 ** MasterUsername **   
Menyediakan nama pengguna utama untuk snapshot klaster.  
Tipe: String  
Wajib: Tidak

 ** PercentProgress **   
Menentukan persentase perkiraan data yang telah ditransfer.  
Tipe: Integer  
Wajib: Tidak

 ** Port **   
Menentukan port yang didengarkan klaster pada saat snapshot.  
Tipe: Integer  
Wajib: Tidak

 ** SnapshotCreateTime **   
Menyediakan waktu ketika snapshot diambil, dalam UTC.  
Tipe: Timestamp  
Wajib: Tidak

 ** SnapshotType **   
Menyediakan jenis snapshot klaster.  
Tipe: String  
Wajib: Tidak

 ** SourceDBClusterSnapshotArn **   
Jika snapshot klaster disalin dari snapshot klaster sumber, ARN untuk snapshot klaster sumber; jika tidak, nilai null.  
Tipe: String  
Wajib: Tidak

 ** Status **   
Menentukan status snapshot klaster ini.  
Tipe: String  
Wajib: Tidak

 ** StorageEncrypted **   
Menentukan apakah snapshot klaster dienkripsi.  
Tipe: Boolean  
Wajib: Tidak

 ** StorageType **   
Jenis penyimpanan yang terkait dengan snapshot klaster Anda  
Untuk informasi tentang jenis penyimpanan untuk klaster Amazon DocumentDB, lihat Konfigurasi penyimpanan klaster di Panduan Pengembang *Amazon* DocumentDB.  
Nilai yang valid untuk jenis penyimpanan - `standard | iopt1`   
Nilai default adalah `standard `   
Tipe: String  
Wajib: Tidak

 ** VpcId **   
Menyediakan ID virtual private cloud (VPC) yang terkait dengan snapshot klaster.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_DBClusterSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshot) 

# DBClusterSnapshotAttribute
<a name="API_DBClusterSnapshotAttribute"></a>

Berisi nama dan nilai-nilai atribut snapshot klaster manual.

Atribut snapshot cluster manual digunakan untuk mengotorisasi lainnya Akun AWS untuk memulihkan snapshot cluster manual.

## Daftar Isi
<a name="API_DBClusterSnapshotAttribute_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** AttributeName **   
Nama dari atribut snapshot klaster manual.  
Atribut bernama `restore` mengacu pada daftar Akun AWS yang memiliki izin untuk menyalin atau mengembalikan snapshot cluster manual.  
Tipe: String  
Wajib: Tidak

 ** AttributeValues.AttributeValue.N **   
Nilai untuk atribut snapshot klaster manual.  
Jika `AttributeName` bidang diatur ke`restore`, maka elemen ini mengembalikan daftar IDs Akun AWS yang berwenang untuk menyalin atau mengembalikan snapshot cluster manual. Jika nilai `all` ada dalam daftar, maka snapshot cluster manual bersifat publik dan tersedia Akun AWS untuk disalin atau dipulihkan.  
Tipe: Array string  
Wajib: Tidak

## Lihat Juga
<a name="API_DBClusterSnapshotAttribute_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttribute) 

# DBClusterSnapshotAttributesResult
<a name="API_DBClusterSnapshotAttributesResult"></a>

Informasi mendetail tentang atribut yang terkait dengan snapshot klaster.

## Daftar Isi
<a name="API_DBClusterSnapshotAttributesResult_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N **   
Daftar atribut dan nilai untuk snapshot klaster.  
Tipe: Array objek [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md)  
Wajib: Tidak

 ** DBClusterSnapshotIdentifier **   
Pengidentifikasi dari snapshot klaster tempat atribut diterapkan.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_DBClusterSnapshotAttributesResult_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 

# DBEngineVersion
<a name="API_DBEngineVersion"></a>

 Informasi mendetail tentang versi mesin. 

## Daftar Isi
<a name="API_DBEngineVersion_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** DBEngineDescription **   
Deskripsi mesin basis data.  
Tipe: String  
Wajib: Tidak

 ** DBEngineVersionDescription **   
Deskripsi versi mesin basis data.  
Tipe: String  
Wajib: Tidak

 ** DBParameterGroupFamily **   
Nama famili grup parameter untuk mesin basis data.  
Tipe: String  
Wajib: Tidak

 ** Engine **   
Nama mesin basis data.  
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Nomor versi mesin basis data.  
Tipe: String  
Wajib: Tidak

 ** ExportableLogTypes.member.N **   
Jenis log yang dimiliki mesin database untuk diekspor ke Amazon CloudWatch Logs.  
Tipe: Array string  
Wajib: Tidak

 ** ServerlessV2FeaturesSupport **   
Menentukan properti Amazon DocumentDB Serverless atau batas yang berbeda antara versi mesin Amazon DocumentDB. Anda dapat menguji nilai atribut ini saat memutuskan versi Amazon DocumentDB mana yang akan digunakan dalam klaster baru atau yang ditingkatkan. Anda juga dapat mengambil versi klaster yang ada dan memeriksa apakah versi tersebut mendukung fitur Amazon DocumentDB Tanpa Server tertentu sebelum Anda mencoba menggunakan fitur tersebut.  
Tipe: Objek [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md)  
Wajib: Tidak

 ** SupportedCACertificateIdentifiers.member.N **   
Daftar pengidentifikasi sertifikat CA yang didukung.  
*Untuk informasi selengkapnya, lihat [Memperbarui Sertifikat Amazon DocumentDB TLS Anda](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) [dan Mengenkripsi Data dalam Transit di](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) Panduan Pengembang Amazon DocumentDB.*  
Tipe: Array string  
Wajib: Tidak

 ** SupportsCertificateRotationWithoutRestart **   
Menunjukkan apakah versi mesin mendukung memutar sertifikat server tanpa me-reboot instance DB.  
Tipe: Boolean  
Wajib: Tidak

 ** SupportsLogExportsToCloudwatchLogs **   
Nilai yang menunjukkan apakah versi engine mendukung ekspor jenis log yang ditentukan oleh `ExportableLogTypes` ke CloudWatch Log.  
Tipe: Boolean  
Wajib: Tidak

 ** ValidUpgradeTarget.UpgradeTarget.N **   
Daftar versi mesin yang dapat ditingkatkan untuk versi mesin basis data ini.  
Tipe: Array objek [UpgradeTarget](API_UpgradeTarget.md)  
Wajib: Tidak

## Lihat Juga
<a name="API_DBEngineVersion_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBEngineVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBEngineVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBEngineVersion) 

# DBInstance
<a name="API_DBInstance"></a>

Informasi mendetail tentang sebuah instans. 

## Daftar Isi
<a name="API_DBInstance_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** AutoMinorVersionUpgrade **   
Tidak berlaku. Parameter ini tidak berlaku untuk Amazon DocumentDB. Amazon DocumentDB tidak melakukan peningkatan versi minor terlepas dari nilai yang ditetapkan.  
Tipe: Boolean  
Wajib: Tidak

 ** AvailabilityZone **   
Menentukan nama Availability Zone tempat instans berada.  
Tipe: String  
Wajib: Tidak

 ** BackupRetentionPeriod **   
Menentukan jumlah hari yang mana snapshot otomatis dipertahankan.  
Tipe: Integer  
Wajib: Tidak

 ** CACertificateIdentifier **   
Pengidentifikasi sertifikat CA untuk instans DB ini.  
Tipe: String  
Wajib: Tidak

 ** CertificateDetails **   
Rincian sertifikat server instans DB.  
Tipe: Objek [CertificateDetails](API_CertificateDetails.md)  
Wajib: Tidak

 ** CopyTagsToSnapshot **   
Nilai yang menunjukkan apakah akan menyalin tanda dari instans DB untuk snapshot instans DB. Secara default, tanda tidak disalin.  
Tipe: Boolean  
Wajib: Tidak

 ** DBClusterIdentifier **   
Berisi nama klaster tempat instans menjadi anggota jika instans adalah anggota klaster.  
Tipe: String  
Wajib: Tidak

 ** DBInstanceArn **   
Amazon Resource Name (ARN) untuk instans.  
Tipe: String  
Wajib: Tidak

 ** DBInstanceClass **   
Berisi nama kelas komputasi dan kapasitas memori instans.  
Tipe: String  
Wajib: Tidak

 ** DBInstanceIdentifier **   
Berisi pengidentifikasi basis data yang disediakan pengguna. Pengidentifikasi ini adalah kunci unik yang mengidentifikasi sebuah instans.  
Tipe: String  
Wajib: Tidak

 ** DBInstanceStatus **   
Menentukan status saat ini dari basis data ini.  
Tipe: String  
Wajib: Tidak

 ** DbiResourceId **   
Pengidentifikasi Wilayah AWS-unik dan tidak dapat diubah untuk instance. Pengenal ini ditemukan di entri AWS CloudTrail log setiap kali AWS KMS kunci untuk instance diakses.  
Tipe: String  
Wajib: Tidak

 ** DBSubnetGroup **   
Menentukan informasi tentang grup subnet yang terkait dengan instans, termasuk nama, deskripsi, dan subnet dalam grup subnet.  
Tipe: Objek [DBSubnetGroup](API_DBSubnetGroup.md)  
Wajib: Tidak

 ** EnabledCloudwatchLogsExports.member.N **   
Daftar jenis log yang instance ini dikonfigurasi untuk diekspor ke CloudWatch Log.  
Tipe: Array string  
Wajib: Tidak

 ** Endpoint **   
Menentukan titik akhir koneksi.  
Tipe: Objek [Endpoint](API_Endpoint.md)  
Wajib: Tidak

 ** Engine **   
Menyediakan nama mesin basis data yang akan digunakan untuk instans ini.  
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Menunjukkan versi mesin basis data.  
Tipe: String  
Wajib: Tidak

 ** InstanceCreateTime **   
Menyediakan tanggal dan waktu saat instans dibuat.  
Tipe: Timestamp  
Wajib: Tidak

 ** KmsKeyId **   
 Jika `StorageEncrypted` ya`true`, pengidentifikasi AWS KMS kunci untuk instance terenkripsi.   
Tipe: String  
Wajib: Tidak

 ** LatestRestorableTime **   
Menentukan waktu terbaru yang database dapat dipulihkan dengan point-in-time restore.  
Tipe: Timestamp  
Wajib: Tidak

 ** PendingModifiedValues **   
Menentukan bahwa perubahan pada instans sedang tertunda. Elemen ini disertakan hanya ketika perubahan tertunda. Perubahan spesifik diidentifikasi oleh sub elemen.  
Tipe: Objek [PendingModifiedValues](API_PendingModifiedValues.md)  
Wajib: Tidak

 ** PerformanceInsightsEnabled **   
Setel ke `true` jika Amazon RDS Performance Insights diaktifkan untuk instans DB, dan sebaliknya. `false`  
Tipe: Boolean  
Wajib: Tidak

 ** PerformanceInsightsKMSKeyId **   
Pengenal AWS KMS kunci untuk enkripsi data Performance Insights. ID AWS KMS kunci adalah Nama Sumber Daya Amazon (ARN), pengenal AWS KMS kunci, atau alias kunci untuk AWS KMS kunci enkripsi. AWS KMS   
Tipe: String  
Wajib: Tidak

 ** PreferredBackupWindow **   
 Menentukan rentang waktu harian selama pencadangan otomatis dibuat jika pencadangan otomatis diaktifkan, seperti yang ditentukan oleh `BackupRetentionPeriod`.   
Tipe: String  
Wajib: Tidak

 ** PreferredMaintenanceWindow **   
Menentukan rentang waktu mingguan untuk melakukan pemeliharaan sistem, dalam Waktu Universal Terkoordinasi (UTC).  
Tipe: String  
Wajib: Tidak

 ** PromotionTier **   
Nilai yang menentukan urutan di mana replika Amazon DocumentDB dipromosikan ke instans primer setelah kegagalan instans primer yang ada.  
Tipe: Integer  
Wajib: Tidak

 ** PubliclyAccessible **   
Tidak didukung. Amazon DocumentDB saat ini tidak mendukung titik akhir publik. Nilai dari `PubliclyAccessible` selalu `false`.  
Tipe: Boolean  
Wajib: Tidak

 ** StatusInfos.DBInstanceStatusInfo.N **   
Status replika baca. Jika instans bukan replika baca, ini kosong.  
Tipe: Array objek [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md)  
Wajib: Tidak

 ** StorageEncrypted **   
Menentukan apakah instans dienkripsi atau tidak.  
Tipe: Boolean  
Wajib: Tidak

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
Menyediakan daftar elemen grup keamanan VPC tempat instans berada.  
Tipe: Array objek [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)  
Wajib: Tidak

## Lihat Juga
<a name="API_DBInstance_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstance) 

# DBInstanceStatusInfo
<a name="API_DBInstanceStatusInfo"></a>

Menyediakan daftar informasi status untuk sebuah instans.

## Daftar Isi
<a name="API_DBInstanceStatusInfo_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** Message **   
Detail kesalahan jika ada kesalahan untuk instans. Jika instans tidak dalam status kesalahan, nilai ini kosong.  
Tipe: String  
Wajib: Tidak

 ** Normal **   
Nilai Boolean yaitu `true` jika instans beroperasi secara normal, atau `false` jika instans berada dalam status kesalahan.  
Tipe: Boolean  
Wajib: Tidak

 ** Status **   
Status dari instans. Untuk `StatusType` dari replika baca, nilainya bisa `replicating`, error, `stopped`, atau `terminated`.  
Tipe: String  
Wajib: Tidak

 ** StatusType **   
Nilai ini saat ini adalah “`read replication`.”  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_DBInstanceStatusInfo_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstanceStatusInfo) 

# DBSubnetGroup
<a name="API_DBSubnetGroup"></a>

Informasi mendetail tentang grup subnet. 

## Daftar Isi
<a name="API_DBSubnetGroup_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** DBSubnetGroupArn **   
Amazon Resource Name (ARN) untuk grup subnet DB.  
Tipe: String  
Wajib: Tidak

 ** DBSubnetGroupDescription **   
Menyediakan deskripsi grup subnet.  
Tipe: String  
Wajib: Tidak

 ** DBSubnetGroupName **   
Nama grup subnet.  
Tipe: String  
Wajib: Tidak

 ** SubnetGroupStatus **   
Menyediakan status grup subnet.  
Tipe: String  
Wajib: Tidak

 ** Subnets.Subnet.N **   
Informasi mendetail tentang satu atau lebih subnet dalam grup subnet.  
Tipe: Array objek [Subnet](API_Subnet.md)  
Wajib: Tidak

 ** SupportedNetworkTypes.member.N **   
Jenis jaringan grup subnet DB.  
Nilai Valid: `IPV4` \$1 `DUAL`   
A hanya `DBSubnetGroup` dapat mendukung IPv4 protokol atau IPv4 dan IPv6 protokol (DUAL).  
Tipe: Array string  
Wajib: Tidak

 ** VpcId **   
Menyediakan ID virtual private cloud (VPC) dari grup subnet.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_DBSubnetGroup_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBSubnetGroup) 

# Endpoint
<a name="API_Endpoint"></a>

Informasi jaringan untuk mengakses klaster atau instans. Program klien harus menentukan titik akhir yang valid untuk mengakses sumber daya Amazon DocumentDB ini.

## Daftar Isi
<a name="API_Endpoint_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** Address **   
Menentukan alamat DNS dari instans.  
Tipe: String  
Wajib: Tidak

 ** HostedZoneId **   
Menentukan ID yang ditetapkan Amazon Route 53 saat Anda membuat zona yang di-hosting.  
Tipe: String  
Wajib: Tidak

 ** Port **   
Menentukan port yang didengarkan oleh mesin basis data.  
Tipe: Integer  
Wajib: Tidak

## Lihat Juga
<a name="API_Endpoint_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Endpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Endpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Endpoint) 

# EngineDefaults
<a name="API_EngineDefaults"></a>

Berisi hasil pemanggilan operasi `DescribeEngineDefaultClusterParameters` yang berhasil. 

## Daftar Isi
<a name="API_EngineDefaults_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** DBParameterGroupFamily **   
Nama famili grup parameter klaster untuk mengembalikan informasi parameter mesin.  
Tipe: String  
Wajib: Tidak

 ** Marker **   
Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan `MaxRecords`.  
Tipe: String  
Wajib: Tidak

 ** Parameters.Parameter.N **   
Parameter dari famili grup parameter klaster tertentu.  
Tipe: Array objek [Parameter](API_Parameter.md)  
Wajib: Tidak

## Lihat Juga
<a name="API_EngineDefaults_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EngineDefaults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EngineDefaults) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EngineDefaults) 

# Event
<a name="API_Event"></a>

Informasi mendetail tentang sebuah peristiwa.

## Daftar Isi
<a name="API_Event_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** Date **   
Menentukan tanggal dan waktu peristiwa.  
Tipe: Timestamp  
Wajib: Tidak

 ** EventCategories.EventCategory.N **   
Menentukan kategori untuk peristiwa tersebut.  
Tipe: Array string  
Wajib: Tidak

 ** Message **   
Menyediakan teks peristiwa ini.  
Tipe: String  
Wajib: Tidak

 ** SourceArn **   
Amazon Resource Name (ARN) untuk peristiwa.  
Tipe: String  
Wajib: Tidak

 ** SourceIdentifier **   
Menyediakan pengidentifikasi untuk sumber peristiwa.  
Tipe: String  
Wajib: Tidak

 ** SourceType **   
Menentukan jenis sumber untuk peristiwa ini.  
Tipe: String  
Nilai yang Valid: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
Wajib: Tidak

## Lihat Juga
<a name="API_Event_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Event) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Event) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Event) 

# EventCategoriesMap
<a name="API_EventCategoriesMap"></a>

Jenis sumber peristiwa, disertai dengan satu atau beberapa nama kategori peristiwa.

## Daftar Isi
<a name="API_EventCategoriesMap_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** EventCategories.EventCategory.N **   
Kategori peristiwa untuk jenis sumber yang ditentukan.  
Tipe: Array string  
Wajib: Tidak

 ** SourceType **   
Jenis sumber yang dimiliki oleh kategori yang dikembalikan.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_EventCategoriesMap_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventCategoriesMap) 

# EventSubscription
<a name="API_EventSubscription"></a>

Informasi mendetail tentang peristiwa yang telah Anda langgani.

## Daftar Isi
<a name="API_EventSubscription_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** CustomerAwsId **   
Akun AWS pelanggan yang terkait dengan langganan notifikasi acara Amazon DocumentDB.  
Tipe: String  
Wajib: Tidak

 ** CustSubscriptionId **   
ID langganan notifikasi peristiwa Amazon DocumentDB.  
Tipe: String  
Wajib: Tidak

 ** Enabled **   
Nilai Boolean yang menunjukkan apakah langganan diaktifkan. Nilai dari `true` menunjukkan bahwa langganan diaktifkan.  
Tipe: Boolean  
Wajib: Tidak

 ** EventCategoriesList.EventCategory.N **   
Daftar kategori acara untuk langganan notifikasi peristiwa Amazon DocumentDB.  
Tipe: Array string  
Wajib: Tidak

 ** EventSubscriptionArn **   
Amazon Resource Name (ARN) untuk langganan peristiwa.  
Tipe: String  
Wajib: Tidak

 ** SnsTopicArn **   
ARN topik langganan notifikasi peristiwa Amazon DocumentDB.  
Tipe: String  
Wajib: Tidak

 ** SourceIdsList.SourceId.N **   
Daftar sumber IDs untuk langganan pemberitahuan acara Amazon DocumentDB.  
Tipe: Array string  
Wajib: Tidak

 ** SourceType **   
Jenis sumber untuk langganan notifikasi peristiwa Amazon DocumentDB.  
Tipe: String  
Wajib: Tidak

 ** Status **   
Status langganan notifikasi peristiwa Amazon DocumentDB.  
Batasan:  
Dapat menjadi salah satu dari yang berikut: `creating`, `modifying`, `deleting`, `active`, `no-permission`, `topic-not-exist`   
Status `no-permission` menunjukkan bahwa Amazon DocumentDB tidak lagi memiliki izin untuk memposting ke topik SNS. Status `topic-not-exist` menunjukkan bahwa topik telah dihapus setelah langganan dibuat.  
Tipe: String  
Wajib: Tidak

 ** SubscriptionCreationTime **   
Waktu saat langganan notifikasi peristiwa Amazon DocumentDB dibuat.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_EventSubscription_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventSubscription) 

# FailoverState
<a name="API_FailoverState"></a>

Berisi status operasi terjadwal atau dalam proses pada klaster global Amazon DocumentDB. Tipe data ini kosong kecuali jika operasi switchover atau failover dijadwalkan atau sedang berlangsung di cluster global.

## Daftar Isi
<a name="API_FailoverState_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** FromDbClusterArn **   
Nama Sumber Daya Amazon (ARN) dari cluster Amazon DocumentDB yang saat ini sedang diturunkan, dan yang terkait dengan status ini.  
Tipe: String  
Wajib: Tidak

 ** IsDataLossAllowed **   
Menunjukkan apakah operasi adalah peralihan global atau failover global. Jika kehilangan data diperbolehkan, maka operasinya adalah failover global. Jika tidak, itu adalah peralihan.  
Tipe: Boolean  
Wajib: Tidak

 ** Status **   
Status cluster global saat ini. Kemungkinan nilainya adalah sebagai berikut:  
+  **pending** — Layanan menerima permintaan untuk beralih atau gagal melalui klaster global. Cluster primer cluster global dan cluster sekunder yang ditentukan sedang diverifikasi sebelum operasi dimulai.
+  **failing-over** — Cluster sekunder yang dipilih sedang dipromosikan menjadi cluster primer baru yang gagal di atas klaster global.
+  **membatalkan** — Permintaan untuk beralih atau gagal atas klaster global dibatalkan dan cluster primer dan cluster sekunder yang dipilih kembali ke status sebelumnya.
Tipe: String  
Nilai yang Valid: `pending | failing-over | cancelling`   
Wajib: Tidak

 ** ToDbClusterArn **   
Nama Sumber Daya Amazon (ARN) dari cluster Amazon DocumentDB yang saat ini sedang dipromosikan, dan yang terkait dengan status ini.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_FailoverState_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverState) 

# Filter
<a name="API_Filter"></a>

Kumpulan nilai filter bernama, digunakan untuk menampilkan daftar hasil yang lebih spesifik. Anda dapat menggunakan filter untuk mencocokkan sekumpulan sumber daya berdasarkan kriteria tertentu, seperti IDs.

Wildcard tidak didukung dalam filter.

## Daftar Isi
<a name="API_Filter_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** Name **   
Nama filter. Nama filter peka huruf besar/kecil.  
Tipe: String  
Diperlukan: Ya

 ** Values.Value.N **   
Satu atau lebih nilai filter. Nilai filter peka huruf besar/kecil.  
Tipe: Array string  
Wajib: Ya

## Lihat Juga
<a name="API_Filter_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Filter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Filter) 

# GlobalCluster
<a name="API_GlobalCluster"></a>

Sebuah tipe data yang mewakili sebuah klaster global Amazon DocumentDB.

## Daftar Isi
<a name="API_GlobalCluster_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** DatabaseName **   
Nama basis data default dalam klaster global baru.  
Tipe: String  
Wajib: Tidak

 ** DeletionProtection **   
Pengaturan perlindungan penghapusan untuk klaster global baru.  
Tipe: Boolean  
Wajib: Tidak

 ** Engine **   
Mesin basis data Amazon DocumentDB yang digunakan oleh klaster global.   
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Menunjukkan versi mesin basis data.  
Tipe: String  
Wajib: Tidak

 ** FailoverState **   
Objek data yang berisi semua properti untuk status saat ini dari proses proses atau proses peralihan atau failover yang tertunda untuk klaster global ini. Objek ini kosong kecuali `FailoverGlobalCluster` operasi `SwitchoverGlobalCluster` atau dipanggil pada cluster global ini.  
Tipe: Objek [FailoverState](API_FailoverState.md)  
Wajib: Tidak

 ** GlobalClusterArn **   
Amazon Resource Name (ARN) untuk klaster global.  
Tipe: String  
Wajib: Tidak

 ** GlobalClusterIdentifier **   
Berisi pengidentifikasi klaster global yang disediakan pengguna. Pengidentifikasi ini adalah kunci unik yang mengidentifikasi sebuah klaster global.   
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `[A-Za-z][0-9A-Za-z-:._]*`   
Wajib: Tidak

 ** GlobalClusterMembers.GlobalClusterMember.N **   
Daftar cluster IDs untuk cluster sekunder dalam cluster global. Saat ini terbatas pada satu item.   
Tipe: Array objek [GlobalClusterMember](API_GlobalClusterMember.md)  
Wajib: Tidak

 ** GlobalClusterResourceId **   
 Wilayah AWS Region-unique, identifier yang tidak dapat diubah untuk cluster database global. Pengenal ini ditemukan di entri AWS CloudTrail log setiap kali kunci master AWS KMS pelanggan (CMK) untuk cluster diakses.   
Tipe: String  
Wajib: Tidak

 ** Status **   
Menentukan status saat ini dari klaster global ini.  
Tipe: String  
Wajib: Tidak

 ** StorageEncrypted **   
Pengaturan enkripsi penyimpanan untuk klaster global.  
Tipe: Boolean  
Wajib: Tidak

 ** TagList.Tag.N **   
Daftar tag cluster global.  
Tipe: Array objek [Tag](API_Tag.md)  
Wajib: Tidak

## Lihat Juga
<a name="API_GlobalCluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalCluster) 

# GlobalClusterMember
<a name="API_GlobalClusterMember"></a>

Struktur data dengan informasi tentang setiap klaster primer dan sekunder yang terkait dengan klaster global Amazon DocumentDB. 

## Daftar Isi
<a name="API_GlobalClusterMember_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** DBClusterArn **   
Amazon Resource Name (ARN) untuk setiap klaster Amazon DocumentDB.  
Tipe: String  
Wajib: Tidak

 ** IsWriter **   
 Menentukan apakah klaster Amazon DocumentDB adalah klaster primer (yaitu, memiliki kemampuan baca-tulis) untuk klaster global Amazon DocumentDB yang terkait dengannya.   
Tipe: Boolean  
Wajib: Tidak

 ** Readers.member.N **   
Amazon Resource Name (ARN) untuk setiap klaster sekunder read-only yang terkait dengan cluster global Amazon DocumentDB.  
Tipe: Array string  
Wajib: Tidak

 ** SynchronizationStatus **   
Status sinkronisasi setiap cluster Amazon DocumentDB di cluster global.  
Tipe: String  
Nilai yang Valid: `connected | pending-resync`   
Wajib: Tidak

## Lihat Juga
<a name="API_GlobalClusterMember_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalClusterMember) 

# OrderableDBInstanceOption
<a name="API_OrderableDBInstanceOption"></a>

Opsi yang tersedia untuk instans.

## Daftar Isi
<a name="API_OrderableDBInstanceOption_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** AvailabilityZones.AvailabilityZone.N **   
Daftar Availability Zone untuk instans.  
Tipe: Array objek [AvailabilityZone](API_AvailabilityZone.md)  
Wajib: Tidak

 ** DBInstanceClass **   
Kelas instans untuk sebuah instans.  
Tipe: String  
Wajib: Tidak

 ** Engine **   
Jenis mesin dari sebuah instans.  
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Versi mesin dari sebuah instans.  
Tipe: String  
Wajib: Tidak

 ** LicenseModel **   
Model lisensi untuk sebuah instans.  
Tipe: String  
Wajib: Tidak

 ** StorageType **   
Jenis penyimpanan untuk diasosiasikan dengan cluster DB  
Tipe: String  
Wajib: Tidak

 ** Vpc **   
Menunjukkan apakah sebuah instans berada dalam virtual private cloud (VPC).  
Tipe: Boolean  
Wajib: Tidak

## Lihat Juga
<a name="API_OrderableDBInstanceOption_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/OrderableDBInstanceOption) 

# Parameter
<a name="API_Parameter"></a>

Informasi mendetail tentang parameter individu.

## Daftar Isi
<a name="API_Parameter_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** AllowedValues **   
Menentukan rentang nilai yang valid untuk parameter.  
Tipe: String  
Wajib: Tidak

 ** ApplyMethod **   
Menunjukkan kapan harus menerapkan pembaruan parameter.  
Tipe: String  
Nilai yang Valid: `immediate | pending-reboot`   
Wajib: Tidak

 ** ApplyType **   
Menentukan jenis parameter spesifik mesin.  
Tipe: String  
Wajib: Tidak

 ** DataType **   
Menentukan tipe data yang valid untuk parameter.  
Tipe: String  
Wajib: Tidak

 ** Description **   
Menyediakan deskripsi parameter.  
Tipe: String  
Wajib: Tidak

 ** IsModifiable **   
 Menunjukkan apakah (`true`) atau tidak (`false`) parameter dapat dimodifikasi. Beberapa parameter memiliki implikasi keamanan atau operasional yang mencegahnya untuk diubah.   
Tipe: Boolean  
Wajib: Tidak

 ** MinimumEngineVersion **   
Versi mesin paling awal yang parameternya dapat diterapkan.  
Tipe: String  
Wajib: Tidak

 ** ParameterName **   
Menentukan nama dari parameter.  
Tipe: String  
Wajib: Tidak

 ** ParameterValue **   
Menentukan nilai dari parameter. Harus satu atau lebih parameter cluster `AllowedValues` dalam format CSV:  
Nilai yang valid adalah:  
+  `enabled`: Cluster menerima koneksi aman menggunakan TLS versi 1.0 hingga 1.3. 
+  `disabled`: Cluster tidak menerima koneksi aman menggunakan TLS. 
+  `fips-140-3`: Cluster hanya menerima koneksi aman sesuai persyaratan publikasi Federal Information Processing Standards (FIPS) 140-3. Hanya didukung mulai dengan Amazon DocumentDB 5.0 (versi engine 3.0.3727) cluster di wilayah ini: ca-central-1, us-west-2, us-east-1, us-east-1, us-east-2, us-east-2, -1. us-gov-east us-gov-west
+  `tls1.2+`: Cluster menerima koneksi aman menggunakan TLS versi 1.2 ke atas. Hanya didukung mulai dengan Amazon DocumentDB 4.0 (versi mesin 2.0.10980) dan Amazon DocumentDB 5.0 (engine versi 3.0.11051).
+  `tls1.3+`: Cluster menerima koneksi aman menggunakan TLS versi 1.3 ke atas. Hanya didukung mulai dengan Amazon DocumentDB 4.0 (versi mesin 2.0.10980) dan Amazon DocumentDB 5.0 (engine versi 3.0.11051).
Tipe: String  
Wajib: Tidak

 ** Source **   
Menunjukkan sumber nilai parameter.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_Parameter_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Parameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Parameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Parameter) 

# PendingCloudwatchLogsExports
<a name="API_PendingCloudwatchLogsExports"></a>

Daftar jenis log yang konfigurasinya masih tertunda. Jenis log ini sedang dalam proses diaktifkan atau dinonaktifkan.

## Daftar Isi
<a name="API_PendingCloudwatchLogsExports_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** LogTypesToDisable.member.N **   
Jenis log yang sedang dalam proses diaktifkan. Setelah diaktifkan, jenis log ini diekspor ke Amazon CloudWatch Logs.  
Tipe: Array string  
Wajib: Tidak

 ** LogTypesToEnable.member.N **   
Jenis log yang sedang dalam proses dinonaktifkan. Setelah dinonaktifkan, jenis log ini tidak diekspor ke CloudWatch Log.  
Tipe: Array string  
Wajib: Tidak

## Lihat Juga
<a name="API_PendingCloudwatchLogsExports_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingCloudwatchLogsExports) 

# PendingMaintenanceAction
<a name="API_PendingMaintenanceAction"></a>

Menyediakan informasi tentang tindakan pemeliharaan yang tertunda untuk sumber daya.

## Daftar Isi
<a name="API_PendingMaintenanceAction_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** Action **   
Jenis tindakan pemeliharaan tertunda yang tersedia untuk sumber daya.  
Tipe: String  
Wajib: Tidak

 ** AutoAppliedAfterDate **   
Tanggal jendela pemeliharaan saat tindakan diterapkan. Tindakan pemeliharaan diterapkan ke sumber daya selama jendela pemeliharaan pertama setelah tanggal ini. Jika tanggal ini ditentukan, semua permintaan opt-in `next-maintenance` diabaikan.  
Tipe: Timestamp  
Wajib: Tidak

 ** CurrentApplyDate **   
Tanggal efektif ketika tindakan pemeliharaan tertunda diterapkan ke sumber daya.  
Tipe: Timestamp  
Wajib: Tidak

 ** Description **   
Deskripsi yang memberikan detail lebih lanjut tentang tindakan pemeliharaan.  
Tipe: String  
Wajib: Tidak

 ** ForcedApplyDate **   
Tanggal ketika tindakan pemeliharaan diterapkan secara otomatis. Tindakan pemeliharaan diterapkan ke sumber daya pada tanggal ini terlepas dari jendela pemeliharaan untuk sumber daya. Jika tanggal ini ditentukan, semua permintaan opt-in `immediate` diabaikan.  
Tipe: Timestamp  
Wajib: Tidak

 ** OptInStatus **   
Menunjukkan jenis permintaan opt-in yang telah diterima untuk sumber daya.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_PendingMaintenanceAction_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingMaintenanceAction) 

# PendingModifiedValues
<a name="API_PendingModifiedValues"></a>

 Satu atau lebih pengaturan yang dimodifikasi untuk sebuah instans. Pengaturan yang dimodifikasi ini telah diminta, tetapi belum diterapkan.

## Daftar Isi
<a name="API_PendingModifiedValues_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** AllocatedStorage **   
 Berisi ukuran `AllocatedStorage` baru untuk instans yang akan diterapkan atau sedang diterapkan.   
Tipe: Integer  
Wajib: Tidak

 ** BackupRetentionPeriod **   
Menentukan jumlah hari yang tertunda untuk penyimpanan cadangan otomatis dipertahankan.  
Tipe: Integer  
Wajib: Tidak

 ** CACertificateIdentifier **   
Menentukan pengidentifikasi sertifikat otoritas sertifikat (CA) untuk instans DB.  
Tipe: String  
Wajib: Tidak

 ** DBInstanceClass **   
 Berisi `DBInstanceClass` baru untuk instans yang akan diterapkan atau sedang diterapkan.   
Tipe: String  
Wajib: Tidak

 ** DBInstanceIdentifier **   
 Berisi `DBInstanceIdentifier` baru untuk instans yang akan diterapkan atau sedang diterapkan.   
Tipe: String  
Wajib: Tidak

 ** DBSubnetGroupName **   
Grup subnet baru untuk instans.   
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Menunjukkan versi mesin basis data.  
Tipe: String  
Wajib: Tidak

 ** Iops **   
Menentukan nilai Provisioned IOPS baru untuk instans yang akan diterapkan atau sedang diterapkan.  
Tipe: Integer  
Wajib: Tidak

 ** LicenseModel **   
Model lisensi untuk instans.  
Nilai valid: `license-included`, `bring-your-own-license`, `general-public-license`   
Tipe: String  
Wajib: Tidak

 ** MasterUserPassword **   
Berisi perubahan yang tertunda atau sedang dalam proses dari kredensial utama untuk instans.  
Tipe: String  
Wajib: Tidak

 ** MultiAZ **   
Menunjukkan bahwa instans Single-AZ akan berubah menjadi deployment Multi-AZ.  
Tipe: Boolean  
Wajib: Tidak

 ** PendingCloudwatchLogsExports **   
Daftar jenis log yang konfigurasinya masih tertunda. Jenis log ini sedang dalam proses diaktifkan atau dinonaktifkan.  
Tipe: Objek [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md)  
Wajib: Tidak

 ** Port **   
Menentukan port tertunda untuk instans.  
Tipe: Integer  
Wajib: Tidak

 ** StorageType **   
Menentukan jenis penyimpanan yang akan dikaitkan dengan instans.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_PendingModifiedValues_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingModifiedValues) 

# ResourcePendingMaintenanceActions
<a name="API_ResourcePendingMaintenanceActions"></a>

Merupakan output dari [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md). 

## Daftar Isi
<a name="API_ResourcePendingMaintenanceActions_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N **   
Daftar yang menyediakan detail tentang tindakan pemeliharaan yang tertunda untuk sumber daya.  
Tipe: Array objek [PendingMaintenanceAction](API_PendingMaintenanceAction.md)  
Wajib: Tidak

 ** ResourceIdentifier **   
Amazon Resource Name (ARN) dari sumber daya yang memiliki tindakan pemeliharaan tertunda.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_ResourcePendingMaintenanceActions_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResourcePendingMaintenanceActions) 

# ServerlessV2FeaturesSupport
<a name="API_ServerlessV2FeaturesSupport"></a>

Menentukan properti Amazon DocumentDB Serverless atau batas yang berbeda antara versi mesin Amazon DocumentDB. Anda dapat menguji nilai atribut ini saat memutuskan versi Amazon DocumentDB mana yang akan digunakan dalam klaster baru atau yang ditingkatkan. Anda juga dapat mengambil versi klaster yang ada dan memeriksa apakah versi tersebut mendukung fitur Amazon DocumentDB Tanpa Server tertentu sebelum Anda mencoba menggunakan fitur tersebut.

## Daftar Isi
<a name="API_ServerlessV2FeaturesSupport_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** MaxCapacity **   
Jumlah maksimum unit kapasitas Amazon DocumentDB DCUs () untuk instans di klaster Amazon DocumentDB Tanpa Server. Anda dapat menentukan nilai DCU dalam kenaikan setengah langkah, seperti 32, 32.5, 33, dan seterusnya.  
Tipe: Ganda  
Wajib: Tidak

 ** MinCapacity **   
Jumlah minimum unit kapasitas Amazon DocumentDB DCUs () untuk instans di klaster Amazon DocumentDB Tanpa Server. Anda dapat menentukan nilai DCU dalam kenaikan setengah langkah, seperti 8, 8.5, 9, dan seterusnya.  
Tipe: Ganda  
Wajib: Tidak

## Lihat Juga
<a name="API_ServerlessV2FeaturesSupport_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2FeaturesSupport) 

# ServerlessV2ScalingConfiguration
<a name="API_ServerlessV2ScalingConfiguration"></a>

Menetapkan konfigurasi penskalaan klaster Amazon DocumentDB Tanpa Server.

## Daftar Isi
<a name="API_ServerlessV2ScalingConfiguration_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** MaxCapacity **   
Jumlah maksimum unit kapasitas Amazon DocumentDB DCUs () untuk instans di klaster Amazon DocumentDB Tanpa Server. Anda dapat menentukan nilai DCU dalam kenaikan setengah langkah, seperti 32, 32.5, 33, dan seterusnya.  
Tipe: Ganda  
Wajib: Tidak

 ** MinCapacity **   
Jumlah minimum unit kapasitas Amazon DocumentDB DCUs () untuk instans di klaster Amazon DocumentDB Tanpa Server. Anda dapat menentukan nilai DCU dalam kenaikan setengah langkah, seperti 8, 8.5, 9, dan seterusnya.  
Tipe: Ganda  
Wajib: Tidak

## Lihat Juga
<a name="API_ServerlessV2ScalingConfiguration_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 

# ServerlessV2ScalingConfigurationInfo
<a name="API_ServerlessV2ScalingConfigurationInfo"></a>

Mengambil konfigurasi penskalaan untuk klaster Amazon DocumentDB Tanpa Server.

## Daftar Isi
<a name="API_ServerlessV2ScalingConfigurationInfo_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** MaxCapacity **   
Jumlah maksimum unit kapasitas Amazon DocumentDB DCUs () untuk instans di klaster Amazon DocumentDB Tanpa Server. Anda dapat menentukan nilai DCU dalam kenaikan setengah langkah, seperti 32, 32.5, 33, dan seterusnya.   
Tipe: Ganda  
Wajib: Tidak

 ** MinCapacity **   
Jumlah minimum unit kapasitas Amazon DocumentDB DCUs () untuk instans di klaster Amazon DocumentDB Tanpa Server. Anda dapat menentukan nilai DCU dalam kenaikan setengah langkah, seperti 8, 8.5, 9, dan seterusnya.  
Tipe: Ganda  
Wajib: Tidak

## Lihat Juga
<a name="API_ServerlessV2ScalingConfigurationInfo_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 

# Subnet
<a name="API_Subnet"></a>

 Informasi mendetail tentang subnet. 

## Daftar Isi
<a name="API_Subnet_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** SubnetAvailabilityZone **   
Menentukan Availability Zone untuk subnet.  
Tipe: Objek [AvailabilityZone](API_AvailabilityZone.md)  
Wajib: Tidak

 ** SubnetIdentifier **   
Menentukan pengidentifikasi dari subnet.  
Tipe: String  
Wajib: Tidak

 ** SubnetStatus **   
Menentukan status dari subnet.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_Subnet_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Subnet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Subnet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Subnet) 

# Tag
<a name="API_Tag"></a>

Metadata yang ditetapkan ke sumber daya Amazon DocumentDB yang terdiri dari pasangan nilai kunci.

## Daftar Isi
<a name="API_Tag_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** Key **   
Nama tag yang diperlukan. Nilai string dapat terdiri dari 1 hingga 128 karakter Unicode dan tidak boleh diawali dengan "`aws:`" atau "`rds:`". String tersebut dapat berisi rangkaian huruf Unicode, angka, spasi, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
Tipe: String  
Wajib: Tidak

 ** Value **   
Nilai opsional dari tag. Nilai string dapat terdiri dari 1 hingga 256 karakter Unicode dan tidak boleh diawali dengan "`aws:`" atau "`rds:`". String tersebut dapat berisi rangkaian huruf Unicode, angka, spasi, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_Tag_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Tag) 

# UpgradeTarget
<a name="API_UpgradeTarget"></a>

Versi mesin basis data yang dapat ditingkatkan instans.

## Daftar Isi
<a name="API_UpgradeTarget_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** AutoUpgrade **   
Nilai yang menunjukkan apakah versi target diterapkan ke instans DB sumber apa pun yang memiliki `AutoMinorVersionUpgrade` yang diatur ke `true`.  
Tipe: Boolean  
Wajib: Tidak

 ** Description **   
Versi mesin basis data yang dapat ditingkatkan instans.  
Tipe: String  
Wajib: Tidak

 ** Engine **   
Nama mesin basis data target peningkatan.  
Tipe: String  
Wajib: Tidak

 ** EngineVersion **   
Nomor versi mesin basis data target peningkatan.  
Tipe: String  
Wajib: Tidak

 ** IsMajorVersionUpgrade **   
Nilai yang menunjukkan apakah mesin basis data ditingkatkan ke versi major.  
Tipe: Boolean  
Wajib: Tidak

## Lihat Juga
<a name="API_UpgradeTarget_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/UpgradeTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/UpgradeTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/UpgradeTarget) 

# VpcSecurityGroupMembership
<a name="API_VpcSecurityGroupMembership"></a>

Digunakan sebagai elemen respons untuk kueri tentang keanggotaan grup keamanan virtual private cloud (VPC).

## Daftar Isi
<a name="API_VpcSecurityGroupMembership_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** Status **   
Status grup keamanan VPC.  
Tipe: String  
Wajib: Tidak

 ** VpcSecurityGroupId **   
Nama grup keamanan VPC.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_VpcSecurityGroupMembership_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/VpcSecurityGroupMembership) 

# Cluster Elastis Amazon DocumentDB
<a name="API_Types_Amazon_DocumentDB_Elastic_Clusters"></a>

Tipe data berikut didukung oleh Amazon DocumentDB Elastic Clusters:
+  [Cluster](API_elastic_Cluster.md) 
+  [ClusterInList](API_elastic_ClusterInList.md) 
+  [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 
+  [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 
+  [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 
+  [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 
+  [Shard](API_elastic_Shard.md) 
+  [ValidationExceptionField](API_elastic_ValidationExceptionField.md) 

# Cluster
<a name="API_elastic_Cluster"></a>

Mengembalikan informasi tentang cluster elastis tertentu.

## Daftar Isi
<a name="API_elastic_Cluster_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** adminUserName **   <a name="documentdb-Type-elastic_Cluster-adminUserName"></a>
Nama administrator cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** authType **   <a name="documentdb-Type-elastic_Cluster-authType"></a>
Jenis otentikasi untuk cluster elastis.  
Tipe: String  
Nilai yang Valid: `PLAIN_TEXT | SECRET_ARN`   
Wajib: Ya

 ** clusterArn **   <a name="documentdb-Type-elastic_Cluster-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** clusterEndpoint **   <a name="documentdb-Type-elastic_Cluster-clusterEndpoint"></a>
URL yang digunakan untuk terhubung ke cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** clusterName **   <a name="documentdb-Type-elastic_Cluster-clusterName"></a>
Nama cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** createTime **   <a name="documentdb-Type-elastic_Cluster-createTime"></a>
Waktu ketika cluster elastis dibuat di Universal Coordinated Time (UTC).  
Tipe: String  
Diperlukan: Ya

 ** kmsKeyId **   <a name="documentdb-Type-elastic_Cluster-kmsKeyId"></a>
Pengidentifikasi kunci KMS yang digunakan untuk mengenkripsi cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** preferredMaintenanceWindow **   <a name="documentdb-Type-elastic_Cluster-preferredMaintenanceWindow"></a>
Rentang waktu mingguan selama pemeliharaan sistem dapat terjadi, dalam Waktu Universal Terkoordinasi (UTC).  
 *Format*: `ddd:hh24:mi-ddd:hh24:mi`   
Tipe: String  
Diperlukan: Ya

 ** shardCapacity **   <a name="documentdb-Type-elastic_Cluster-shardCapacity"></a>
Jumlah v yang CPUs ditetapkan untuk setiap pecahan cluster elastis. Maksimal adalah 64. Nilai yang diizinkan adalah 2, 4, 8, 16, 32, 64.  
Jenis: Integer  
Wajib: Ya

 ** shardCount **   <a name="documentdb-Type-elastic_Cluster-shardCount"></a>
Jumlah pecahan yang ditugaskan ke cluster elastis. Maksimal adalah 32.  
Jenis: Integer  
Wajib: Ya

 ** status **   <a name="documentdb-Type-elastic_Cluster-status"></a>
Status cluster elastis.  
Tipe: String  
Nilai yang Valid: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Wajib: Ya

 ** subnetIds **   <a name="documentdb-Type-elastic_Cluster-subnetIds"></a>
 EC2 Subnet Amazon IDs untuk cluster elastis.  
Tipe: Array string  
Wajib: Ya

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_Cluster-vpcSecurityGroupIds"></a>
Daftar grup keamanan EC2 VPC yang terkait dengan cluster elastis ini.  
Tipe: Array string  
Wajib: Ya

 ** backupRetentionPeriod **   <a name="documentdb-Type-elastic_Cluster-backupRetentionPeriod"></a>
Jumlah hari di mana snapshot otomatis dipertahankan.  
Tipe: Integer  
Wajib: Tidak

 ** preferredBackupWindow **   <a name="documentdb-Type-elastic_Cluster-preferredBackupWindow"></a>
Rentang waktu harian di mana pencadangan otomatis dibuat jika pencadangan otomatis diaktifkan, sebagaimana ditentukan oleh. `backupRetentionPeriod`  
Tipe: String  
Wajib: Tidak

 ** shardInstanceCount **   <a name="documentdb-Type-elastic_Cluster-shardInstanceCount"></a>
Jumlah contoh replika yang diterapkan ke semua pecahan di cluster. `shardInstanceCount`Nilai 1 berarti ada satu contoh penulis, dan setiap contoh tambahan adalah replika yang dapat digunakan untuk membaca dan untuk meningkatkan ketersediaan.  
Tipe: Integer  
Wajib: Tidak

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
Jumlah total pecahan di cluster.  
Tipe: Array objek [Shard](API_elastic_Shard.md)  
Wajib: Tidak

## Lihat Juga
<a name="API_elastic_Cluster_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster) 

# ClusterInList
<a name="API_elastic_ClusterInList"></a>

Daftar cluster elastis Amazon DocumentDB.

## Daftar Isi
<a name="API_elastic_ClusterInList_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterInList-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** clusterName **   <a name="documentdb-Type-elastic_ClusterInList-clusterName"></a>
Nama cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** status **   <a name="documentdb-Type-elastic_ClusterInList-status"></a>
Status cluster elastis.  
Tipe: String  
Nilai yang Valid: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Wajib: Ya

## Lihat Juga
<a name="API_elastic_ClusterInList_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterInList) 

# ClusterSnapshot
<a name="API_elastic_ClusterSnapshot"></a>

Mengembalikan informasi tentang snapshot cluster elastis tertentu.

## Daftar Isi
<a name="API_elastic_ClusterSnapshot_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** adminUserName **   <a name="documentdb-Type-elastic_ClusterSnapshot-adminUserName"></a>
Nama administrator cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** clusterCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterCreationTime"></a>
Waktu ketika cluster elastis dibuat di Universal Coordinated Time (UTC).  
Tipe: String  
Diperlukan: Ya

 ** kmsKeyId **   <a name="documentdb-Type-elastic_ClusterSnapshot-kmsKeyId"></a>
Pengidentifikasi kunci KMS adalah Amazon Resource Name (ARN) untuk kunci enkripsi KMS. Jika Anda membuat cluster menggunakan akun Amazon yang sama yang memiliki kunci enkripsi KMS ini, Anda dapat menggunakan alias kunci KMS alih-alih ARN sebagai kunci enkripsi KMS. Jika kunci enkripsi tidak ditentukan di sini, Amazon DocumentDB menggunakan kunci enkripsi default yang dibuat KMS untuk akun Anda. Akun Anda memiliki kunci enkripsi default yang berbeda untuk setiap Wilayah Amazon.   
Tipe: String  
Diperlukan: Ya

 ** snapshotArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotArn"></a>
Pengidentifikasi ARN dari snapshot cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotCreationTime"></a>
Waktu ketika snapshot cluster elastis dibuat di Universal Coordinated Time (UTC).  
Tipe: String  
Diperlukan: Ya

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotName"></a>
Nama snapshot cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshot-status"></a>
Status snapshot cluster elastis.  
Tipe: String  
Nilai yang Valid: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Wajib: Ya

 ** subnetIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-subnetIds"></a>
 EC2 Subnet Amazon IDs untuk cluster elastis.  
Tipe: Array string  
Wajib: Ya

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-vpcSecurityGroupIds"></a>
Daftar grup keamanan EC2 VPC untuk diasosiasikan dengan cluster elastis.  
Tipe: Array string  
Wajib: Ya

 ** snapshotType **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotType"></a>
Jenis snapshot klaster untuk dikembalikan. Anda dapat menentukan salah satu nilai berikut:  
+  `automated`- Kembalikan semua snapshot cluster yang Amazon DocumentDB telah secara otomatis dibuat untuk akun Anda. AWS 
+  `manual`- Kembalikan semua snapshot cluster yang telah Anda buat secara manual untuk AWS akun Anda.
Tipe: String  
Nilai yang Valid: `MANUAL | AUTOMATED`   
Wajib: Tidak

## Lihat Juga
<a name="API_elastic_ClusterSnapshot_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshot) 

# ClusterSnapshotInList
<a name="API_elastic_ClusterSnapshotInList"></a>

Daftar snapshot cluster elastis.

## Daftar Isi
<a name="API_elastic_ClusterSnapshotInList_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-clusterArn"></a>
Pengidentifikasi ARN dari cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** snapshotArn **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotArn"></a>
Pengidentifikasi ARN dari snapshot cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotCreationTime"></a>
Waktu ketika snapshot cluster elastis dibuat di Universal Coordinated Time (UTC).  
Tipe: String  
Diperlukan: Ya

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotName"></a>
Nama snapshot cluster elastis.  
Tipe: String  
Diperlukan: Ya

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-status"></a>
Status snapshot cluster elastis.  
Tipe: String  
Nilai yang Valid: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Wajib: Ya

## Lihat Juga
<a name="API_elastic_ClusterSnapshotInList_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshotInList) 

# PendingMaintenanceActionDetails
<a name="API_elastic_PendingMaintenanceActionDetails"></a>

Mengambil rincian tindakan pemeliharaan yang tertunda.

## Daftar Isi
<a name="API_elastic_PendingMaintenanceActionDetails_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** action **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-action"></a>
Menampilkan tindakan spesifik dari tindakan pemeliharaan yang tertunda.  
Tipe: String  
Diperlukan: Ya

 ** autoAppliedAfterDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-autoAppliedAfterDate"></a>
Menampilkan tanggal jendela pemeliharaan saat tindakan diterapkan. Tindakan pemeliharaan diterapkan ke sumber daya selama jendela pemeliharaan pertama setelah tanggal ini. Jika tanggal ini ditentukan, `NEXT_MAINTENANCE` `optInType` permintaan apa pun akan diabaikan.  
Tipe: String  
Wajib: Tidak

 ** currentApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-currentApplyDate"></a>
Menampilkan tanggal efektif ketika tindakan pemeliharaan tertunda diterapkan ke sumber daya.  
Tipe: String  
Wajib: Tidak

 ** description **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-description"></a>
Menampilkan deskripsi yang memberikan detail lebih lanjut tentang tindakan pemeliharaan.  
Tipe: String  
Wajib: Tidak

 ** forcedApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-forcedApplyDate"></a>
Menampilkan tanggal ketika tindakan pemeliharaan diterapkan secara otomatis. Tindakan pemeliharaan diterapkan ke sumber daya pada tanggal ini terlepas dari jendela pemeliharaan untuk sumber daya. Jika tanggal ini ditentukan, `IMMEDIATE` `optInType` permintaan apa pun akan diabaikan.  
Tipe: String  
Wajib: Tidak

 ** optInStatus **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-optInStatus"></a>
Menampilkan jenis `optInType` permintaan yang telah diterima untuk sumber daya.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_elastic_PendingMaintenanceActionDetails_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 

# ResourcePendingMaintenanceAction
<a name="API_elastic_ResourcePendingMaintenanceAction"></a>

Menyediakan informasi tentang tindakan pemeliharaan yang tertunda untuk sumber daya.

## Daftar Isi
<a name="API_elastic_ResourcePendingMaintenanceAction_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** pendingMaintenanceActionDetails **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-pendingMaintenanceActionDetails"></a>
Menyediakan informasi tentang tindakan pemeliharaan yang tertunda untuk sumber daya.  
Tipe: Array objek [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md)  
Wajib: Tidak

 ** resourceArn **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-resourceArn"></a>
Nama Sumber Daya Amazon DocumentDB Amazon (ARN) dari sumber daya tempat tindakan pemeliharaan tertunda berlaku.  
Tipe: String  
Wajib: Tidak

## Lihat Juga
<a name="API_elastic_ResourcePendingMaintenanceAction_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 

# Shard
<a name="API_elastic_Shard"></a>

Nama pecahan itu.

## Daftar Isi
<a name="API_elastic_Shard_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** createTime **   <a name="documentdb-Type-elastic_Shard-createTime"></a>
Waktu ketika pecahan dibuat di Universal Coordinated Time (UTC).  
Tipe: String  
Diperlukan: Ya

 ** shardId **   <a name="documentdb-Type-elastic_Shard-shardId"></a>
ID dari pecahan.  
Tipe: String  
Diperlukan: Ya

 ** status **   <a name="documentdb-Type-elastic_Shard-status"></a>
Status pecahan saat ini.  
Tipe: String  
Nilai yang Valid: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Wajib: Ya

## Lihat Juga
<a name="API_elastic_Shard_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Shard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Shard) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Shard) 

# ValidationExceptionField
<a name="API_elastic_ValidationExceptionField"></a>

Bidang tertentu di mana pengecualian validasi yang diberikan terjadi.

## Daftar Isi
<a name="API_elastic_ValidationExceptionField_Contents"></a>

**catatan**  
Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

 ** message **   <a name="documentdb-Type-elastic_ValidationExceptionField-message"></a>
Pesan kesalahan yang menjelaskan pengecualian validasi di bidang ini.  
Tipe: String  
Diperlukan: Ya

 ** name **   <a name="documentdb-Type-elastic_ValidationExceptionField-name"></a>
Nama bidang tempat pengecualian validasi terjadi.  
Tipe: String  
Wajib: Ya

## Lihat Juga
<a name="API_elastic_ValidationExceptionField_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ValidationExceptionField) 

# Kesalahan Umum
<a name="CommonErrors"></a>

Bagian ini mencantumkan kesalahan yang umum terjadi pada tindakan API dari semua AWS layanan. Untuk kesalahan khusus pada tindakan API untuk layanan ini, lihat topik untuk tindakan API tersebut.

 **AccessDeniedException**   
Anda tidak memiliki akses yang memadai untuk melakukan tindakan ini.  
Kode Status HTTP: 400

 **IncompleteSignature**   
Tanda tangan permintaan tidak sesuai dengan AWS standar.  
Kode Status HTTP: 400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
Pemrosesan permintaan telah gagal karena kesalahan yang tidak diketahui, pengecualian atau kegagalan.  
Kode Status HTTP: 500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
Tindakan atau operasi yang diminta tidak valid. Verifikasi bahwa tindakan diketik dengan benar.  
Kode Status HTTP: 400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
Sertifikat X.509 atau ID kunci AWS akses yang disediakan tidak ada dalam catatan kami.  
Kode Status HTTP: 403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
Anda tidak memiliki izin untuk melakukan tindakan ini.  
Kode Status HTTP: 400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
ID kunci AWS akses memerlukan langganan untuk layanan ini.  
Kode Status HTTP: 403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
Permintaan mencapai layanan lebih dari 15 menit setelah cap tanggal pada permintaan atau lebih dari 15 menit setelah tanggal kedaluwarsa permintaan (seperti untuk pra-ditandatangani URLs), atau cap tanggal pada permintaan lebih dari 15 menit di masa depan.  
Kode Status HTTP: 400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
Permintaan telah gagal karena kegagalan sementara server.  
Kode Status HTTP: 503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
Permintaan ditolak karena throttling permintaan.  
Kode Status HTTP: 400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
Input gagal memenuhi kendala yang ditentukan oleh layanan. AWS   
Kode Status HTTP: 400

# Parameter Umum
<a name="CommonParameters"></a>

Daftar berikut berisi parameter yang digunakan semua tindakan untuk menandatangani permintaan Tanda Tangan Versi 4 dengan string kueri. Setiap parameter khusus tindakan tercantum dalam topik untuk tindakan tersebut. Untuk informasi selengkapnya tentang Tanda Tangan Versi 4, lihat [Menandatangani permintaan AWS API](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) di *Panduan Pengguna IAM*.

 **Action**   <a name="CommonParameters-Action"></a>
Tindakan yang harus dilakukan.  
Tipe: string  
Diperlukan: Ya

 **Version**   <a name="CommonParameters-Version"></a>
Versi API tempat permintaan ditulis, dinyatakan dalam format YYYY-MM-DD.  
Jenis: string  
Diperlukan: Ya

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
Algoritme hash yang Anda gunakan untuk membuat tanda tangan permintaan.  
Syarat: Tentukan parameter ini ketika Anda menyertakan informasi autentikasi dalam string kueri alih-alih di header otorisasi HTTP.  
Tipe: string  
Nilai yang Valid: `AWS4-HMAC-SHA256`   
Diperlukan: Kondisional

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
Nilai lingkup kredensial, yang merupakan string yang menyertakan access key Anda, tanggal, wilayah yang Anda targetkan, layanan yang Anda minta, dan string penghentian ("aws4\$1request"). Nilai dinyatakan dalam format berikut: *access\$1key*/*HHBBTTTT*/*wilayah*/*layanan*/aws4\$1request.  
Untuk informasi selengkapnya, lihat [Membuat permintaan AWS API yang ditandatangani](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) di *Panduan Pengguna IAM*.  
Syarat: Tentukan parameter ini ketika Anda menyertakan informasi autentikasi dalam string kueri alih-alih di header otorisasi HTTP.  
Tipe: string  
Wajib: Bersyarat

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
Tanggal yang digunakan untuk membuat tanda tangan. Format harus berupa format dasar ISO 8601 (YYYYMMDD'T'HMMSS'Z'). Misalnya, waktu tanggal berikut adalah X-Amz-Date nilai yang valid:`20120325T120000Z`.  
Syarat: X-Amz-Date bersifat opsional untuk semua permintaan; ini dapat digunakan untuk menimpa tanggal yang digunakan untuk menandatangani permintaan. Jika header Tanggal ditentukan dalam format dasar ISO 8601, tidak X-Amz-Date diperlukan. Ketika X-Amz-Date digunakan, itu selalu mengesampingkan nilai header Tanggal. Untuk informasi selengkapnya, lihat [Elemen tanda tangan permintaan AWS API](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) di *Panduan Pengguna IAM*.  
Jenis: string  
Wajib: Bersyarat

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
Token keamanan sementara yang diperoleh melalui panggilan ke AWS Security Token Service (AWS STS). Untuk daftar layanan yang mendukung kredensi keamanan sementara AWS STS, lihat layanan [Layanan AWS yang berfungsi dengan IAM di Panduan Pengguna *IAM*](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html).  
Kondisi: Jika Anda menggunakan kredensi keamanan sementara dari AWS STS, Anda harus menyertakan token keamanan.  
Jenis: string  
Wajib: Bersyarat

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
Menentukan tanda tangan yang dikodekan oleh hex yang dihitung dari string to sign dan kunci penandatanganan turunan.  
Syarat: Tentukan parameter ini ketika Anda menyertakan informasi autentikasi dalam string kueri alih-alih di header otorisasi HTTP.  
Tipe: string  
Wajib: Bersyarat

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
Menentukan semua header HTTP yang disertakan sebagai bagian dari permintaan kanonik. Untuk informasi selengkapnya tentang menentukan header yang ditandatangani, lihat [Membuat permintaan AWS API yang ditandatangani](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) di Panduan Pengguna *IAM*.  
Syarat: Tentukan parameter ini ketika Anda menyertakan informasi autentikasi dalam string kueri alih-alih di header otorisasi HTTP.  
Tipe: string  
Diperlukan: Kondisional