調用ALIYUN::MONGODB::Instance建立或複製MongoDB複本集執行個體 - Resource Orchestration Service

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,
    "Tags": List,
    "SecondaryZoneId": String,
    "HiddenZoneId": String,
    "StorageType": String,
    "PrivateConnections": Map,
    "ClusterId": String,
    "SrcRegion": String,
    "AuditPolicyOptions": Map,
    "DBInstanceReleaseProtection": Boolean,
    "SSLOptions": Map,
    "Encrypted": Boolean,
    "ProvisionedIops": Integer,
    "EncryptionKey": String,
    "RestoreType": Integer,
    "BackupPolicyOptions": Map
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
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均可訪問。
ClusterId	String	否	否	專屬叢集 ID。	無
SrcRegion	String	否	否	源執行個體所在地區。	說明當備份恢複類型為 2 或 3 時，需要且必填
AuditPolicyOptions	Map	否	是	審計策略配置。	更多資訊，請參考AuditPolicyOptions屬性。
DBInstanceReleaseProtection	Boolean	否	是	是否開啟執行個體釋放保護。	取值說明： true：已開啟。 false：未開啟。
SSLOptions	Map	否	是	TLS（SSL）加密功能配置	更多資訊，請參考SSLOptions屬性。
Encrypted	Boolean	否	否	是否開啟雲端硬碟加密。	無
ProvisionedIops	Integer	否	否	預配置效能。	無
EncryptionKey	String	否	否	雲端硬碟加密對應的 kms-key。	無
RestoreType	Integer	否	否	備份恢複執行個體。	取值： 0: 恢複執行個體到指定備份組 1: 恢複執行個體到指定時間點 2: 恢複已釋放執行個體到指定備份組 3: 恢複執行個體到指定的異地備份組
BackupPolicyOptions	Map	否	是	備份策略配置。	更多資訊，請參考BackupPolicyOptions屬性。
ZoneId	String	否	否	可用性區域ID。	更多資訊，請參見DescribeRegions。在專用網路下，該參數取值需與VSwitchId的可用性區域保持一致。
VpcPasswordFree	Boolean	否	否	在VPC網路中訪問建立或複製的執行個體時，是否啟用免密碼。	取值： true：啟用免密碼。 false：禁用免密碼。
VpcId	String	否	否	專用網路ID。	無
SecurityGroupId	String	否	是	安全性群組ID。	無
VSwitchId	String	否	否	交換器ID。	無
BackupId	String	否	否	備份組ID。	只有複製執行個體時才能指定該參數，且必須和SrcDBInstanceId參數一同指定。
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本地碟。
PrivateConnections	Map	否	是	私人串連的串連配置。	更多資訊，請參見PrivateConnections屬性。

Tags文法

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags屬性

屬性名稱	類型	必須	允許更新	描述	約束
Key	String	是	否	標籤鍵。	長度為1~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或`https://` 。
Value	String	否	否	標籤值。	長度為0~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或`https://` 。

PrivateConnections文法

"PrivateConnections": 
  {
    "ReplicaConnections": List
  }

PrivateConnections屬性

屬性名稱

類型

必須

允許更新

描述

約束

ReplicaConnections

List

是

Replica節點的串連資訊。

長度範圍：1~6。

說明

僅支援按照MongoDB DescribeDBInstanceAttribute API查詢的順序建立或修改對應節點的串連資訊。

更多資訊，請參見ReplicaConnections屬性。

AuditPolicyOptions文法

"AuditPolicyOptions": 
  {
    "StoragePeriod": Integer,
    "AuditStatus": String,
    "AuditLogSwitchSource": String,
    "ServiceType": String
  }

AuditPolicyOptions屬性

屬性名稱	類型	必須	允許更新	描述	約束
AuditStatus	String	是	是	審計日誌狀態	取值： enable：開啟審計日誌。 disabled：關閉審計日誌。
StoragePeriod	Integer	否	是	審計日誌保留時間長度。	取值範圍為 1~365 天，預設為 30 天。
AuditLogSwitchSource	String	否	是	審計日誌的請求來源。	取值為 Console。
ServiceType	String	否	是	審計日誌的版本類型。	取值： Trial：免費試用。 Standard：正式版。說明該參數的預設值為 Trial。從 2022 年 01 月 06 日起，各地區將陸續上線正式版審計日誌，並終止申請免費試用審計日誌。建議您設定為 Standard。

SSLOptions文法

"SSLOptions": 
  {
    "ForceEncryption": Integer,
    "SwitchMode": Integer,
    "SSLAction": String
  }

SSLOptions屬性

屬性名稱	類型	必須	允許更新	描述	約束
SSLAction	String	是	是	對 SSL 功能執行的操作。	取值說明： Open：開啟 SSL 加密。 Close：關閉 SSL 加密。 Update：更新 SSL 憑證。
ForceEncryption	Integer	否	是	串連是否強制開啟 SSL 加密。	取值說明： 1：強制開啟 SSL 加密. 0：不強制開啟 SSL 加密。
SwitchMode	Integer	否	是	修改 MongoDB 執行個體 SSL 配置的時間點。	取值： 0：立刻修改。 1：在可營運時間內修改。

BackupPolicyOptions文法

