ModifyDBInstance - Amazon DocumentDB

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

ModifyDBInstance

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

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

DBInstanceIdentifier

Pengidentifikasi instans. Nilai ini disimpan sebagai string huruf kecil.

Batasan:

  • 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 SSL/TLS Anda.

Secara default, instans DB dimulai ulang saat Anda memutar sertifikat SSL/TLS Anda. Sertifikat tidak diperbarui sampai instans DB dimulai ulang.

penting

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 dan Mengenkripsi Data dalam Transit di 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.

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 huruf.

  • 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 kunci ARN, ID kunci, alias ARN, atau nama alias untuk kunci KMS.

Jika Anda tidak menentukan nilai untuk PerformanceInsights KMSKeyId, 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

Elemen berikut dikembalikan oleh layanan.

DBInstance

Informasi mendetail tentang sebuah instans.

Tipe: Objek DBInstance

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

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

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