Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
ModifyDBCluster
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
Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.
- DBClusterIdentifier
-
Pengidentifikasi klaster untuk klaster yang sedang dimodifikasi. Parameter ini tidak peka huruf besar kecil.
Batasan:
-
Harus cocok dengan pengidentifikasi
DBCluster
yang ada.
Tipe: String
Diperlukan: Ya
-
- AllowMajorVersionUpgrade
-
Nilai yang menunjukkan apakah pembaruan versi utama diizinkan.
Kendala: Anda harus mengizinkan upgrade versi mayor saat menentukan nilai untuk
EngineVersion
parameter yang merupakan versi mayor yang berbeda dari versi cluster DB saat ini.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 kefalse
, perubahan ke klaster diterapkan selama jendela pemeliharaan berikutnya.Parameter
ApplyImmediately
memengaruhi hanya nilaiNewDBClusterIdentifier
danMasterUserPassword
. Jika Anda mengatur nilai parameter ini kefalse
, perubahan nilaiNewDBClusterIdentifier
danMasterUserPassword
diterapkan selama jendela pemeliharaan berikutnya. Semua perubahan lainnya akan diterapkan dengan segera, terlepas dari nilai parameterApplyImmediately
.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 klaster tertentu.
DisableLogTypes
ArrayEnableLogTypes
dan menentukan log mana yang diekspor (atau tidak diekspor) ke Log. CloudWatchTipe: Objek CloudwatchLogsExportConfiguration
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 danDeletionProtection
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 membuat 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 menentukanMasterUserPassword
. 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 ASCII karakter 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 KMS kunci Amazon Web Services 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 klaster sudah mengelola kata sandi pengguna utama di Amazon Web Services Secrets Manager, Anda tidak dapat mengubah KMS kunci yang digunakan untuk mengenkripsi rahasia.
-
Anda memungkinkan
ManageMasterUserPassword
untuk mengelola kata sandi pengguna utama di Amazon Web Services Secrets Manager. Jika Anda menyalakanManageMasterUserPassword
dan tidak menentukanMasterUserSecretKmsKeyId
, makaaws/secretsmanager
KMS kunci digunakan untuk mengenkripsi rahasia. Jika rahasianya ada di akun Amazon Web Services yang berbeda, maka Anda tidak dapat menggunakanaws/secretsmanager
KMS kunci untuk mengenkripsi rahasia, dan Anda harus menggunakan KMS kunci yang dikelola pelanggan.
Pengidentifikasi KMS kunci Amazon Web Services adalah kunci, ID kunciARN, aliasARN, atau nama alias untuk kunci tersebut. KMS Untuk menggunakan KMS kunci di akun Amazon Web Services yang berbeda, tentukan kunci ARN atau aliasARN.
Ada KMS kunci default untuk akun Amazon Web Services Anda. Akun Amazon Web Services Anda memiliki KMS kunci default yang berbeda untuk setiap Wilayah Amazon Web Services.
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 huruf.
-
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
hingga65535
.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
Batasan:
-
Harus dalam format
hh24:mi-hh24:mi
. -
Harus dalam Waktu Terkoordinasi Universal (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 Terkoordinasi Universal (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
- 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
- VpcSecurityGroupIds. VpcSecurityGroupId.N
-
Daftar grup keamanan virtual private cloud (VPC) yang akan dimiliki cluster tersebut.
Tipe: Array string
Wajib: Tidak
Elemen Respons
Elemen berikut dikembalikan oleh layanan.
- DBCluster
-
Informasi mendetail tentang klaster.
Tipe: Objek DBCluster
Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.
- DBClusterAlreadyExistsFault
-
Anda sudah memiliki klaster dengan pengidentifikasi yang diberikan.
HTTPKode Status: 400
- DBClusterNotFoundFault
-
DBClusterIdentifier
tidak mengacu ke sebuah klaster yang ada.HTTPKode Status: 404
- DBClusterParameterGroupNotFound
-
DBClusterParameterGroupName
tidak mengacu ke grup parameter klaster yang ada.HTTPKode Status: 404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupName
tidak mengacu ke grup subnet yang ada.HTTPKode Status: 404
- InvalidDBClusterStateFault
-
Klaster tidak dalam status valid.
HTTPKode Status: 400
- InvalidDBInstanceState
-
Instans yang ditentukan tidak dalam status tersedia.
HTTPKode Status: 400
- InvalidDBSecurityGroupState
-
Status grup keamanan tidak mengizinkan penghapusan.
HTTPKode Status: 400
- InvalidDBSubnetGroupStateFault
-
Grup subnet tidak dapat dihapus karena sedang digunakan.
HTTPKode Status: 400
- InvalidSubnet
-
Subnet yang diminta tidak valid, atau beberapa subnet diminta yang tidak semuanya berada di cloud pribadi virtual umum ()VPC.
HTTPKode Status: 400
- InvalidVPCNetworkStateFault
-
Grup subnet tidak mencakup semua Availability Zone setelah dibuat karena perubahan yang dibuat.
HTTPKode Status: 400
- StorageQuotaExceeded
-
Permintaan akan menyebabkan Anda melebihi jumlah penyimpanan yang diizinkan yang tersedia di semua instans.
HTTPKode Status: 400
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan ini API di salah satu bahasa khusus AWS SDKs, lihat berikut ini: