Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
CreateDBCluster
Membuat klaster Amazon DocumentDB baru.
Parameter Permintaan
Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.
- 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 huruf.
-
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 danDeletionProtection
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 dan Operasi Pembuatan Profil Amazon DocumentDB.
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.
Jenis: 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
adalahtrue
, 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
-
- MasterUsername
-
Nama pengguna utama untuk klaster.
Batas:
-
Harus dari 1 hingga 63 huruf atau angka.
-
Karakter pertama harus berupa huruf.
-
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
- 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
Batasan:
-
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
- 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
catatan
Saat Anda membuat cluster DB DocumentDB dengan jenis penyimpanan disetel
iopt1
ke, jenis penyimpanan dikembalikan dalam respons. Jenis penyimpanan tidak dikembalikan saat Anda mengaturnyastandard
.Tipe: String
Wajib: Tidak
- Tags.Tag.N
-
Tag yang akan ditetapkan ke klaster.
Tipe: Array objek Tag
Wajib: Tidak
- VpcSecurityGroupIds. VpcSecurityGroupId.N
-
Sebuah daftar grup keamanan VPC EC2 untuk dikaitkan dengan kluster ini.
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.
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
- StorageQuotaExceeded
-
Permintaan akan menyebabkan Anda melebihi jumlah penyimpanan yang diizinkan yang tersedia di semua instans.
Kode Status HTTP: 400
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: