Use ALIYUN::DRDS::DrdsInstance in a call to create a PolarDB-X 1.0 instance of specified instance specifications - Resource Orchestration Service

ALIYUN::DRDS::DrdsInstance is used to create a PolarDB-X 1.0 instance of specified instance specifications.

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	Type	Required	Editable	Description	Constraint
VpcId	String	No	No	The ID of the virtual private cloud (VPC).	You must specify this property when you create databases in a VPC.
Description	String	Yes	No	The description of the instance.	The description must be 2 to 128 characters in length.
InstanceSeries	String	Yes	No	The edition of the instance.	Valid values: drds.sn1.4c8g drds.sn1.8c16g drds.sn1.16c32g drds.sn1.32c64g
Specification	String	Yes	No	The instance specifications. The instance specifications consist of the edition and the vCPUs and memory of the instance. For example, drds.sn1.4c8g.8C16G consists of drds.sn1.4c8g and 8C16G.	For more information about instance specifications, go to the Pricing page of PolarDB-X 1.0.
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 zone ID.	A zone belongs to a region. For example, the zone whose ID is cn-hangzhou-a belongs to the region whose ID is cn-hangzhou.
PricingCycle	String	No	No	The unit of the subscription duration.	Valid values: year month This property takes effect when PayType is set to drdsPre.
Duration	Integer	No	No	The subscription duration.	Valid values when PricingCycle is set to year: 1 to 3. Valid values when PricingCycle is set to month: 1 to 9. This property takes effect when PayType is set to drdsPre.
VswitchId	String	No	No	The vSwitch ID.	You must specify this property when you create databases in a VPC.
IsAutoRenew	Boolean	No	No	Specifies whether to enable auto-renewal.	Valid values: true false If PricingCycle is set to month, the subscription is automatically renewed for one month. If PricingCycle is set to year, the subscription is automatically renewed for one year. This property takes effect 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 property takes effect only when you create a primary instance. By default, the version of the MySQL protocol of a read-only instance is the same as the version of the MySQL protocol of the primary instance.
Tags	List	No	Yes	The tags.	You can add up to 20 tags. For more information, see Tags properties.

Tags syntax

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

Tags properties

Property	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The tag key.	The tag key must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.
Value	String	No	No	The tag value.	The tag value can be up to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.

Return values

Fn::GetAtt

OrderId: the order ID.
DrdsInstanceId: the instance ID.
IntranetEndpoint: the private endpoint.
InternetEndpoint: the public endpoint.

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