DATASOURCE::ROCKETMQ5::ConsumerGroup_资源编排(ROS)-阿里云帮助中心

DATASOURCE::ROCKETMQ5::ConsumerGroup类型用于查询ROCKETMQ5.0系列的消费者分组详情。

语法

{
  "Type": "DATASOURCE::ROCKETMQ5::ConsumerGroup",
  "Properties": {
    "ConsumerGroupId": String,
    "InstanceId": String,
    "RefreshOptions": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
ConsumerGroupId	String	是	是	消费者分组ID。	无
InstanceId	String	是	是	指定需要获取哪个实例下的消费者分组列表。	无
RefreshOptions	String	否	是	当资源栈更新时，数据源资源的刷新策略。	有效值： Never（默认值）：更新堆栈时，从不刷新数据源资源。 Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

Status：消费者分组的状态。
ConsumerGroupId：消费者分组ID。
InstanceId：实例ID。
ConsumeRetryPolicy：消费者分组的消费重试策略。
CreateTime：消费者分组的创建时间。
UpdateTime：消费者分组的最后更新时间。
DeliveryOrderType：消费者分组的投递顺序性。
Remark：消费者分组的备注信息。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ConsumerGroupId:
    Type: String
    Description:
      en: The ID of the consumer group.
    Required: true
  InstanceId:
    Type: String
    Description:
      en: The ID of the instance to which the consumer group belongs.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ROCKETMQ5::ConsumerGroup
    Properties:
      ConsumerGroupId:
        Ref: ConsumerGroupId
      InstanceId:
        Ref: InstanceId
Outputs:
  Status:
    Description: The state of the consumer group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Status
  ConsumerGroupId:
    Description: The ID of the consumer group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ConsumerGroupId
  InstanceId:
    Description: The ID of the RocketMQ instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceId
  ConsumeRetryPolicy:
    Description: 'The consumption retry policy that you want to configure for the consumer group. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ConsumeRetryPolicy
  CreateTime:
    Description: The time when the consumer group was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  UpdateTime:
    Description: The time when the consumer group was last updated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdateTime
  DeliveryOrderType:
    Description: The message delivery order of the consumer group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeliveryOrderType
  Remark:
    Description: The remarks on the consumer group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Remark

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ConsumerGroupId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the consumer group."
      },
      "Required": true
    },
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the instance to which the consumer group belongs."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ROCKETMQ5::ConsumerGroup",
      "Properties": {
        "ConsumerGroupId": {
          "Ref": "ConsumerGroupId"
        },
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "Status": {
      "Description": "The state of the consumer group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Status"
        ]
      }
    },
    "ConsumerGroupId": {
      "Description": "The ID of the consumer group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConsumerGroupId"
        ]
      }
    },
    "InstanceId": {
      "Description": "The ID of the RocketMQ instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "ConsumeRetryPolicy": {
      "Description": "The consumption retry policy that you want to configure for the consumer group. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConsumeRetryPolicy"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the consumer group was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "UpdateTime": {
      "Description": "The time when the consumer group was last updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdateTime"
        ]
      }
    },
    "DeliveryOrderType": {
      "Description": "The message delivery order of the consumer group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeliveryOrderType"
        ]
      }
    },
    "Remark": {
      "Description": "The remarks on the consumer group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Remark"
        ]
      }
    }
  }
}