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