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

Syntax

{
  "Type": "ALIYUN::POLARDB::DBNodes",
  "Properties": {
    "DBClusterId": String,
    "Amount": Integer,
    "ImciSwitch": String
  }
}

Properties

PropertyTypeRequiredEditableDescriptionConstraint
DBClusterIdStringYesNoThe ID of the cluster. None
AmountIntegerYesYesThe number of nodes that you want to add to the cluster. None
ImciSwitchStringNoNoSpecifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values:
  • ON: enables the IMCI feature.
  • OFF: does not enable the IMCI feature.

Return values

Fn::GetAtt

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

Examples

  • YAMLformat

    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
  • JSONformat

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