Use ALIYUN::DRDS::DrdsInstance to create a PolarDB-X instance of a specified type - Resource Orchestration Service

Syntax

{
  "Type": "ALIYUN::DRDS::DrdsInstance",
  "Properties": {
    "VpcId": String,
    "Description": String,
    "InstanceSeries": String,
    "Specification": String,
    "PayType": String,
    "ZoneId": String,
    "PricingCycle": String,
    "Duration": Integer,
    "VswitchId": String,
    "IsAutoRenew": Boolean,
    "Type": String,
    "Tags": List,
    "MySQLVersion": String,
    "ResourceGroupId": String
  }
}

Properties

Property Name	Type	Required	Update allowed	Description	Constraints
VpcId	String	No	No	The ID of the virtual private cloud (VPC).	This parameter is required when you create a database of the VPC network type.
Description	String	Yes	No	The description of the instance.	The description must be 2 to 128 characters in length.
InstanceSeries	String	Yes	No	Instance edition	Valid values: drds.sn1.4c8g drds.sn1.8c16g drds.sn1.16c32g drds.sn1.32c64g
Specification	String	Yes	No	The instance type. The type code consists of the instance edition and the node specification. For example, drds.sn1.4c8g.8C16G consists of the edition drds.sn1.4c8g and the node specification 8C16G.	For more information about the valid values for the instance type, see: Distributed Relational Database Service specifications and pricing.
ResourceGroupId	String	No	Yes	The ID of the resource group.	None
PayType	String	Yes	No	The billing method.	Valid values: drdsPost drdsPre
ZoneId	String	Yes	No	The ID of the zone.	A zone belongs to a region. For example, cn-hangzhou-a belongs to the China (Hangzhou) region cn-hangzhou.
PricingCycle	String	No	No	The unit of the subscription duration.	Valid values: year month This parameter is valid only when PayType is set to drdsPre.
Duration	Integer	No	No	The subscription duration.	Valid values: If you set PricingCycle to year, the valid values are 1 to 3. If you set PricingCycle to month, the valid values are 1 to 9. This parameter is valid only when PayType is set to drdsPre.
VswitchId	String	No	No	The ID of the vSwitch.	This parameter is required when you create a database of the VPC network type.
IsAutoRenew	Boolean	No	No	Whether to enable auto-renewal.	Valid values: true false For monthly subscriptions, the instance renews for one month. For yearly subscriptions, it renews for one year. This parameter is valid only when PayType is set to drdsPre.
Type	String	Yes	No	The type of the instance.	Valid values: 0: shared instance. 1: dedicated instance. PRIVATE: dedicated instance. PUBLIC: shared instance.
MySQLVersion	String	No	No	The version of the MySQL protocol.	Valid values: 5 (default) 8 Note This parameter is valid only when you create a primary instance. A read-only instance uses the same MySQL version as its primary instance by default.
Tags	List	No	Yes	Tags	Up to 20 tags can be added. For more information, see Tags properties.

Tags syntax

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags properties

Property Name	Type	Required	Update allowed	Description	Constraints
Key	String	Yes	No	The key of the tag.	The tag key can be 1 to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.
Value	String	No	No	The value of the tag.	The tag value can be 0 to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.

Return values

Fn::GetAtt

OrderId: The ID of the order.
DrdsInstanceId: The ID of the instance.
IntranetEndpoint: The private endpoint.
InternetEndpoint: The public endpoint.
Arn: The Alibaba Cloud Resource Name (ARN) of the instance.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ZoneId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      VpcId: ${VpcId}
Resources:
  DrdsInstance:
    Type: ALIYUN::DRDS::DrdsInstance
    Properties:
      Type: PRIVATE
      VpcId:
        Ref: VpcId
      ZoneId:
        Ref: ZoneId
      InstanceSeries: drds.sn1.4c8g
      Specification: drds.sn1.4c8g.8C16G
      PayType: drdsPost
      VswitchId:
        Ref: VSwitchId
Outputs: {}

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ZoneId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "VpcId": "${VpcId}"
      }
    }
  },
  "Resources": {
    "DrdsInstance": {
      "Type": "ALIYUN::DRDS::DrdsInstance",
      "Properties": {
        "Type": "PRIVATE",
        "VpcId": {
          "Ref": "VpcId"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "InstanceSeries": "drds.sn1.4c8g",
        "Specification": "drds.sn1.4c8g.8C16G",
        "PayType": "drdsPost",
        "VswitchId": {
          "Ref": "VSwitchId"
        }
      }
    }
  },
  "Outputs": {
  }
}