DATASOURCE::ROCKETMQ::Groups is used to query the groups in Message Queue for Apache RocketMQ.

Syntax

{
  "Type": "DATASOURCE::ROCKETMQ::Groups",
  "Properties": {
    "GroupName": String,
    "GroupType": String,
    "InstanceId": String
  }
}

Properties

PropertyTypeRequiredEditableDescriptionConstraint
GroupNameStringNoYesThe ID of the group. None.
GroupTypeStringNoYesThe protocol over which the group publishes or subscribes to messages. Valid values:
  • tcp: The group publishes or subscribes to messages over TCP.
  • http: The group publishes or subscribes to messages over HTTP.
InstanceIdStringNoYesThe ID of the instance to which the group belongs. None.

Return values

Fn::GetAtt

  • GroupNames: the IDs of the groups.
  • Groups: details of the groups.
PropertyTypeDescriptionConstraint
GroupNamesListThe IDs of the groups. None.
GroupsListDetails of the groups. None.
GroupTypestringThe protocol over which the group publishes or subscribes to messages. Valid values:
  • tcp: The group publishes or subscribes to messages over TCP.
  • http: The group publishes or subscribes to messages over HTTP.
RemarkstringThe description of the group. None.
TagsMapThe tags that are added to the group. Sample value:
[
            {
              "Key": "CartService",
              "Value": "ServiceA"
            }
          ]
InstanceIdstringThe ID of the instance to which the group belongs. None.
GroupNamestringThe ID of the consumer group. None.
IndependentNamingbooleanIndicates whether a separate namespace is configured for the instance. Valid values:
  • true: A separate namespace is configured for the instance. The name of each resource must be unique in the instance. The names of resources in different instances can be the same.
  • false: No separate namespace is configured for the instance. The name of each resource must be globally unique among all instances.
OwnerstringThe Alibaba Cloud account ID of the user who created the group. None.
CreateTimestringThe time when the group was created. None.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      ExtensionDataSource:
        Type: DATASOURCE::ROCKETMQ::Groups
        Properties:
          GroupType: http
    Outputs:
      GroupNames:
        Description: The list of group names.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - GroupNames
      Groups:
        Description: The list of groups.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Groups
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "ExtensionDataSource": {
          "Type": "DATASOURCE::ROCKETMQ::Groups",
          "Properties": {
            "GroupType": "http"
          }
        }
      },
      "Outputs": {
        "GroupNames": {
          "Description": "The list of group names.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "GroupNames"
            ]
          }
        },
        "Groups": {
          "Description": "The list of groups.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Groups"
            ]
          }
        }
      }
    }