"SSLOptions": 
  {
    "CrossBackupType": String,
    "BackupInterval": Integer,
    "BackupRetentionPolicyOnClusterDeletion": Integer,
    "HighFrequencyBackupRetention": Integer,
    "BackupRetentionPeriod": Integer,
    "InstanceType": String,
    "LogBackupRetentionPeriod": Integer,
    "CrossRetentionValue": Integer,
    "CrossBackupPeriod": String,
    "PreferredBackupTime": String,
    "DestRegion": String,
    "CrossRetentionType": String,
    "EnableCrossLogBackup": Integer,
    "PreferredBackupPeriod": String,
    "PreserveOneEachHour": Boolean,
    "SnapshotBackupType": String,
    "CrossLogRetentionType": String,
    "CrossLogRetentionValue": Integer,
    "EnableBackupLog": Integer,
    "SrcRegion": String
  }

BackupPolicyOptions屬性

屬性名稱	類型	必須	允許更新	描述	約束
CrossBackupType	String	否	是	異地備份操作策略。	取值說明： update: 修改異地備份策略 delete: 刪除異地備份策略
BackupInterval	Integer	否	是	高頻備份頻率。	取值說明： -1：不開啟高頻備份。 30：每 30 分鐘。 60：每 1 小時。 120：每 2 小時。 180：每 3 小時。 240：每 4 小時。 360：每 6 小時。 480：每 8 小時。 720：每 12 小時。
BackupRetentionPolicyOnClusterDeletion	Integer	否	是	備份保留原則。	取值： 0：執行個體釋放時立即刪除該執行個體的所有備份組 1：執行個體釋放時會自動備份，長期保留該備份組 2：執行個體釋放時會自動備份，並長期保留該叢集的所有備份組詳細資料請參見：長期保留備份
HighFrequencyBackupRetention	Integer	否	是	高頻備份保留天數。	使用該參數前需要先確認已經傳入 BackupInterval 欄位。預設保留時間長度一天。
BackupRetentionPeriod	Integer	否	是	全量備份保留天數。	說明 2021 年 09 月 10 日前使用者預設保留天數為 7 天。 2021 年 09 月 10 日後新使用者預設保留天數為 30 天。
InstanceType	String	否	是	執行個體類型。	取值： replicate sharding 說明當備份恢複類型為已刪除執行個體重建時，需要且必填當備份恢複類型為異地備份複製時，需要且必填
LogBackupRetentionPeriod	Integer	否	是	記錄備份保留天數。	預設為 7 天。取值範圍：7~730。
CrossRetentionValue	Integer	否	是	異地備份保留時間長度。	可設定 3-1825 天。說明異地備份必填當 CrossRetentionType 為 delay 時使用且必須使用。
CrossBackupPeriod	String	否	是	異地備份的保留時間。	取值： Monday：周一 Tuesday：周二 Wednesday：周三 Thursday：周四 Friday：周五 Saturday：周六 Sunday：周日說明異地備份必填傳入多個值，請用英文逗號（,）隔開。當備份設定為常規備份時，該值需要為 PreferredBackupPeriod 備份周期的子集。
PreferredBackupTime	String	否	是	執行備份的時間，	格式為HH:mmZ-HH:mmZ（UTC 時間）。說明時間範圍限制為 1 小時。
DestRegion	String	否	是	備份所在地區。	說明異地備份必填
CrossRetentionType	String	否	是	異地備份保留類型。	說明 delay（保留一段時間） never（不到期）
EnableCrossLogBackup	Integer	否	是	是否開啟跨地區記錄備份。	說明異地備份必填 1：開啟 (分區叢集必須為 1，複本集如果想支援異地時間點恢複必須為 1) 0：關閉
PreferredBackupPeriod	String	否	是	備份周期。	取值說明： Monday：周一。 Tuesday：周二。 Wednesday：周三。 Thursday：周四。 Friday：周五。 Saturday：周六。 Sunday：周日。說明傳入多個值，請用英文逗號（,）隔開。
PreserveOneEachHour	Boolean	否	是	是否開啟按小時稀疏備份。	取值： true：當備份頻率為分鐘級時，距離目前時間 1 小時內的快照全部保留。距離目前時間超過 1 小時且在 24 小時內的快照，僅保留整點後的第一個快照。 false：高頻備份保留天數內的快照全部保留。
SnapshotBackupType	String	否	是	快照備份類型。	取值說明： Flash：秒級備份。 Standard：常規備份（預設值）。
CrossLogRetentionType	String	否	是	異地記錄備份保留類型。	取值： delay（保留一段時間） never（不到期）
CrossLogRetentionValue	Integer	否	是	異地記錄備份保留時間長度。	可設定 3-1825 天，需要小於等於 CrossRetentionValue 的值。
EnableBackupLog	Integer	否	是	是否開啟記錄備份。	取值說明： 0：關閉（預設值）。 1：開啟。
SrcRegion	String	否	是	執行個體所在地區。	說明已刪除執行個體恢複必填異地備份必填

ReplicaConnections文法

{
  "PrivateConnections": {
    "ReplicaConnections": [
      {
        "ConnectionString": String,
        "ConnectionPort": Integer
      }
    ]
  }
}

ReplicaConnections屬性

屬性名稱	類型	必須	允許更新	描述	約束
ConnectionString	String	是	是	串連地址的首碼部分	以小寫字母開頭。以小寫字母或數字結尾。由小寫字母、數字和連字號（-）組成。長度為 8~63 個字元。說明僅需傳入串連地址的首碼部分，首碼以外的部分不可修改。 SSD本地碟和ESSD雲端硬碟執行個體均支援修改Primary節點、Secondary節點和ReadOnly節點的串連地址。
ConnectionPort	Integer	否	是	串連連接埠	有效值：1000 到 65535。說明僅支援修改MongoDB 4.2及以上版本的ESSD雲端硬碟版執行個體的連接埠。

傳回值

Fn::GetAtt

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

樣本

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

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