ALIYUN::MONGODB::ShardingInstance類型用于創(chuàng)建或者克隆MongoDB分片集群實(shí)例。
語法
{
"Type": "ALIYUN::MONGODB::ShardingInstance",
"Properties": {
"EngineVersion": String,
"ZoneId": String,
"AutoRenew": Boolean,
"VSwitchId": String,
"Period": Integer,
"SecurityIPArray": String,
"Mongos": List,
"StorageEngine": String,
"RestoreTime": String,
"AccountPassword": String,
"VpcId": String,
"ProtocolType": String,
"ChargeType": String,
"NetworkType": String,
"ConfigServer": List,
"SrcDBInstanceId": String,
"ReplicaSet": List,
"Tags": List,
"TDEStatus": Boolean,
"DBInstanceDescription": String,
"ResourceGroupId": String,
"SecondaryZoneId": String,
"HiddenZoneId": String,
"StorageType": String
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
---|---|---|---|---|---|
EngineVersion | String | 否 | 否 | 數(shù)據(jù)庫版本號(hào)。 | 取值:
說明 克隆實(shí)例時(shí),該值必須與源實(shí)例保持一致。 |
ZoneId | String | 否 | 否 | 可用區(qū)ID。 | 無 |
AutoRenew | Boolean | 否 | 否 | 設(shè)置實(shí)例是否自動(dòng)續(xù)費(fèi)。 | 取值:
說明 當(dāng)ChargeType參數(shù)值為PrePaid時(shí),該參數(shù)有效。 |
VSwitchId | String | 否 | 否 | 交換機(jī)ID。 | NetworkType參數(shù)取值為VPC時(shí),該參數(shù)有效。 |
Period | Integer | 否 | 否 | 實(shí)例的購買時(shí)長(zhǎng)。 | 取值:1~9、12、24、36。 單位:月。 說明 當(dāng)ChargeType參數(shù)值為PrePaid時(shí),該參數(shù)可用且必須指定。 |
SecurityIPArray | String | 否 | 否 | 實(shí)例的IP白名單。 | 以半角逗號(hào)(,)隔開,不可重復(fù),最多支持1000個(gè)IP。 支持格式:
說明 %和0.0.0.0/0表示任何IP地址都可以訪問實(shí)例的數(shù)據(jù)庫,屬于高危設(shè)置,請(qǐng)謹(jǐn)慎操作。 |
Mongos | List | 是 | 否 | Mongos節(jié)點(diǎn)。 | 節(jié)點(diǎn)數(shù)量:2~32。 更多信息,請(qǐng)參見Mongos屬性。 |
StorageEngine | String | 否 | 否 | 實(shí)例使用的存儲(chǔ)引擎。 | 取值:
說明 克隆實(shí)例時(shí),該值必須與源實(shí)例保持一致。 |
RestoreTime | String | 否 | 否 | 克隆實(shí)例時(shí)所恢復(fù)的時(shí)間點(diǎn)。 | 格式為yyyy-MM-ddTHH:mm:ssZ(UTC時(shí)間)。只有克隆實(shí)例時(shí)才能指定該參數(shù),且必須和SrcDBInstanceId參數(shù)同時(shí)指定。 說明 支持選擇7天內(nèi)的任一時(shí)間點(diǎn)進(jìn)行克隆。 |
AccountPassword | String | 否 | 是 | Root賬號(hào)的密碼。 | 長(zhǎng)度為8~32個(gè)字符,必須包含大寫英文字母、小寫英文字母、數(shù)字和特殊字符中至少三種,支持的特殊字符為:!#$%^&*()_+-= 。 |
VpcId | String | 否 | 否 | 專有網(wǎng)絡(luò)ID。 | 當(dāng)NetworkType參數(shù)取值為VPC時(shí),該參數(shù)可用。 |
ProtocolType | String | 否 | 否 | 訪問協(xié)議的類型。 | 取值:
|
ChargeType | String | 否 | 否 | 實(shí)例的付費(fèi)類型。 | 取值:
|
NetworkType | String | 否 | 否 | 實(shí)例的網(wǎng)絡(luò)類型。 | 取值:
|
ConfigServer | List | 是 | 否 | ConfigServer規(guī)格配置。 | 更多信息,請(qǐng)參見ConfigServer屬性。 |
SrcDBInstanceId | String | 否 | 否 | 源實(shí)例ID。 | 只有克隆實(shí)例時(shí)才能指定該參數(shù),且必須和RestoreTime同時(shí)指定。 |
ReplicaSet | List | 是 | 否 | Shard節(jié)點(diǎn)。 | 節(jié)點(diǎn)數(shù)量:2~32。 更多信息,請(qǐng)參見ReplicaSet屬性。 |
Tags | List | 否 | 是 | 標(biāo)簽。 | 最多支持添加20個(gè)標(biāo)簽。 更多信息,請(qǐng)參見Tags屬性。 |
TDEStatus | Boolean | 否 | 是 | 是否啟用透明數(shù)據(jù)加密(TDE)。 | 取值:
|
ResourceGroupId | String | 否 | 是 | 實(shí)例所屬的資源組ID。 | 無 |
DBInstanceDescription | String | 否 | 否 | 實(shí)例名稱。 | 長(zhǎng)度為2~256個(gè)字符。以英文字母或漢字開頭,可包含英文字母、漢字、數(shù)字、下劃線(_)和短劃線(-)。 |
SecondaryZoneId | String | 否 | 否 | 配置從節(jié)點(diǎn)(Secondary節(jié)點(diǎn))所在的可用區(qū)。 | 取值:
說明
|
HiddenZoneId | String | 否 | 否 | 配置隱藏節(jié)點(diǎn)(Hidden節(jié)點(diǎn))所在的可用區(qū)。 | 取值:
說明
|
StorageType | String | 否 | 否 | 存儲(chǔ)類型。 | 取值:
|
Mongos語法
"Mongos": [
{
"Class": String
}
]
Mongos屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
---|---|---|---|---|---|
Class | String | 是 | 否 | Mongos節(jié)點(diǎn)的規(guī)格。 | 關(guān)于取值的更多信息,請(qǐng)參見 實(shí)例規(guī)格概述 。 |
ConfigServer語法
"ConfigServer": [
{
"Storage": Integer,
"Class": String
}
]
ConfigServer屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
---|---|---|---|---|---|
Storage | Integer | 是 | 否 | ConfigServer的存儲(chǔ)空間。 | 取值:20。 單位:GB。 說明 存儲(chǔ)空間取值固定為20 GB。 |
Class | String | 是 | 否 | ConfigServer的規(guī)格。 | 取值:dds.cs.mid。 說明 規(guī)格固定為1核2 GB,數(shù)量固定為1個(gè)。 |
ReplicaSet語法
"ReplicaSet": [
{
"Storage": Integer,
"Class": String,
"ReadonlyReplicas": Integer
}
]
ReplicaSet屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
---|---|---|---|---|---|
Storage | Integer | 是 | 否 | Shard節(jié)點(diǎn)的存儲(chǔ)空間。 | 取值范圍:10~2000。 單位:GB。 每10 GB遞增。 |
Class | String | 是 | 否 | Shard節(jié)點(diǎn)的規(guī)格。 | 關(guān)于取值的更多信息,請(qǐng)參見 實(shí)例規(guī)格概述 。 |
ReadonlyReplicas | Integer | 否 | 否 | 創(chuàng)建只讀節(jié)點(diǎn)的個(gè)數(shù)。 | 取值范圍:1~5。 |
Tags語法
"Tags": [
{
"Key": String,
"Value": String
}
]
Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
---|---|---|---|---|---|
Key | String | 是 | 否 | 標(biāo)簽鍵。 | 長(zhǎng)度為1~128個(gè)字符,不能以aliyun 和acs: 開頭,不能包含http:// 或https:// 。 |
Value | String | 否 | 否 | 標(biāo)簽值。 | 長(zhǎng)度為0~128個(gè)字符,不能以aliyun 和acs: 開頭,不能包含http:// 或https:// 。 |
返回值
Fn::GetAtt
- DBInstanceStatus:實(shí)例狀態(tài)。
- DBInstanceId:實(shí)例ID。
- OrderId:訂單ID。
示例
JSON
格式{ "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ZoneId": { "Type": "String", "AssociationProperty": "ALIYUN::ECS::ZoneId" } }, "Resources": { "MongoDbShardingInstance": { "Type": "ALIYUN::MONGODB::ShardingInstance", "Properties": { "ZoneId": { "Ref": "ZoneId" }, "EngineVersion": "4.0", "Mongos": [ { "Class": "dds.mongos.mid" }, { "Class": "dds.mongos.mid" } ], "ReplicaSet": [ { "Class": "dds.shard.mid", "Storage": 10 }, { "Class": "dds.shard.mid", "Storage": 20 } ], "ConfigServer": [ { "Class": "dds.cs.mid", "Storage": 20 } ], "TDEStatus": false } } }, "Outputs": { "DBInstanceStatus": { "Description": "Status of mongodb instance.", "Value": { "Fn::GetAtt": [ "MongoDbShardingInstance", "DBInstanceStatus" ] } }, "DBInstanceId": { "Description": "The instance id of created mongodb instance.", "Value": { "Fn::GetAtt": [ "MongoDbShardingInstance", "DBInstanceId" ] } }, "OrderId": { "Description": "Order Id of created instance.", "Value": { "Fn::GetAtt": [ "MongoDbShardingInstance", "OrderId" ] } } } }