调用ALIYUN::POLARDB::DBNodes增加PolarDB集群节点 - 资源编排

ALIYUN::POLARDB::DBNodes类型用于增加PolarDB集群节点。

语法

 {
  "Type": "ALIYUN::POLARDB::DBNodes",
  "Properties": {
    "DBClusterId": String,
    "Amount": Integer,
    "ImciSwitch": String,
    "ResourceGroupId": String,
    "DBNodeType": String,
    "EndpointBindList": List,
    "PlannedEndTime": String,
    "PlannedStartTime": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
DBClusterId	String	是	否	集群ID。	无。
Amount	Integer	是	是	添加到集群的节点数。	无。
ImciSwitch	String	否	否	是否开启列存索引。	取值： ON：开启。 OFF：关闭。
ResourceGroupId	String	否	否	资源组ID。	无
DBNodeType	String	否	否	节点类型。	取值： RO STANDBY DLNode
EndpointBindList	List	否	否	指定新增节点需要加入的集群连接地址的地址 ID。	说明您可以通过调用DescribeDBClusterEndpoints接口查看集群连接地址的详情，包括连接地址 ID。支持填入默认集群连接地址和自定义集群连接地址的地址 ID。若该参数留空，默认将新增节点加入所有开启了新节点自动加入功能（即`AutoAddNewNodes`取值为`Enable`）的集群连接地址。
PlannedEndTime	String	否	否	开始执行目标定时任务的最晚时间。	格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。说明最晚时间需晚于开始时间的 30 分钟或以上。若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30 分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。
PlannedStartTime	String	否	否	开始执行定时（即在目标时间段内执行）新增节点任务的最早时间。	格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。说明开始时间的取值范围为未来 24 小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。若该参数留空，默认立即执行新增节点任务。

返回值

Fn::GetAtt

DBNodeIds：添加到集群的节点ID。
OrderIds：订单ID。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterId:
    Type: String
    Description: The ID of the ApsaraDB for POLARDB cluster to be added nodes to.
Resources:
  DBNodes:
    Type: ALIYUN::POLARDB::DBNodes
    Properties:
      DBClusterId:
        Ref: DBClusterId
      Amount: 1
Outputs:
  DBNodeIds:
    Description: The ID list of added cluster nodes.
    Value:
      Fn::GetAtt:
        - DBNodes
        - DBNodeIds
  OrderIds:
    Description: The order ID list of added cluster nodes.
    Value:
      Fn::GetAtt:
        - DBNodes
        - OrderIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": "The ID of the ApsaraDB for POLARDB cluster to be added nodes to."
    }
  },
  "Resources": {
    "DBNodes": {
      "Type": "ALIYUN::POLARDB::DBNodes",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId"
        },
        "Amount": 1
      }
    }
  },
  "Outputs": {
    "DBNodeIds": {
      "Description": "The ID list of added cluster nodes.",
      "Value": {
        "Fn::GetAtt": [
          "DBNodes",
          "DBNodeIds"
        ]
      }
    },
    "OrderIds": {
      "Description": "The order ID list of added cluster nodes.",
      "Value": {
        "Fn::GetAtt": [
          "DBNodes",
          "OrderIds"
        ]
      }
    }
  }
}