ALIYUN::ROCKETMQ::Instance is used to create an Standard Edition Instance.

Syntax

{
  "Type": "ALIYUN::ROCKETMQ::Instance",
  "Properties": {
    "Remark": String,
    "InstanceName": String
  }
}

Properties

Parameter Data type Required Editable Description Constraint
Remark String No Yes Remarks Maximum length is 128 characters.
InstanceName String Yes Yes Instance Name The name must be 3 to 64 characters in length and can contain letters, digits, hyphen (-), and underscores (_).

Error code

Fn::GetAtt

  • InstanceId: the ID of the instance.
  • InstanceType: the type of the instance. A value of 1 indicates that the instance is Standard Edition.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Instance": {
      "Type": "ALIYUN::ROCKETMQ::Instance",
      "Properties": {
        "Remark": {
          "Ref": "Remark"
        },
        "InstanceName": {
          "Ref": "InstanceName"
        }
      }
    }
  },
  "Parameters": {
    "Remark": {
      "Type": "String",
      "Description": "The remark of instance."
    },
    "InstanceName": {
      "MinLength": 3,
      "Type": "String",
      "Description": "The name of the instance, which contains 3 to 64 characters in Chinese or English.",
      "MaxLength": 64
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "Instance ID created",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "InstanceType": {
      "Description": "Instance Type",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceType"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  Instance:
    Type: 'ALIYUN::ROCKETMQ::Instance'
    Properties:
      Remark:
        Ref: Remark
      InstanceName:
        Ref: InstanceName
Parameters:
  Remark:
    Type: String
    Description: The remark of instance.
  InstanceName:
    MinLength: 3
    Type: String
    Description: >-
      The name of the instance and which contains 3 to 64 characters in Chinese or
      English.
    MaxLength: 64
Outputs:
  InstanceId:
    Description: Instance ID created
    Value:
      'Fn::GetAtt':
        -Instance
        - InstanceId
  InstanceType:
    Description: Instance Type
    Value:
      'Fn::GetAtt':
        -Instance
        - InstanceType