Use ALIYUN::POLARDB::DBNodes in a call to add nodes to a PolarDB cluster - Resource Orchestration Service

ALIYUN::POLARDB::DBNodes is used to add nodes to a PolarDB cluster.

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
DBClusterId	String	Yes	No	The cluster ID.	None.
Amount	Integer	Yes	Yes	The number of nodes that you want to add to the cluster.	None.
ImciSwitch	String	No	No	Specifies whether to enable the In-Memory Column Index (IMCI) feature.	Valid values: ON OFF
ResourceGroupId	String	No	No	The ID of the resource group.	None.
DBNodeType	String	No	No	The node type.	Valid values: RO STANDBY DLNode
EndpointBindList	List	No	No	The IDs of the endpoints that belong to the cluster and to which you want to add the nodes.	Note You can call the DescribeDBClusterEndpoints operation to query the information about endpoints of the cluster, including the endpoint IDs. You can specify the IDs of the default cluster endpoint and a custom cluster endpoint. If you leave this property empty, the nodes are added to all cluster endpoints for which the Automatically Associate New Nodes feature is enabled. If you set `AutoAddNewNodes` to `Enable`, the Automatically Associate New Nodes feature is enabled.
PlannedEndTime	String	No	No	The latest start time to run the scheduled task.	Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC. Note The latest start time must be at least 30 minutes later than the earliest start time. If you specify `PlannedStartTime` but leave PlannedEndTime empty, the latest start time of the task is 30 minutes later than the earliest start time by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` but leave PlannedEndTime empty, the latest start time of the task is `2021-01-14T09:30:00Z`.
PlannedStartTime	String	No	No	The earliest start time to run the scheduled task for adding nodes within the specified time period.	Specify the earliest start time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC. Note The earliest start time of the task can be a point in time within the next 24 hours of the current time. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in time from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`. If you leave this property empty, the task for adding nodes is immediately run by default.

Return values

Fn::GetAtt

DBNodeIds: the IDs of the nodes that are added to the cluster.
OrderIds: the order IDs.

Examples

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"
        ]
      }
    }
  }
}