ALIYUN::OTS::VCUInstance - Resource Orchestration Service

The ALIYUN::OTS::VCUInstance resource creates a Virtual Compute Unit (VCU) instance.

Syntax

{
  "Type": "ALIYUN::OTS::VCUInstance",
  "Properties": {
    "ClusterType": String,
    "PeriodInMonth": Integer,
    "VCU": Integer,
    "AliasName": String,
    "AutoRenewPeriodInMonth": Integer,
    "EnableElasticVCU": Boolean,
    "EnableAutoRenew": Boolean,
    "InstanceDescription": String,
    "ResourceGroupId": String,
    "Tags": List
  }
}

Properties

Property name	Type	Required	Updatable	Description	Constraints
ClusterType	String	Yes	No	The cluster type.	Valid values: SSD: High-performance. HYBRID: Capacity.
PeriodInMonth	Integer	Yes	No	The subscription duration.	Unit: month. Valid values: 1 to 24.
VCU	Integer	Yes	No	The instance type.	The number of VCUs. Valid values: 0 to 2000.
AliasName	String	No	Yes	The instance alias.	None
AutoRenewPeriodInMonth	Integer	No	No	The auto-renewal cycle.	Unit: month. Valid values: 1 to 24.
EnableElasticVCU	Boolean	No	No	Specifies whether to enable elastic VCUs for the instance.	If you enable this feature, the peak VCU usage can exceed the purchased VCU amount. This incurs additional fees.
EnableAutoRenew	Boolean	No	No	Specifies whether to enable auto-renewal.	None
InstanceDescription	String	No	Yes	The instance description.	None
ResourceGroupId	String	No	Yes	The ID of the resource group.	None
Tags	List	No	Yes	The tags.	You can attach a maximum of 20 tags to each instance. For more information, see Tags property.

Tags syntax

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

Tags property

Property name	Type	Required	Allow updates	Description	Constraint
Key	String	Yes	No	The tag key.	None
Value	String	Yes	No	The tag value.	None

Return value

Fn::GetAtt

InstanceName: The name of the VCU instance.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PeriodInMonth:
    Type: Number
    Description:
      en: 'Purchase duration. Unit: month. Value range: 1~24.'
    Required: true
    MinValue: 1
    MaxValue: 24
  VCU:
    Type: Number
    Description:
      en: 'Number of VCU units. Value range: 0~2000.'
    Required: true
    MinValue: 0
    MaxValue: 2000
  ClusterType:
    Type: String
    Description:
      en: |-
        Cluster type (i.e. instance specification).
        Enumeration values:
        SSD: High performance.
        HYBRID: Capacity type.
    AllowedValues:
      - SSD
      - HYBRID
    Required: true
Resources:
  VCUInstance:
    Type: ALIYUN::OTS::VCUInstance
    Properties:
      PeriodInMonth:
        Ref: PeriodInMonth
      VCU:
        Ref: VCU
      ClusterType:
        Ref: ClusterType
Outputs:
  InstanceName:
    Description: Name of the tablestore VCU instance.
    Value:
      Fn::GetAtt:
        - VCUInstance
        - InstanceName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PeriodInMonth": {
      "Type": "Number",
      "Description": {
        "en": "Purchase duration. Unit: month. Value range: 1~24."
      },
      "Required": true,
      "MinValue": 1,
      "MaxValue": 24
    },
    "VCU": {
      "Type": "Number",
      "Description": {
        "en": "Number of VCU units. Value range: 0~2000."
      },
      "Required": true,
      "MinValue": 0,
      "MaxValue": 2000
    },
    "ClusterType": {
      "Type": "String",
      "Description": {
        "en": "Cluster type (i.e. instance specification).\nEnumeration values:\nSSD: High performance.\nHYBRID: Capacity type."
      },
      "AllowedValues": [
        "SSD",
        "HYBRID"
      ],
      "Required": true
    }
  },
  "Resources": {
    "VCUInstance": {
      "Type": "ALIYUN::OTS::VCUInstance",
      "Properties": {
        "PeriodInMonth": {
          "Ref": "PeriodInMonth"
        },
        "VCU": {
          "Ref": "VCU"
        },
        "ClusterType": {
          "Ref": "ClusterType"
        }
      }
    }
  },
  "Outputs": {
    "InstanceName": {
      "Description": "Name of the tablestore VCU instance.",
      "Value": {
        "Fn::GetAtt": [
          "VCUInstance",
          "InstanceName"
        ]
      }
    }
  }
}