ALIYUN::POLARDB::DBNodes - 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
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
DBClusterId	String	Yes	No	The ID of the cluster.	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 type of the node.	Valid values: RO STANDBY DLNode

Return values

Fn::GetAtt

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

Examples

YAML format

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 format

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