ALIYUN::ROCKETMQ::Group

Syntax

{
  "Type": "ALIYUN::ROCKETMQ::Group",
  "Properties": {
    "InstanceId": String,
    "GroupType": String,
    "Remark": String,
    "GroupId": String
  }
}

Properties

Property	Type	Required	Update allowed	Description	Constraints
InstanceId	String	Yes	No	The ID of the instance to which the Group ID belongs.	None
GroupType	String	No	No	The protocol for the Group ID.	Valid values: tcp (default): Applies to TCP messaging only. http: Applies to HTTP messaging only.
Remark	String	No	No	Notes	None
GroupId	String	Yes	No	The Group ID of the consumer group to create.	Must start with `GID_` or `GID-`. Can contain only letters, digits, hyphens (-), and underscores (_). Length: 5 to 64 characters.

Return values

Fn::GetAtt

GroupType: The protocol of the group.
InstanceId: The ID of the instance.
GroupId: The group ID.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  Group:
    Type: ALIYUN::ROCKETMQ::Group
    Properties:
      InstanceId:
        Ref: InstanceId
      GroupId:
        Ref: GroupId
Parameters:
  InstanceId:
    Type: String
    Description: The ID of the instance.
  GroupId:
    MinLength: 7
    Type: String
    Description: |-
      The group ID of the consumption cluster. When creating a group ID, pay attention to the following aspects:
      A group ID starts with"GID_" or "GID-", and contains letters, numbers, hyphens (-), and underscores (_).
      A group ID ranges from 7 to 64 bytes.
      Once a group ID is created, it cannot be edited anymore.
    MaxLength: 64
Outputs:
  GroupType:
    Description: Group Type
    Value:
      Fn::GetAtt:
        - Group
        - GroupType
  InstanceId:
    Description: Instance ID
    Value:
      Fn::GetAtt:
        - Group
        - InstanceId
  GroupId:
    Description: Group ID
    Value:
      Fn::GetAtt:
        - Group
        - GroupId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Group": {
      "Type": "ALIYUN::ROCKETMQ::Group",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "GroupId": {
          "Ref": "GroupId"
        }
      }
    }
  },
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": "The ID of the instance."
    },
    "GroupId": {
      "MinLength": 7,
      "Type": "String",
      "Description": "The group ID of the consumption cluster. When creating a group ID, pay attention to the following aspects:\nA group ID starts with\"GID_\" or \"GID-\", and contains letters, numbers, hyphens (-), and underscores (_).\nA group ID ranges from 7 to 64 bytes.\nOnce a group ID is created, it cannot be edited anymore.",
      "MaxLength": 64
    }
  },
  "Outputs": {
    "GroupType": {
      "Description": "Group Type",
      "Value": {
        "Fn::GetAtt": [
          "Group",
          "GroupType"
        ]
      }
    },
    "InstanceId": {
      "Description": "Instance ID",
      "Value": {
        "Fn::GetAtt": [
          "Group",
          "InstanceId"
        ]
      }
    },
    "GroupId": {
      "Description": "Group ID",
      "Value": {
        "Fn::GetAtt": [
          "Group",
          "GroupId"
        ]
      }
    }
  }
}