ALIYUN::ROCKETMQ::Instance is used to create a Standard Edition instance.

Syntax

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

Properties

PropertyTypeRequiredEditableDescriptionConstraint
RemarkStringNoYesThe description of the instance. The description can be up to 128 character in length.
InstanceNameStringYesYesThe name of the instance. The name must be 3 to 64 characters in length, and can contain letters, digits, hyphens (-), and underscores (_).
TagsListNoYesThe tags of the instance. A maximum of 20 tags can be specified.

For more information, see Tags properties.

Tags syntax

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

Tags properties

PropertyTypeRequiredEditableDescriptionConstraint
KeyStringYesNoThe tag key. The tag key must be 1 to 128 characters in length and cannot contain http:// or https://. It cannot start with acs: or aliyun.
ValueStringNoNoThe tag value. The tag value must be 0 to 128 characters in length and cannot contain http:// or https://. It cannot start with acs: or aliyun.

Response parameters

Fn::GetAtt

  • InstanceId: the ID of the instance.
  • InstanceType: the type of the instance. If 1 is returned, the created instance is of the Standard Edition.
  • HttpInternetEndpoint: the public HTTP endpoint.
  • HttpInternetSecureEndpoint: the public HTTPS endpoint.
  • TcpEndpoint: the TCP endpoint.
  • HttpInternalEndpoint: the internal HTTP endpoint.
  • InstanceName: the name of the instance.

Examples

  • YAMLformat

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      Instance:
        Type: ALIYUN::ROCKETMQ::Instance
        Properties:
          InstanceName: TestRocketMQ
    Outputs:
      InstanceName:
        Description: Instance name
        Value:
          Fn::GetAtt:
            - Instance
            - InstanceName
      HttpInternalEndpoint:
        Description: The internal HTTP endpoint for the Message Queue for Apache RocketMQ instance.
        Value:
          Fn::GetAtt:
            - Instance
            - HttpInternalEndpoint
      InstanceId:
        Description: Instance ID created
        Value:
          Fn::GetAtt:
            - Instance
            - InstanceId
      TcpEndpoint:
        Description: The TCP endpoint for the Message Queue for Apache RocketMQ instance.
        Value:
          Fn::GetAtt:
            - Instance
            - TcpEndpoint
      HttpInternetEndpoint:
        Description: The Internet HTTP endpoint for the Message Queue for Apache RocketMQ instance.
        Value:
          Fn::GetAtt:
            - Instance
            - HttpInternetEndpoint
      InstanceType:
        Description: Instance Type
        Value:
          Fn::GetAtt:
            - Instance
            - InstanceType
      HttpInternetSecureEndpoint:
        Description: The Internet HTTPS endpoint for the Message Queue for Apache RocketMQ instance.
        Value:
          Fn::GetAtt:
            - Instance
            - HttpInternetSecureEndpoint
  • JSONformat

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "Instance": {
          "Type": "ALIYUN::ROCKETMQ::Instance",
          "Properties": {
            "InstanceName": "TestRocketMQ"
          }
        }
      },
      "Outputs": {
        "InstanceName": {
          "Description": "Instance name",
          "Value": {
            "Fn::GetAtt": [
              "Instance",
              "InstanceName"
            ]
          }
        },
        "HttpInternalEndpoint": {
          "Description": "The internal HTTP endpoint for the Message Queue for Apache RocketMQ instance.",
          "Value": {
            "Fn::GetAtt": [
              "Instance",
              "HttpInternalEndpoint"
            ]
          }
        },
        "InstanceId": {
          "Description": "Instance ID created",
          "Value": {
            "Fn::GetAtt": [
              "Instance",
              "InstanceId"
            ]
          }
        },
        "TcpEndpoint": {
          "Description": "The TCP endpoint for the Message Queue for Apache RocketMQ instance.",
          "Value": {
            "Fn::GetAtt": [
              "Instance",
              "TcpEndpoint"
            ]
          }
        },
        "HttpInternetEndpoint": {
          "Description": "The Internet HTTP endpoint for the Message Queue for Apache RocketMQ instance.",
          "Value": {
            "Fn::GetAtt": [
              "Instance",
              "HttpInternetEndpoint"
            ]
          }
        },
        "InstanceType": {
          "Description": "Instance Type",
          "Value": {
            "Fn::GetAtt": [
              "Instance",
              "InstanceType"
            ]
          }
        },
        "HttpInternetSecureEndpoint": {
          "Description": "The Internet HTTPS endpoint for the Message Queue for Apache RocketMQ instance.",
          "Value": {
            "Fn::GetAtt": [
              "Instance",
              "HttpInternetSecureEndpoint"
            ]
          }
        }
      }
    }

For more examples, visit ROCKETMQ.json and ROCKETMQ.yml. In the examples, the ALIYUN::ROCKETMQ::Instance, ALIYUN::ROCKETMQ::Group, and ALIYUN::ROCKETMQ::Topic resource types are involved.