Queries the list of groups in ApsaraMQ for RocketMQ.
Syntax
{
"Type": "DATASOURCE::ROCKETMQ::Groups",
"Properties": {
"GroupName": String,
"GroupType": String,
"InstanceId": String,
"RefreshOptions": String
}
}
Properties
|
Property |
Type |
Required |
Editable |
Description |
Constraint |
|
GroupName |
String |
No |
Yes |
The group ID. |
None. |
|
GroupType |
String |
No |
Yes |
The messaging protocol used by the group. |
Valid values:
|
|
InstanceId |
String |
No |
Yes |
The instance ID of the ApsaraMQ for RocketMQ instance to which the group belongs. |
None. |
|
RefreshOptions |
String |
No |
Yes |
The refresh strategy for data source resources when the stack is updated. |
Valid values:
|
Return values
Fn::GetAtt
-
GroupNames: the IDs of the groups.
-
Groups: details of the groups.
|
Property |
Type |
Description |
Constraint |
|
GroupNames |
List |
The IDs of the groups. |
None. |
|
Groups |
List |
Details of the groups. |
None. |
|
GroupType |
string |
The messaging protocol used by the group. |
Valid values:
|
|
Remark |
string |
The remarks. |
None. |
|
Tags |
Map |
The tags added to the group. |
Example:
|
|
InstanceId |
string |
The instance ID. |
None. |
|
GroupName |
string |
The ID of the consumer group. |
None. |
|
IndependentNaming |
boolean |
Indicates whether the instance uses a separate namespace. |
Valid values:
|
|
Owner |
string |
The owner of the group. |
None. |
|
CreateTime |
string |
The time when the group was created. |
None. |
Examples
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{
"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"
]
}
}
}
}