ALIYUN::MONGODB::Instance -

ALIYUN::MONGODB::Instance類型用於建立或複製MongoDB複本集執行個體。

文法

{
  "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網路中訪問建立或複製的執行個體時，是否啟用免密碼。	取值： true：啟用免密碼。 false：禁用免密碼。
DBInstanceStorage	Integer	是	是	資料庫執行個體的儲存空間。	取值範圍：10~3000，必須是10的倍數。單位：GB。
DBInstanceClass	String	是	是	執行個體規格。	更多資訊，請參見執行個體規格概述。
TDEStatus	Boolean	否	是	是否啟用透明資料加密（TDE）。	取值： true：啟用TDE。說明啟用TDE後，您將無法禁用它。 false（預設值）：禁用TDE。
SrcDBInstanceId	String	否	否	源執行個體ID。	只有複製執行個體時才能指定該參數，且必須和BackupId或RestoreTime參數一同指定。
DBInstanceDescription	String	否	否	執行個體描述。	長度為2~256個字元。以漢字或英文字母開頭，可包含漢字、英文字母、數字、底線（_）和短劃線（-）。
SecurityIPArray	String	否	否	所有可以訪問建立或複製執行個體的IP地址。	IP地址以半形逗號（,）隔開，不可重複，最多支援1000個。支援格式：0.0.0.0/0、10.23.XX.XX（IP）或者10.23.XX.XX/24（CIDR模式，無類域間路由。/24表示地址中首碼的長度，取值範圍：1~32）。預設值：0.0.0.0/0，表示不指定IP白名單，即所有IP均可訪問。
ZoneId	String	否	否	可用性區域ID。	更多資訊，請參見DescribeRegions。在專用網路下，該參數取值需與VSwitchId的可用性區域保持一致。
VpcId	String	否	否	專用網路ID。	當NetworkType取值為VPC時，該參數有效。
SecurityGroupId	String	否	是	安全性群組ID。	無
VSwitchId	String	否	否	交換器ID。	當NetworkType取值為VPC時，該參數有效。
BackupId	String	否	否	備份組ID。	只有複製執行個體時才能指定該參數，且必須和SrcDBInstanceId參數一同指定。
NetworkType	String	否	否	網路類型。	取值： CLASSIC（預設值）：傳統網路。 VPC：專用網路。
AccountPassword	String	否	是	Root帳號的密碼。	長度為6~32個字元。可包含英文字母、數字和特殊字元`!#$%^&*()_+-=`。
EngineVersion	String	否	否	資料庫版本號碼。	取值： 3.4（預設值） 4.0 4.2 4.4 5.0
StorageEngine	String	否	否	儲存引擎。	關於儲存引擎與版本選擇的更多資訊，請參見版本及儲存引擎。取值： WiredTiger（預設值）：適用於大多數業務情境。 RocksDB：適用於大量寫且少讀的情境。 TerarkDB：適用於多讀少寫或批量寫大量讀的情境。
ReplicationFactor	Integer	否	是	複本集節點數。	取值： 3（預設值） 5 7
DatabaseNames	String	否	否	資料庫名稱。	無
ReadonlyReplicas	Integer	否	是	唯讀節點的數量。	取值範圍：1~5。
BusinessInfo	String	否	否	商務資訊。	該參數為附加參數。
ResourceGroupId	String	否	是	資源群組ID。	無
AutoRenew	Boolean	否	否	是否為執行個體啟用自動續約。	取值： true：自動續約。 false（預設值）：手動續約。
RestoreTime	String	否	否	複製執行個體時恢複資料的時間點。	格式：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。只有複製執行個體時才能指定該參數，且必須和SrcDBInstanceId、BackupId參數一同指定。支援選擇7天內的任一時間點進行複製。
CouponNo	String	否	否	優惠碼。	預設值：youhuiquan_promotion_option_id_for_blank。
Period	Integer	否	否	執行個體的購買時間長度。	單位：月。取值：1、2、3、4、5、6、7、8、9、12、24、36。預設值：1。當ChargeType取值為PrePaid時，該參數有效。
ChargeType	String	否	否	執行個體的付費類型。	取值： PostPaid：隨用隨付。 PrePaid：預付費。
Tags	List	否	是	標籤。	最多添加20個標籤。更多資訊，請參見Tags屬性。
SecondaryZoneId	String	否	否	配置從節點（Secondary節點）所在的可用性區域。	取值： cn-hangzhou-g：杭州可用性區域G。 cn-hangzhou-h：杭州可用性區域H。 cn-hangzhou-i：杭州可用性區域I。 cn-hongkong-b：中國香港可用性區域B。 cn-hongkong-c：中國香港可用性區域C。 cn-hongkong-d：中國香港可用性區域D。 cn-wulanchabu-a：烏蘭察布可用性區域A。 cn-wulanchabu-b：烏蘭察布可用性區域B。 cn-wulanchabu-c：烏蘭察布可用性區域C。 ap-southeast-1a：新加坡可用性區域A。 ap-southeast-1b：新加坡可用性區域B。 ap-southeast-1c：新加坡可用性區域C。 ap-southeast-5a：雅加達可用性區域A。 ap-southeast-5b：雅加達可用性區域B。 ap-southeast-5c：雅加達可用性區域C。 eu-central-1a：法蘭克福可用性區域A。 eu-central-1b：法蘭克福可用性區域B。 eu-central-1c：法蘭克福可用性區域C。說明當EngineVersion參數值為4.4或5.0時，該參數可用且為必填參數。該參數取值不能與ZoneId和HiddenZoneId參數值相同。
HiddenZoneId	String	否	否	配置隱藏節點（Hidden節點）所在的可用性區域。	取值： cn-hangzhou-g：杭州可用性區域G。 cn-hangzhou-h：杭州可用性區域H。 cn-hangzhou-i：杭州可用性區域I。 cn-hongkong-b：中國香港可用性區域B。 cn-hongkong-c：中國香港可用性區域C。 cn-hongkong-d：中國香港可用性區域D。 cn-wulanchabu-a：烏蘭察布可用性區域A。 cn-wulanchabu-b：烏蘭察布可用性區域B。 cn-wulanchabu-c：烏蘭察布可用性區域C。 ap-southeast-1a：新加坡可用性區域A。 ap-southeast-1b：新加坡可用性區域B。 ap-southeast-1c：新加坡可用性區域C。 ap-southeast-5a：雅加達可用性區域A。 ap-southeast-5b：雅加達可用性區域B。 ap-southeast-5c：雅加達可用性區域C。 eu-central-1a：法蘭克福可用性區域A。 eu-central-1b：法蘭克福可用性區域B。 eu-central-1c：法蘭克福可用性區域C。說明當EngineVersion參數值為4.4或5.0時，該參數可用且為必填參數。該參數值不能與ZoneId和SecondaryZoneId參數值相同。
StorageType	String	否	否	儲存類型。	取值： cloud_essd1：ESSD PL1雲端硬碟。 cloud_essd2：ESSD PL2雲端硬碟。 cloud_essd3：ESSD PL3雲端硬碟。 local_ssd：SSD本地碟。

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

OrderId：建立MongoDB執行個體的訂單ID。
DBInstanceId：MongoDB執行個體ID，全域唯一。
DBInstanceStatus：MongoDB執行個體的狀態資訊。
ConnectionURI：串連URI。
ReplicaSetName：複本集名稱。

樣本

YAML格式

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: {}

JSON格式

{
  "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": {
  }
}

更多樣本，請參見：JSON樣本和YAML樣本。