ALIYUN::MONGODB::ServerlessInstance digunakan untuk membuat instance ApsaraDB for MongoDB (Serverless).
Sintaksis
{
"Type": "ALIYUN::MONGODB::ServerlessInstance",
"Properties": {
"EngineVersion": String,
"ZoneId": String,
"ResourceGroupId": String,
"AutoRenew": Boolean,
"VSwitchId": String,
"PeriodPriceType": String,
"Period": Integer,
"SecurityIPArray": String,
"StorageEngine": String,
"AccountPassword": String,
"VpcId": String,
"ChargeType": String,
"NetworkType": String,
"DBInstanceStorage": Integer,
"DBInstanceDescription": String,
"TDEStatus": Boolean
"Tags": List
}
}Properti
| Properti | Tipe | Diperlukan | Dapat Diedit | Deskripsi | Batasan |
| EngineVersion | String | Tidak | Tidak | Versi mesin dari instance. | Atur nilainya menjadi 4.2. |
| ZoneId | String | Tidak | Tidak | ID zona. | Tidak ada |
| ResourceGroupId | String | Tidak | Ya | ID grup sumber daya. | Tidak ada |
| AutoRenew | Boolean | Tidak | Tidak | Menentukan apakah akan mengaktifkan perpanjangan otomatis untuk instance. | Nilai default: false. Nilai valid:
|
| VSwitchId | String | Tidak | Tidak | ID vSwitch. | Tidak ada |
| PeriodPriceType | String | Tidak | Tidak | Unit siklus penagihan. | Nilai valid:
|
| Period | Integer | Tidak | Tidak | Durasi langganan instance. |
Unit: bulan. |
| SecurityIPArray | String | Tidak | Tidak | Alamat IP dalam daftar putih instance. | Pisahkan beberapa alamat IP dengan koma (,). Setiap alamat IP harus unik dalam daftar putih. Daftar putih dapat berisi hingga 1.000 alamat IP. Anda dapat memasukkan alamat IP seperti 10.23.XX.XX dan blok CIDR seperti 10.23.XX.XX/24. /24 menunjukkan bahwa prefiks blok CIDR adalah 24 bit panjangnya. Anda dapat mengganti 24 dengan nilai yang berkisar antara 1 hingga 32. Anda juga dapat memasukkan tanda persen (%) atau 0.0.0.0/0. Catatan Jika Anda memasukkan tanda persen (%) atau 0.0.0.0/0, semua alamat IP dapat mengakses instance. Ini mungkin menyebabkan risiko keamanan pada instance. Lanjutkan dengan hati-hati. |
| StorageEngine | String | Tidak | Tidak | Mesin penyimpanan yang digunakan oleh instance. | Atur nilainya menjadi WiredTiger. Untuk informasi lebih lanjut tentang mesin penyimpanan dan versi MongoDB, lihat Versi MongoDB dan mesin penyimpanan. |
| AccountPassword | String | Tidak | Ya | Kata sandi yang digunakan untuk terhubung ke database. | Kata sandi harus memiliki panjang 8 hingga 32 karakter. Kata sandi harus berisi setidaknya tiga dari jenis karakter berikut: huruf besar, huruf kecil, angka, dan karakter khusus. Karakter khusus termasuk Catatan Instance ApsaraDB for MongoDB (Serverless) menyediakan akun logon database default. Anda tidak dapat mengubah akun tersebut tetapi Anda dapat mengubah kata sandinya. |
| VpcId | String | Tidak | Tidak | ID virtual private cloud (VPC). | Tidak ada |
| ChargeType | String | Tidak | Tidak | Metode penagihan instance. | Atur nilainya menjadi PrePaid. |
| NetworkType | String | Tidak | Tidak | Jenis jaringan instance. Jenis jaringan instance ApsaraDB for MongoDB (Serverless) harus VPC. | Atur nilainya menjadi VPC. |
| DBInstanceStorage | Integer | Ya | Tidak | Kapasitas penyimpanan instance. | Nilai valid: 1 hingga 10. Unit: GB. |
| DBInstanceDescription | String | Tidak | Tidak | Deskripsi instance. | Deskripsi harus memiliki panjang 2 hingga 256 karakter dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Deskripsi harus dimulai dengan huruf. |
| TDEStatus | Boolean | Tidak | Ya | Menentukan apakah akan mengaktifkan Transparent Data Encryption (TDE). | Nilai default: false. Nilai valid:
|
| Tags | List | Tidak | Ya | Tag instance. | Anda dapat menambahkan hingga 20 tag. Untuk informasi lebih lanjut, lihat Properti tag. |
Sintaksis tag
"Tags": [
{
"Key": String,
"Value": String
}
] Properti tag
| Properti | Tipe | Diperlukan | Dapat Diedit | Deskripsi | Batasan |
| Key | String | Ya | Tidak | Kunci tag. | Kunci tag harus memiliki panjang 1 hingga 128 karakter dan tidak boleh berisi http:// atau https://. Kunci tag tidak boleh dimulai dengan acs: atau aliyun. |
| Value | String | Tidak | Tidak | Nilai tag. | Nilai tag harus memiliki panjang 0 hingga 128 karakter dan tidak boleh berisi http:// atau https://. Nilai tag tidak boleh dimulai dengan acs: atau aliyun. |
Nilai pengembalian
Fn::GetAtt
- DBInstanceStatus: Status instance.
- DBInstanceId: ID instance.
- ConnectionURI: String koneksi instance.
- OrderId: ID pesanan.
Contoh
Format JSON
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"TDEStatus": {
"Type": "Boolean",
"Description": "Menentukan apakah akan mengaktifkan Transparent Data Encryption (TDE). Nilai valid:\ntrue: aktifkan TDE\nfalse: nonaktifkan TDE (default)\nCatatan: Anda tidak dapat menonaktifkan TDE setelah diaktifkan. ",
"AllowedValues": [
"True",
"true",
"False",
"false"
]
},
"EngineVersion": {
"Type": "String",
"Description": "Versi instance database.Dukungan 4.2",
"Default": "4.2"
},
"ZoneId": {
"Type": "String",
"Description": "Di zona mana instance akan dibuat. Jika VpcId dan VSwitchId ditentukan, ZoneId diperlukan dan VSwitch harus berada di zona yang sama."
},
"ResourceGroupId": {
"Type": "String",
"Description": "ID grup sumber daya."
},
"VSwitchId": {
"Type": "String",
"Description": "ID vSwitch untuk membuat instance mongodb."
},
"AutoRenew": {
"Type": "Boolean",
"Description": "Menunjukkan apakah perpanjangan otomatis diaktifkan untuk instance. Nilai valid:true: Perpanjangan otomatis diaktifkan.false: Perpanjangan otomatis tidak diaktifkan. Anda harus memperbarui instance secara manual.Nilai default: false.",
"AllowedValues": [
"True",
"true",
"False",
"false"
]
},
"Period": {
"Type": "Number",
"Description": "Periode langganan instance.Unit Default: Bulan.Nilai valid: [1~9], 12, 24, 36. Default ke 1.",
"AllowedValues": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
12,
24,
36
],
"Default": 1
},
"SecurityIPArray": {
"Type": "String",
"Description": "IP keamanan untuk ditambahkan atau dihapus."
},
"StorageEngine": {
"Type": "String",
"Description": "Database storage engine.Dukungan WiredTiger",
"AllowedValues": [
"WiredTiger"
],
"Default": "WiredTiger"
},
"AccountPassword": {
"Type": "String",
"Description": "Kata sandi akun root, dapat berisi huruf, angka atau garis bawah komposisi, panjang 6~32 bit."
},
"VpcId": {
"Type": "String",
"Description": "ID VPC untuk membuat instance mongodb."
},
"ChargeType": {
"Type": "String",
"Description": "Metode penagihan instance.nilai:PostPaid: Bayar-Sesuai-Penggunaan.PrePaid: Langganan.Nilai default: PostPaid",
"AllowedValues": [
"Subscription",
"PrePaid",
"PrePay",
"Prepaid",
"PayAsYouGo",
"PostPaid",
"PayOnDemand",
"Postpaid"
],
"Default": "PostPaid"
},
"NetworkType": {
"Type": "String",
"Description": "Jenis jaringan instance. Dukungan 'CLASSIC' dan 'VPC' saja, default adalah 'CLASSIC'.",
"AllowedValues": [
"CLASSIC",
"VPC"
]
},
"DBInstanceStorage": {
"Type": "Number",
"Description": "Ukuran penyimpanan instance database. MongoDB adalah [1,10], bertambah setiap 1 GB, Unit dalam GB"
},
"PeriodPriceType": {
"Type": "String",
"Description": "Periode penagihan untuk instance yang dibuat.",
"AllowedValues": [
"Day",
"Month"
]
},
"DBInstanceDescription": {
"Type": "String",
"Description": "Deskripsi instance database yang dibuat."
},
"Tags": {
"Type": "Json",
"Description": "Tag untuk melampirkan ke instance. Maksimal mendukung 20 tag untuk ditambahkan selama pembuatan instance. Setiap tag dengan dua properti Key dan Value, dan Key diperlukan.",
"MaxLength": 20
}
},
"Resources": {
"MongoDbServerlessInstance": {
"Type": "ALIYUN::MONGODB::ServerlessInstance",
"Properties": {
"TDEStatus": {
"Ref": "TDEStatus"
},
"EngineVersion": {
"Ref": "EngineVersion"
},
"ZoneId": {
"Ref": "ZoneId"
},
"ResourceGroupId": {
"Ref": "ResourceGroupId"
},
"VSwitchId": {
"Ref": "VSwitchId"
},
"AutoRenew": {
"Ref": "AutoRenew"
},
"Period": {
"Ref": "Period"
},
"SecurityIPArray": {
"Ref": "SecurityIPArray"
},
"StorageEngine": {
"Ref": "StorageEngine"
},
"AccountPassword": {
"Ref": "AccountPassword"
},
"VpcId": {
"Ref": "VpcId"
},
"ChargeType": {
"Ref": "ChargeType"
},
"NetworkType": {
"Ref": "NetworkType"
},
"DBInstanceStorage": {
"Ref": "DBInstanceStorage"
},
"PeriodPriceType": {
"Ref": "PeriodPriceType"
},
"DBInstanceDescription": {
"Ref": "DBInstanceDescription"
},
"Tags": {
"Ref": "Tags"
}
}
}
},
"Outputs": {
"DBInstanceStatus": {
"Description": "Status instance mongodb.",
"Value": {
"Fn::GetAtt": [
"MongoDbServerlessInstance",
"DBInstanceStatus"
]
}
},
"DBInstanceId": {
"Description": "ID instance dari instance mongodb yang dibuat.",
"Value": {
"Fn::GetAtt": [
"MongoDbServerlessInstance",
"DBInstanceId"
]
}
},
"ConnectionURI": {
"Description": "String koneksi.",
"Value": {
"Fn::GetAtt": [
"MongoDbServerlessInstance",
"ConnectionURI"
]
}
},
"OrderId": {
"Description": "ID Pesanan instance yang dibuat.",
"Value": {
"Fn::GetAtt": [
"MongoDbServerlessInstance",
"OrderId"
]
}
}
}
}Format YAML
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
AccountPassword:
Description: Kata sandi akun root, dapat berisi huruf, angka atau garis bawah
komposisi, panjang 6~32 bit.
Type: String
AutoRenew:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Description: 'Menunjukkan apakah perpanjangan otomatis diaktifkan untuk instance.
Nilai valid:true: Perpanjangan otomatis diaktifkan.false: Perpanjangan otomatis tidak
diaktifkan. Anda harus memperbarui instance secara manual.Nilai default: false.'
Type: Boolean
ChargeType:
AllowedValues:
- Subscription
- PrePaid
- PrePay
- Prepaid
- PayAsYouGo
- PostPaid
- PayOnDemand
- Postpaid
Default: PostPaid
Description: 'Metode penagihan instance.nilai:PostPaid: Bayar-Sesuai-Penggunaan.PrePaid:
Langganan.Nilai default: PostPaid'
Type: String
DBInstanceDescription:
Description: Deskripsi instance database yang dibuat.
Type: String
DBInstanceStorage:
Description: Ukuran penyimpanan instance database. MongoDB adalah [1,10], bertambah setiap
1 GB, Unit dalam GB
Type: Number
EngineVersion:
Default: '4.2'
Description: Versi instance database.Dukungan 4.2
Type: String
NetworkType:
AllowedValues:
- CLASSIC
- VPC
Description: Jenis jaringan instance. Dukungan 'CLASSIC' dan 'VPC' saja, default
adalah 'CLASSIC'.
Type: String
Period:
AllowedValues:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 12
- 24
- 36
Default: 1
Description: 'Periode langganan instance.Unit Default: Bulan.Nilai valid: [1~9],
12, 24, 36. Default ke 1.'
Type: Number
PeriodPriceType:
AllowedValues:
- Day
- Month
Description: Periode penagihan untuk instance yang dibuat.
Type: String
ResourceGroupId:
Description: ID grup sumber daya.
Type: String
SecurityIPArray:
Description: IP keamanan untuk ditambahkan atau dihapus.
Type: String
StorageEngine:
AllowedValues:
- WiredTiger
Default: WiredTiger
Description: Database storage engine.Dukungan WiredTiger
Type: String
TDEStatus:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Description: 'Menentukan apakah akan mengaktifkan Transparent Data Encryption (TDE). Nilai
valid:
true: aktifkan TDE
false: nonaktifkan TDE (default)
Catatan: Anda tidak dapat menonaktifkan TDE setelah diaktifkan. '
Type: Boolean
Tags:
Description: Tag untuk melampirkan ke instance. Maksimal mendukung 20 tag untuk ditambahkan
selama pembuatan instance. Setiap tag dengan dua properti Key dan Value, dan Key
diperlukan.
MaxLength: 20
Type: Json
VSwitchId:
Description: ID vSwitch untuk membuat instance mongodb.
Type: String
VpcId:
Description: ID VPC untuk membuat instance mongodb.
Type: String
ZoneId:
Description: Di zona mana instance akan dibuat. Jika VpcId dan VSwitchId ditentukan,
ZoneId diperlukan dan VSwitch harus berada di zona yang sama.
Type: String
Resources:
MongoDbServerlessInstance:
Properties:
AccountPassword:
Ref: AccountPassword
AutoRenew:
Ref: AutoRenew
ChargeType:
Ref: ChargeType
DBInstanceDescription:
Ref: DBInstanceDescription
DBInstanceStorage:
Ref: DBInstanceStorage
EngineVersion:
Ref: EngineVersion
NetworkType:
Ref: NetworkType
Period:
Ref: Period
PeriodPriceType:
Ref: PeriodPriceType
ResourceGroupId:
Ref: ResourceGroupId
SecurityIPArray:
Ref: SecurityIPArray
StorageEngine:
Ref: StorageEngine
TDEStatus:
Ref: TDEStatus
Tags:
Ref: Tags
VSwitchId:
Ref: VSwitchId
VpcId:
Ref: VpcId
ZoneId:
Ref: ZoneId
Type: ALIYUN::MONGODB::ServerlessInstance
Outputs:
ConnectionURI:
Description: String koneksi.
Value:
Fn::GetAtt:
- MongoDbServer - ServerlessInstance
- ConnectionURI
DBInstanceId:
Description: ID instance dari instance mongodb yang dibuat.
Value:
Fn::GetAtt:
- MongoDbServerlessInstance
- DBInstanceId
DBInstanceStatus:
Description: Status instance mongodb.
Value:
Fn::GetAtt:
- MongoDbServerlessInstance
- DBInstanceStatus
OrderId:
Description: ID Pesanan instance yang dibuat.
Value:
Fn::GetAtt:
- MongoDbServerlessInstance
- OrderId
Untuk melihat lebih banyak contoh, kunjungi ServerlessInstance.json dan ServerlessInstance.yml.