ALIYUN::PolarDBX::DBInstance is used to create a PolarDB-X 1.0 instance.

Syntax

{
  "Type": "ALIYUN::PolarDBX::DBInstance",
  "Properties": {
    "TopologyType": String,
    "EngineVersion": String,
    "ResourceGroupId": String,
    "VPCId": String,
    "AutoRenew": Boolean,
    "VSwitchId": String,
    "Period": String,
    "PayType": String,
    "DBNodeClass": String,
    "SecondaryZone": String,
    "TertiaryZone": String,
    "DBNodeCount": Integer,
    "PrimaryZone": String,
    "UsedTime": Integer,
    "DBInstanceDescription": String
  }
}

Properties

Property Type Required Editable Description Constraint
TopologyType String Yes No The topology type of the instance. Valid values:
  • 3azones: The instance is deployed in three zones.
  • 1azone: The instance is deployed in only one zone.
EngineVersion String Yes No The version of the database engine. Default value: 2.0.
ResourceGroupId String No No The ID of the resource group. None.
VPCId String Yes No The ID of the virtual private cloud (VPC). None.
AutoRenew Boolean No No Specifies whether to enable auto-renewal. Valid values:
  • true
  • false
VSwitchId String Yes No The ID of the vSwitch. None.
Period String No No The billing cycle of the instance.
Note
  • Valid values if you set the PayType property to PREPAY: Year and Month.
  • Valid value if you set the PayType property to POSTPAY: Hour.
PayType String No No The billing method of the instance. Valid values:
  • PREPAY: subscription
  • POSTPAY: pay-as-you-go
DBNodeClass String Yes No The instance type of the node. Valid values:
  • polarx.x4.medium.2e: A node of this instance type is configured with 2 CPU cores and 8 GB memory.
  • polarx.x4.large.2e: A node of this instance type is configured with 4 CPU cores and 16 GB memory.
  • polarx.x8.large.2e: A node of this instance type is configured with 4 CPU cores and 32 GB memory.
  • polarx.x4.xlarge.2e: A node of this instance type is configured with 8 CPU cores and 32 GB memory.
  • polarx.x8.xlarge.2e: A node of this instance type is configured with 8 CPU cores and 64 GB memory.
  • polarx.x4.2xlarge.2e: A node of this instance type is configured with 16 CPU cores and 64 GB memory.
  • polarx.x8.2xlarge.2e: A node of this instance type is configured with 16 CPU cores and 128 GB memory.
  • polarx.x4.4xlarge.2e: A node of this instance type is configured with 32 CPU cores and 128 GB memory.
  • polarx.x8.4xlarge.2e: A node of this instance type is configured with 32 CPU cores and 256 GB memory.
  • polarx.st.8xlarge.2e: A node of this instance type is configured with 60 CPU cores and 470 GB memory.
  • polarx.st.12xlarge.2e: A node of this instance type is configured with 90 CPU cores and 720 GB memory.
SecondaryZone String No No The secondary zone. None.
TertiaryZone String No No The tertiary zone. None.
DBNodeCount Integer Yes No The number of nodes in the instance. The instance must contain at least two nodes.
PrimaryZone String Yes No The primary zone. None.
UsedTime Integer No No The subscription duration of the instance.
Note Valid values if you set the Period property to Year: 1, 2, and 3.
DBInstanceDescription String No Yes The description of the instance. None.

Return values

Fn::GetAtt

  • OrderId: the ID of the order.
  • DBInstanceName: the name of the instance.

Examples

  • JSON format 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TopologyType": {
      "Type": "String",
      "Description": "The topology type of the instance. Valid values: 3azones: The instance is deployed in three zones. 1azone: The instance is deployed in only one zone.",
      "AllowedValues": [
        "1azone",
        "3azones"
      ]
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "The version of the database engine."
    },
    "VPCId": {
      "Type": "String",
      "Description": "The ID of the VPC to which the instance belongs."
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "The ID of the vSwitch."
    },
    "DBNodeClass": {
      "Type": "String",
      "Description": "The specification of the nodes in the instance you want to create."
    },
    "DBNodeCount": {
      "Type": "Number",
      "Description": "The number of nodes in the instance you want to create.",
      "MinValue": 2
    },
    "PrimaryZone": {
      "Type": "String",
      "Description": "The primary zone."
    }
  },
  "Resources": {
    "DBInstance": {
      "Type": "ALIYUN::PolarDBX::DBInstance",
      "Properties": {
        "TopologyType": {
          "Ref": "TopologyType"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "VPCId": {
          "Ref": "VPCId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "DBNodeClass": {
          "Ref": "DBNodeClass"
        },
        "DBNodeCount": {
          "Ref": "DBNodeCount"
        },
        "PrimaryZone": {
          "Ref": "PrimaryZone"
        }
      }
    }
  },
  "Outputs": {
    "OrderId": {
      "Description": "The ID of the order.",
      "Value": {
        "Fn::GetAtt": [
          "DBInstance",
          "OrderId"
        ]
      }
    },
    "DBInstanceName": {
      "Description": "The name of the instance that you create.",
      "Value": {
        "Fn::GetAtt": [
          "DBInstance",
          "DBInstanceName"
        ]
      }
    }
  }
}

  • YAML format 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TopologyType:
    Type: String
    Description: 'The topology type of the instance. Valid values: 3azones: The instance is deployed in three zones. 1azone: The instance is deployed in only one zone.'
    AllowedValues:
      - 1azone
      - 3azones
  EngineVersion:
    Type: String
    Description: The version of the database engine.
  VPCId:
    Type: String
    Description: The ID of the VPC to which the instance belongs.
  VSwitchId:
    Type: String
    Description: The ID of the vSwitch.
  DBNodeClass:
    Type: String
    Description: The specification of the nodes in the instance you want to create.
  DBNodeCount:
    Type: Number
    Description: The number of nodes in the instance you want to create.
    MinValue: 2
  PrimaryZone:
    Type: String
    Description: The primary zone.
Resources:
  DBInstance:
    Type: ALIYUN::PolarDBX::DBInstance
    Properties:
      TopologyType:
        Ref: TopologyType
      EngineVersion:
        Ref: EngineVersion
      VPCId:
        Ref: VPCId
      VSwitchId:
        Ref: VSwitchId
      DBNodeClass:
        Ref: DBNodeClass
      DBNodeCount:
        Ref: DBNodeCount
      PrimaryZone:
        Ref: PrimaryZone
Outputs:
  OrderId:
    Description: The ID of the order.
    Value:
      Fn::GetAtt:
        - DBInstance
        - OrderId
  DBInstanceName:
    Description: The name of the instance that you create.
    Value:
      Fn::GetAtt:
        - DBInstance
        - DBInstanceName