调用ALIYUN::MONGODB::Instance创建或克隆MongoDB副本集实例 - 资源编排

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	String	否	是	修改 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示例。