ClusterSnapshot - Amazon DocumentDB

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

ClusterSnapshot

Mengembalikan informasi tentang snapshot cluster elastis tertentu.

Daftar Isi

catatan

Dalam daftar berikut, parameter yang diperlukan dijelaskan terlebih dahulu.

adminUserName

Nama administrator cluster elastis.

Tipe: String

Diperlukan: Ya

clusterArn

Pengidentifikasi ARN dari cluster elastis.

Tipe: String

Diperlukan: Ya

clusterCreationTime

Waktu ketika cluster elastis dibuat di Universal Coordinated Time (UTC).

Tipe: String

Diperlukan: Ya

kmsKeyId

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

Pengidentifikasi ARN dari snapshot cluster elastis.

Tipe: String

Diperlukan: Ya

snapshotCreationTime

Waktu ketika snapshot cluster elastis dibuat di Universal Coordinated Time (UTC).

Tipe: String

Diperlukan: Ya

snapshotName

Nama snapshot cluster elastis.

Tipe: String

Diperlukan: Ya

status

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

EC2 Subnet Amazon IDs untuk cluster elastis.

Tipe: Array string

Wajib: Ya

vpcSecurityGroupIds

Daftar grup keamanan EC2 VPC untuk diasosiasikan dengan cluster elastis.

Tipe: Array string

Wajib: Ya

snapshotType

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

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini: