Tipe ALIYUN::MONGODB::Instance digunakan untuk membuat atau mengkloning instans replica set MongoDB.
Sintaksis
{
"Type": "ALIYUN::MONGODB::Instance",
"Properties": {
"DatabaseNames": String,
"VpcPasswordFree": Boolean,
"ReadonlyReplicas": Integer,
"BusinessInfo": String,
"AccountPassword": String,
"VpcId": String,
"SecurityGroupId": String,
"AutoRenew": Boolean,
"ResourceGroupId": String,
"VSwitchId": String,
"StorageEngine": String,
"SrcDBInstanceId": String,
"ReplicationFactor": Integer,
"ZoneId": String,
"EngineVersion": String,
"RestoreTime": String,
"DBInstanceStorage": Integer,
"DBInstanceDescription": String,
"CouponNo": String,
"Period": Integer,
"SecurityIPArray": String,
"ChargeType": String,
"BackupId": String,
"TDEStatus": Boolean,
"DBInstanceClass": String,
"Tags": List,
"SecondaryZoneId": String,
"HiddenZoneId": String,
"StorageType": String,
"PrivateConnections": Map,
"ClusterId": String,
"SrcRegion": String,
"AuditPolicyOptions": Map,
"DBInstanceReleaseProtection": Boolean,
"SSLOptions": Map,
"Encrypted": Boolean,
"ProvisionedIops": Integer,
"EncryptionKey": String,
"RestoreType": Integer,
"BackupPolicyOptions": Map
}
}Properti
Nama Properti | Type | Diperlukan | Pembaruan diizinkan | Deskripsi | Batasan |
DBInstanceStorage | Integer | Ya | Ya | Storage space dari instans database. | Nilai yang valid: 10 hingga 3000. Nilainya harus kelipatan dari 10. Satuan: GB. |
DBInstanceClass | String | Ya | Ya | Tipe instance. | Untuk informasi lebih lanjut, lihat Tipe instance. |
TDEStatus | Boolean | Tidak | Ya | Menentukan apakah akan mengaktifkan Transparent Data Encryption (TDE). | Nilai yang valid:
|
SrcDBInstanceId | String | Tidak | Tidak | ID instance sumber. | Parameter ini ditentukan hanya saat Anda mengkloning instans. Parameter ini harus ditentukan bersama dengan parameter BackupId atau RestoreTime. |
DBInstanceDescription | String | Tidak | Tidak | Deskripsi instance. | Deskripsi harus terdiri dari 2 hingga 256 karakter. Deskripsi harus dimulai dengan huruf atau karakter Tionghoa dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). |
SecurityIPArray | String | Tidak | Ya | Alamat IP dalam daftar putih yang dapat mengakses instans. | Pisahkan beberapa alamat IP dengan koma (,). Setiap alamat IP harus unik. Anda dapat menentukan hingga 1.000 alamat IP. Format yang didukung adalah 0.0.0.0/0, 10.23.XX.XX (alamat IP), atau 10.23.XX.XX/24 (Blok CIDR). Dalam Blok CIDR, /24 menunjukkan bahwa awalan memiliki panjang 24 bit. Panjang awalan dapat berkisar antara 1 hingga 32. Nilai default adalah 0.0.0.0/0, yang menunjukkan bahwa semua alamat IP dapat mengakses instans. |
ClusterId | String | Tidak | Tidak | ID klaster khusus. | Tidak ada |
SrcRegion | String | Tidak | Tidak | Wilayah instans sumber. | Catatan
|
AuditPolicyOptions | Map | Tidak | Ya | Konfigurasi kebijakan audit. | Untuk informasi selengkapnya, lihat bagian properti AuditPolicyOptions. |
DBInstanceReleaseProtection | Boolean | Tidak | Ya | Menentukan apakah akan mengaktifkan perlindungan rilis untuk instans. | Nilai valid:
|
SSLOptions | Map | Tidak | Ya | Konfigurasi enkripsi Transport Layer Security (TLS) dan Secure Sockets Layer (SSL). | Untuk informasi selengkapnya, lihat bagian properti SSLOptions. |
Encrypted | Boolean | Tidak | Tidak | Menentukan apakah akan mengaktifkan enkripsi disk. | Tidak ada |
ProvisionedIops | Integer | Tidak | Tidak | Performa yang disediakan. | Tidak ada |
EncryptionKey | String | Tidak | Tidak | Kunci Key Management Service (KMS) yang digunakan untuk enkripsi disk. | Tidak ada |
RestoreType | Integer | Tidak | Tidak | Anda dapat memulihkan instans dari cadangan. | Nilai valid:
|
BackupPolicyOptions | Map | Tidak | Ya | Konfigurasi kebijakan cadangan. | Untuk informasi selengkapnya, lihat bagian properti BackupPolicyOptions. |
ZoneId | String | Tidak | Tidak | ID zona. | Untuk informasi selengkapnya, lihat DescribeRegions. Jika instans berada dalam VPC, nilai parameter ini harus sama dengan zona vSwitch. |
VpcPasswordFree | Boolean | Tidak | Tidak | Menentukan apakah akan mengaktifkan akses tanpa password ke instans melalui VPC. | Nilai yang valid:
|
VpcId | String | Tidak | Tidak | ID VPC. | Tidak ada |
SecurityGroupId | String | Tidak | Ya | ID grup keamanan. | Tidak ada |
VSwitchId | String | Tidak | Tidak | ID vSwitch. | Tidak ada |
BackupId | String | Tidak | Tidak | ID set cadangan. | Parameter ini ditentukan hanya saat Anda mengkloning instans. Parameter ini harus ditentukan bersama dengan parameter SrcDBInstanceId. |
AccountPassword | String | Tidak | Ya | Kata sandi akun root. | Password harus terdiri dari 6 hingga 32 karakter. Password dapat berisi huruf, angka, dan karakter khusus berikut: |
EngineVersion | String | Tidak | Tidak | Nomor versi database. | Nilai yang valid:
|
StorageEngine | String | Tidak | Tidak | Mesin penyimpanan. | Untuk informasi selengkapnya tentang mesin penyimpanan dan versi, lihat Versi dan mesin penyimpanan. Nilai yang valid:
|
ReplicationFactor | Integer | Tidak | Ya | Jumlah node dalam set replika. | Nilai yang valid:
|
DatabaseNames | String | Tidak | Tidak | Nama database. | Tidak ada |
ReadonlyReplicas | Integer | Tidak | Ya | Jumlah node baca-saja. | Nilai yang valid: 1 hingga 5. |
BusinessInfo | String | Tidak | Tidak | Informasi bisnis. | Ini adalah parameter tambahan. |
ResourceGroupId | String | Tidak | Ya | ID grup sumber daya. | Tidak ada |
AutoRenew | Boolean | Tidak | Tidak | Menentukan apakah akan mengaktifkan perpanjangan otomatis untuk instance. | Nilai yang valid:
|
RestoreTime | String | Tidak | Tidak | Titik waktu yang ingin Anda pulihkan saat mengkloning instans. | Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Parameter ini ditentukan hanya saat Anda mengkloning instans. Parameter ini harus ditentukan bersama dengan parameter SrcDBInstanceId dan BackupId. Anda dapat menentukan titik waktu dalam tujuh hari terakhir. |
CouponNo | String | Tidak | Tidak | Kode kupon. | Nilai default adalah youhuiquan_promotion_option_id_for_blank. |
Period | Integer | Tidak | Ya | Durasi langganan instance. | Satuan: bulan. Nilai yang valid: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, dan 36. Nilai default adalah 1. Parameter ini hanya berlaku ketika ChargeType diatur ke PrePaid. |
ChargeType | String | Tidak | Ya | Metode penagihan instance. | Nilai yang valid:
|
Tags | List | Tidak | Ya | Tag. | Anda dapat menambahkan hingga 20 tag. Untuk informasi selengkapnya, lihat bagian properti Tags. |
SecondaryZoneId | String | Tidak | Tidak | Zona tempat node secondary ditempatkan. | Nilai yang valid:
Catatan
|
HiddenZoneId | String | Tidak | Tidak | Zona tempat node tersembunyi ditempatkan. | Nilai yang valid:
Catatan
|
StorageType | String | Tidak | Tidak | Kelas penyimpanan. | Nilai yang valid:
|
PrivateConnections | Map | Tidak | Ya | Konfigurasi koneksi privat. | Untuk informasi selengkapnya, lihat bagian properti PrivateConnections. |
Sintaksis Tags
"Tags": [
{
"Key": String,
"Value": String
}
] Properti Tags
Nama Properti | Tipe | Diperlukan | Pembaruan diizinkan | Deskripsi | Batasan |
Key | String | Ya | Tidak | Kunci tag. | Kunci harus terdiri dari 1 hingga 128 karakter. Kunci tidak boleh dimulai dengan |
Value | String | Tidak | Tidak | Nilai tag. | Nilai harus terdiri dari 0 hingga 128 karakter. Nilai tidak boleh dimulai dengan |
Sintaksis PrivateConnections
"PrivateConnections":
{
"ReplicaConnections": List
} Properti PrivateConnections
Nama Properti | Tipe | Diperlukan | Pembaruan diizinkan | Deskripsi | Batasan |
ReplicaConnections | List | Ya | Ya | Informasi koneksi node replika. | Panjang harus antara 1 hingga 6. Catatan Anda hanya dapat membuat atau mengubah informasi koneksi node dalam urutan yang sama seperti informasi koneksi yang diambil dengan memanggil operasi DescribeDBInstanceAttribute. Untuk informasi selengkapnya, lihat bagian properti ReplicaConnections. |
Sintaksis AuditPolicyOptions
"AuditPolicyOptions":
{
"StoragePeriod": Integer,
"AuditStatus": String,
"AuditLogSwitchSource": String,
"ServiceType": String
} Properti AuditPolicyOptions
Nama Properti | Tipe | Wajib | Pembaruan diizinkan | Deskripsi | Batasan |
AuditStatus | String | Ya | Ya | Status log audit. | Nilai valid:
|
StoragePeriod | Integer | Tidak | Ya | Periode retensi log audit. | Nilai valid: 1 hingga 365. Nilai default adalah 30. Unit: hari. |
AuditLogSwitchSource | String | Tidak | Ya | Sumber permintaan log audit. | Nilainya adalah Console. |
ServiceType | String | Tidak | Ya | Versi log audit. | Nilai valid:
Catatan Nilai default adalah Trial. Mulai 6 Januari 2022, edisi resmi fitur log audit diluncurkan secara bertahap di berbagai wilayah, dan Anda tidak dapat lagi mengajukan edisi uji coba gratis. Kami menyarankan agar Anda mengatur parameter ini ke Standard. |
Sintaksis SSLOptions
"SSLOptions":
{
"ForceEncryption": Integer,
"SwitchMode": Integer,
"SSLAction": String
} Properti SSLOptions
Nama Properti | Type | Wajib | Pembaruan diizinkan | Deskripsi | Batasan |
SSLAction | String | Ya | Ya | Operasi yang akan dilakukan pada fitur SSL. | Nilai valid:
|
ForceEncryption | Integer | Tidak | Ya | Menentukan apakah akan memaksa mengaktifkan enkripsi SSL untuk koneksi. | Nilai valid:
|
SwitchMode | Integer | Tidak | Ya | Waktu untuk mengubah konfigurasi SSL instans MongoDB. | Nilai valid:
|
Sintaksis BackupPolicyOptions
"SSLOptions":
{
"CrossBackupType": String,
"BackupInterval": Integer,
"BackupRetentionPolicyOnClusterDeletion": Integer,
"HighFrequencyBackupRetention": Integer,
"BackupRetentionPeriod": Integer,
"InstanceType": String,
"LogBackupRetentionPeriod": Integer,
"CrossRetentionValue": Integer,
"CrossBackupPeriod": String,
"PreferredBackupTime": String,
"DestRegion": String,
"CrossRetentionType": String,
"EnableCrossLogBackup": Integer,
"PreferredBackupPeriod": String,
"PreserveOneEachHour": Boolean,
"SnapshotBackupType": String,
"CrossLogRetentionType": String,
"CrossLogRetentionValue": Integer,
"EnableBackupLog": Integer,
"SrcRegion": String
} Properti BackupPolicyOptions
Nama Properti | Tipe | Wajib | Pembaruan diizinkan | Deskripsi | Batasan |
CrossBackupType | String | Tidak | Ya | Kebijakan geo-redundansi. | Nilai valid:
|
BackupInterval | Integer | Tidak | Ya | Frekuensi cadangan frekuensi tinggi. | Nilai valid:
|
BackupRetentionPolicyOnClusterDeletion | Integer | Tidak | Ya | Kebijakan retensi cadangan. | Nilai valid:
Untuk informasi selengkapnya, lihat Cadangan retensi jangka panjang. |
HighFrequencyBackupRetention | Integer | Tidak | Ya | Periode retensi cadangan frekuensi tinggi. | Sebelum menggunakan parameter ini, pastikan parameter BackupInterval telah ditentukan. Periode retensi default adalah satu hari. Unit: hari. |
BackupRetentionPeriod | Integer | Tidak | Ya | Periode retensi cadangan penuh. | Catatan
|
InstanceType | String | Tidak | Ya | Tipe instans. | Nilai valid:
Catatan
|
LogBackupRetentionPeriod | Integer | Tidak | Ya | Periode retensi cadangan log. | Nilai default adalah 7. Nilai valid: 7 hingga 730. Unit: hari. |
CrossRetentionValue | Integer | Tidak | Ya | Periode retensi cadangan geo-redundan. | Nilai valid: 3 hingga 1825. Unit: hari. Catatan
|
CrossBackupPeriod | String | Tidak | Ya | Periode retensi geo-redundansi | Nilai valid:
Catatan Parameter ini wajib ditentukan untuk cadangan geo-redundan.
|
PreferredBackupTime | String | Tidak | Ya | Waktu untuk melakukan pencadangan. | Tentukan waktu dalam format HH:mmZ-HH:mmZ. Waktu harus dalam UTC. Catatan Rentang waktu harus 1 jam. |
DestRegion | String | Tidak | Ya | Wilayah tempat cadangan disimpan. | Catatan Parameter ini wajib ditentukan untuk cadangan geo-redundan. |
CrossRetentionType | String | Tidak | Ya | Kebijakan retensi untuk cadangan geo-redundan. | Catatan
|
EnableCrossLogBackup | Integer | Tidak | Ya | Menentukan apakah akan mengaktifkan pencadangan log cross-region. | Catatan Parameter ini wajib ditentukan untuk cadangan geo-redundan.
|
PreferredBackupPeriod | String | Tidak | Ya | Siklus pencadangan. | Nilai valid:
Catatan Pisahkan beberapa nilai dengan koma (,). |
PreserveOneEachHour | Boolean | Tidak | Ya | Menentukan apakah akan mengaktifkan cadangan jarang per jam. | Nilai valid:
|
SnapshotBackupType | String | Tidak | Ya | Tipe cadangan snapshot. | Nilai valid:
|
CrossLogRetentionType | String | Tidak | Ya | Kebijakan retensi untuk pencadangan log lintas wilayah. | Nilai valid:
|
CrossLogRetentionValue | Integer | Tidak | Ya | Periode retensi pencadangan log lintas wilayah. | Nilai valid: 3 hingga 1825. Nilainya harus kurang dari atau sama dengan nilai CrossRetentionValue. Unit: hari. |
EnableBackupLog | Integer | Tidak | Ya | Menentukan apakah akan mengaktifkan pencadangan log. | Nilai valid:
|
SrcRegion | String | Tidak | Ya | Wilayah instance. | Catatan
|
Sintaksis ReplicaConnections
{
"PrivateConnections": {
"ReplicaConnections": [
{
"ConnectionString": String,
"ConnectionPort": Integer
}
]
}
}Properti ReplicaConnections
Nama Properti | Tipe | Diperlukan | Pembaruan diizinkan | Deskripsi | Batasan |
ConnectionString | String | Ya | Ya | Awalan alamat koneksi | Prefiks harus dimulai dengan huruf kecil dan diakhiri dengan huruf kecil atau digit. Harus terdiri dari huruf kecil, digit, dan tanda hubung (-). Panjangnya harus 8 hingga 63 karakter. Catatan Tentukan hanya awalan titik akhir. Sisa titik akhir tidak dapat diubah. Anda dapat mengubah titik akhir node primary, secondary, dan read-only untuk instans yang menggunakan SSD lokal atau ESSD. |
ConnectionPort | Integer | Tidak | Ya | Port koneksi. | Nilai valid: 1000 hingga 65535. Catatan Anda hanya dapat mengubah port untuk instans yang menjalankan MongoDB 4.2 atau versi yang lebih baru dan menggunakan ESSD. |
Nilai Pengembalian
Fn::GetAtt
OrderId: ID pesanan yang digunakan untuk membuat instans MongoDB.
DBInstanceId: ID instans MongoDB yang bersifat unik secara global.
DBInstanceStatus: Status instans MongoDB.
ConnectionURI: URI koneksi.
ReplicaSetName: Nama set replika.
Arn: Nama Sumber Daya Alibaba Cloud (ARN) dari instans.
Contoh
ROSTemplateFormatVersion: '2015-09-01'
Description: Test MONGODB Instance
Parameters:
VpcId:
Type: String
AssociationProperty: ALIYUN::ECS::VPC::VPCId
ZoneId:
Type: String
AssociationProperty: ALIYUN::ECS::ZoneId
VSwitchId:
Type: String
AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
AssociationPropertyMetadata:
ZoneId: ${ZoneId}
VpcId: ${VpcId}
Resources:
MongoDB:
Type: ALIYUN::MONGODB::Instance
Properties:
DBInstanceClass: dds.mongo.mid
DBInstanceStorage: 10
ZoneId:
Ref: ZoneId
VpcId:
Ref: VpcId
VSwitchId:
Ref: VSwitchId
Outputs: {}{
"ROSTemplateFormatVersion": "2015-09-01",
"Description": "Test MONGODB Instance",
"Parameters": {
"VpcId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
},
"ZoneId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::ZoneId"
},
"VSwitchId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
"AssociationPropertyMetadata": {
"ZoneId": "${ZoneId}",
"VpcId": "${VpcId}"
}
}
},
"Resources": {
"MongoDB": {
"Type": "ALIYUN::MONGODB::Instance",
"Properties": {
"DBInstanceClass": "dds.mongo.mid",
"DBInstanceStorage": 10,
"ZoneId": {
"Ref": "ZoneId"
},
"VpcId": {
"Ref": "VpcId"
},
"VSwitchId": {
"Ref": "VSwitchId"
}
}
}
},
"Outputs": {
}
} Untuk informasi selengkapnya, lihat contoh YAML.