ALIYUN::DRDS::DrdsInstance is used to create a DRDS instance of a specified specification.

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,
    "Quantity": Integer
  }
}

Properties

Name Type Required Editable Description Validity
VpcId String No No The ID of the VPC. This parameter must be specified when DRDS instances are created in a VPC. None.
Description String Yes No The description of the DRDS instance. The description must be 2 to 128 characters in length. None.
InstanceSeries String Yes No The series of the DRDS instance. Valid values: drds.sn1.4c8g, drds.sn1.8c16g, drds.sn1.16c32g, and drds.sn1.32c64g.
Specification String Yes No The specification of the DRDS instance. It consists of the series and specific specifications of the instance. Example: drds.sn1.4c8g.8C16G. For more information about valid values of the instance specifications, see DRDS specifications and pricing. None.
PayType String Yes No The billing method of the DRDS instance. Valid values: drdsPost and drdsPre.
ZoneId String Yes No The ID of the zone where the DRDS instance resides. A zone belongs to a region. For example, the cn-hangzhou-a zone belongs to the cn-hangzhou region. None.
PricingCycle String No No The unit of the subscription cycle. This parameter takes effect only when the PayType parameter is set to drdsPre. Valid values: year and month.
Duration Integer No No The number of the subscription units. Valid values for this parameter when the PricingCycle parameter is set to year: 1 to 3. Valid values for this parameter when the PricingCycle parameter is set to month: 1 to 9. This parameter takes effect only when the PayType parameter is set to drdsPre. None.
VswitchId String No No The ID of the VSwitch. This parameter must be specified when the DRDS instance is created in a VPC. None.
IsAutoRenew Boolean No No Specifies whether to enable automatic renewal for the DRDS instance. If the PricingCycle parameter is set to month, the subscription is automatically renewed for one month. If the PricingCycle parameter is set to year, the subscription is automatically renewed for one year. This parameter takes effect only when the PayType parameter is set to drdsPre. None.
Type String Yes No The type of the DRDS instance. A value of 0 or PUBLIC specifies the shared instance. A value of 1 or PRIVATE specifies the exclusive instance. Valid values: 0, 1, PRIVATE, and PUBLIC.
Quantity Integer Yes No The number of purchased DRDS instances. None.

Response parameters

Fn::GetAtt

  • OrderId: the ID of the order.
  • DrdsInstanceId: the ID of the DRDS instance.

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "DrdsInstance": {
      "Type": "ALIYUN::DRDS::DrdsInstance",
      "Properties": {
        "VpcId": {
          "Ref": "VpcId"
        },
        "Description": {
          "Ref": "Description"
        },
        "InstanceSeries": {
          "Ref": "InstanceSeries"
        },
        "Specification": {
          "Ref": "Specification"
        },
        "PayType": {
          "Ref": "PayType"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "PricingCycle": {
          "Ref": "PricingCycle"
        },
        "Duration": {
          "Ref": "Duration"
        },
        "VswitchId": {
          "Ref": "VswitchId"
        },
        "IsAutoRenew": {
          "Ref": "IsAutoRenew"
        },
        "Type": {
          "Ref": "Type"
        },
        "Quantity": {
          "Ref": "Quantity"
        }
      }
    }
  },
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "Description": "Virtual private network ID, must be specified when creating a DRDS for VPC network type"
    },
    "Description": {
      "Type": "String",
      "Description": "Description of the DRDS instance, 2-128 characters"
    },
    "InstanceSeries": {
      "Type": "String",
      "Description": "drds.sn1.4c8g Starter Edition; drds.sn1.8c16g Standard Edition; drds.sn1.16c32g Business Edition; drds.sn1.32c64g Ultimate Edition",
      "AllowedValues": [
        "drds.sn1.4c8g",
        "drds.sn1.8c16g",
        "drds.sn1.16c32g",
        "drds.sn1.32c64g"
      ]
    },
    "Specification": {
      "Type": "String",
      "Description": "The example specification, for example, drds.sn1.4c8g.8C16G, consists of the DRDS instance series (drds.sn1.4c8g) plus a specific example specification (8C16G). For the DRDS instance specification value range, see: Distributed Relational Database Service Specifications and Pricing"
    },
    "PayType": {
      "Type": "String",
      "Description": "For the type of payment, see \"Payment Type Parameter Table\"",
      "AllowedValues": [
        "drdsPost",
        "drdsPre"
      ]
    },
    "ZoneId": {
      "Type": "String",
      "Description": "Availability zone, an available zone belongs to a certain zone, such as Hangzhou Availability Zone A (cn-hangzhou-a) belongs to the region Hangzhou (cn-hangzhou)"
    },
    "PricingCycle": {
      "Type": "String",
      "Description": "The unit of the order period, year: year, month: month. The parameter takes effect when the payment type is drdsPre.",
      "AllowedValues": [
        "year",
        "month"
      ]
    },
    "Duration": {
      "Type": "Number",
      "Description": "The number of cycles ordered. When PricingCycle=year, the value is 1-3; when PricingCycle=month, the value is 1-9. The parameter takes effect when the payment type is drdsPre.",
      "MaxValue": 9,
      "MinValue": 1
    },
    "VswitchId": {
      "Type": "String",
      "Description": "Virtual switch ID, must be specified when creating a DRDS for VPC network type"
    },
    "IsAutoRenew": {
      "Type": "Boolean",
      "Description": "Whether to renew the fee automatically, if it is purchased on a monthly basis, it will automatically renew for one month, and if it is purchased on an annual basis, it will automatically renew for one year. The parameter takes effect when the payment type is drdsPre.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "Type": {
      "Type": "String",
      "Description": "Instance type, instance type 0 - shared instance 1 - exclusive instance, in addition, this parameter can also pass PRIVATE and PUBLIC to represent exclusive instance and shared instance respectively",
      "AllowedValues": [
        "0",
        "1",
        "PRIVATE",
        "PUBLIC"
      ]
    },
    "Quantity": {
      "Type": "Number",
      "Description": "Purchase quantity",
      "MinValue": 1
    }
  },
  "Outputs": {
    "OrderId": {
      "Description": "order number",
      "Value": {
        "Fn::GetAtt": [
          "DrdsInstance",
          "OrderId"
        ]
      }
    },
    "DrdsInstanceId": {
      "Description": "instance id",
      "Value": {
        "Fn::GetAtt": [
          "DrdsInstance",
          "DrdsInstanceId"
        ]
      }
    }
  }
}