ALIYUN::MONGODB::Instance
ALIYUN::MONGODB::Instance類型用于創(chuàng)建或克隆MongoDB副本集實(shí)例。
語(yǔ)法
{
"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,
"NetworkType": String,
"Tags": List,
"SecondaryZoneId": String,
"HiddenZoneId": String,
"StorageType": String
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
VpcPasswordFree | Boolean | 否 | 否 | 在VPC網(wǎng)絡(luò)中訪問(wèn)創(chuàng)建或克隆的實(shí)例時(shí),是否啟用免密碼。 | 取值:
|
DBInstanceStorage | Integer | 是 | 是 | 數(shù)據(jù)庫(kù)實(shí)例的存儲(chǔ)空間。 | 取值范圍:10~3000,必須是10的倍數(shù)。 單位:GB。 |
DBInstanceClass | String | 是 | 是 | 實(shí)例規(guī)格。 | 更多信息,請(qǐng)參見(jiàn)實(shí)例規(guī)格概述。 |
TDEStatus | Boolean | 否 | 是 | 是否啟用透明數(shù)據(jù)加密(TDE)。 | 取值:
|
SrcDBInstanceId | String | 否 | 否 | 源實(shí)例ID。 | 只有克隆實(shí)例時(shí)才能指定該參數(shù),且必須和BackupId或RestoreTime參數(shù)一同指定。 |
DBInstanceDescription | String | 否 | 否 | 實(shí)例描述。 | 長(zhǎng)度為2~256個(gè)字符。以漢字或英文字母開(kāi)頭,可包含漢字、英文字母、數(shù)字、下劃線(_)和短劃線(-)。 |
SecurityIPArray | String | 否 | 否 | 所有可以訪問(wèn)創(chuàng)建或克隆實(shí)例的IP地址。 | IP地址以半角逗號(hào)(,)隔開(kāi),不可重復(fù),最多支持1000個(gè)。 支持格式:0.0.0.0/0、10.23.XX.XX(IP)或者10.23.XX.XX/24(CIDR模式,無(wú)類域間路由。/24表示地址中前綴的長(zhǎng)度,取值范圍:1~32)。 默認(rèn)值:0.0.0.0/0,表示不指定IP白名單,即所有IP均可訪問(wèn)。 |
ZoneId | String | 否 | 否 | 可用區(qū)ID。 | 更多信息,請(qǐng)參見(jiàn)DescribeRegions。在專有網(wǎng)絡(luò)下,該參數(shù)取值需與VSwitchId的可用區(qū)保持一致。 |
VpcId | String | 否 | 否 | 專有網(wǎng)絡(luò)ID。 | 當(dāng)NetworkType取值為VPC時(shí),該參數(shù)有效。 |
SecurityGroupId | String | 否 | 是 | 安全組ID。 | 無(wú) |
VSwitchId | String | 否 | 否 | 交換機(jī)ID。 | 當(dāng)NetworkType取值為VPC時(shí),該參數(shù)有效。 |
BackupId | String | 否 | 否 | 備份集ID。 | 只有克隆實(shí)例時(shí)才能指定該參數(shù),且必須和SrcDBInstanceId參數(shù)一同指定。 |
NetworkType | String | 否 | 否 | 網(wǎng)絡(luò)類型。 | 取值:
|
AccountPassword | String | 否 | 是 | Root賬號(hào)的密碼。 | 長(zhǎng)度為6~32個(gè)字符。可包含英文字母、數(shù)字和特殊字符 |
EngineVersion | String | 否 | 否 | 數(shù)據(jù)庫(kù)版本號(hào)。 | 取值:
|
StorageEngine | String | 否 | 否 | 存儲(chǔ)引擎。 | 關(guān)于存儲(chǔ)引擎與版本選擇的更多信息,請(qǐng)參見(jiàn)版本及存儲(chǔ)引擎。 取值:
|
ReplicationFactor | Integer | 否 | 是 | 副本集節(jié)點(diǎn)數(shù)。 | 取值:
|
DatabaseNames | String | 否 | 否 | 數(shù)據(jù)庫(kù)名稱。 | 無(wú) |
ReadonlyReplicas | Integer | 否 | 是 | 只讀節(jié)點(diǎn)的數(shù)量。 | 取值范圍:1~5。 |
BusinessInfo | String | 否 | 否 | 業(yè)務(wù)信息。 | 該參數(shù)為附加參數(shù)。 |
ResourceGroupId | String | 否 | 是 | 資源組ID。 | 無(wú) |
AutoRenew | Boolean | 否 | 否 | 是否為實(shí)例啟用自動(dòng)續(xù)費(fèi)。 | 取值:
|
RestoreTime | String | 否 | 否 | 克隆實(shí)例時(shí)恢復(fù)數(shù)據(jù)的時(shí)間點(diǎn)。 | 格式:yyyy-MM-ddTHH:mm:ssZ(UTC時(shí)間)。 只有克隆實(shí)例時(shí)才能指定該參數(shù),且必須和SrcDBInstanceId、BackupId參數(shù)一同指定。支持選擇7天內(nèi)的任一時(shí)間點(diǎn)進(jìn)行克隆。 |
CouponNo | String | 否 | 否 | 優(yōu)惠碼。 | 默認(rèn)值:youhuiquan_promotion_option_id_for_blank。 |
Period | Integer | 否 | 否 | 實(shí)例的購(gòu)買(mǎi)時(shí)長(zhǎng)。 | 單位:月。 取值:1、2、3、4、5、6、7、8、9、12、24、36。 默認(rèn)值:1。 當(dāng)ChargeType取值為PrePaid時(shí),該參數(shù)有效。 |
ChargeType | String | 否 | 否 | 實(shí)例的付費(fèi)類型。 | 取值:
|
Tags | List | 否 | 是 | 標(biāo)簽。 | 最多添加20個(gè)標(biāo)簽。 更多信息,請(qǐng)參見(jiàn)Tags屬性。 |
SecondaryZoneId | String | 否 | 否 | 配置從節(jié)點(diǎn)(Secondary節(jié)點(diǎn))所在的可用區(qū)。 | 取值:
說(shuō)明
|
HiddenZoneId | String | 否 | 否 | 配置隱藏節(jié)點(diǎn)(Hidden節(jié)點(diǎn))所在的可用區(qū)。 | 取值:
說(shuō)明
|
StorageType | String | 否 | 否 | 存儲(chǔ)類型。 | 取值:
|
Tags語(yǔ)法
"Tags": [
{
"Key": String,
"Value": String
}
]
Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Key | String | 是 | 否 | 標(biāo)簽鍵。 | 長(zhǎng)度為1~128個(gè)字符,不能以 |
Value | String | 否 | 否 | 標(biāo)簽值。 | 長(zhǎng)度為0~128個(gè)字符,不能以 |
返回值
Fn::GetAtt
OrderId:創(chuàng)建MongoDB實(shí)例的訂單ID。
DBInstanceId:MongoDB實(shí)例ID,全局唯一。
DBInstanceStatus:MongoDB實(shí)例的狀態(tài)信息。
ConnectionURI:連接URI。
ReplicaSetName:副本集名稱。
示例
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": { } }