ALIYUN::DRDS::DrdsInstance - Resource Orchestration Service

ALIYUN::DRDS::DrdsInstance is used to create a Distributed Relational Database Service (DRDS) instance of specific 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).	This property is required if you want to create the DRDS instance 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 specifications of the instance. The specifications consist of the edition and specific CPU cores and memory capacity of the instance. For example, drds.sn1.4c8g.8C16G consists of drds.sn1.4c8g and 8C16G.	For more information about the valid values of this property, see Specifications and pricing of DRDS instances.
ResourceGroupId	String	No	Yes	The ID of the resource group.	None
PayType	String	Yes	No	The billing method of the instance.	Valid values: drdsPost drdsPre
ZoneId	String	Yes	No	The zone ID of the instance.	A zone belongs to a region. For example, Hangzhou Zone A belongs to the China (Hangzhou) region.
PricingCycle	String	No	No	The unit of the subscription duration.	Valid values: year month This property takes effect only if the PayType property is set to drdsPre.
Duration	Integer	No	No	The subscription duration.	Valid values: If the PricingCycle property is set to year: 1 to 3 If the PricingCycle property is set to month: 1 to 9 This property takes effect only if the PayType property is set to drdsPre.
VswitchId	String	No	No	The ID of the vSwitch.	This property is required if you want to create the DRDS instance in a VPC.
IsAutoRenew	Boolean	No	No	Specifies whether to enable auto-renewal.	Valid values: true false If the PricingCycle property is set to month, the subscription is automatically renewed for one month. If the PricingCycle property is set to year, the subscription is automatically renewed for one year. This property takes effect only if the PayType property 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. This is the default value. 8. Note This property takes effect only if you create a primary instance. By default, the MySQL version of a read-only instance is the same as that of the primary instance.
Tags	List	No	Yes	The tags of the instance.	You can add up to 20 tags at a time. 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 key of the tag.	The tag key must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.
Value	String	No	No	The value of the tag.	The tag value can be up to 128 characters in length, and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.

Response parameters

Fn::GetAtt

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

Examples

YAMLformat

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

JSONformat

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

For more information, see DrdsInstance.json and DrdsInstance.yml.