Resource Orchestration Service の DATASOURCE::ROCKETMQ5::ConsumerGroups 概要 - ROS

DATASOURCE::ROCKETMQ5::ConsumerGroups は、ApsaraMQ for RocketMQ 5.0 のコンシューマーグループをクエリするために使用されます。

構文

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

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

InstanceId

String

はい

コンシューマーグループが属するインスタンスの ID。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースのリフレッシュポリシー。

有効な値:

Never（デフォルト）: スタックの更新時にデータソースリソースをリフレッシュしません。
Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

ConsumerGroups: コンシューマーグループのリスト。
ConsumerGroupIds: コンシューマーグループの ID。

プロパティ	タイプ	説明	制約
ConsumerGroupIds	List	なし。	なし。
ConsumerGroups	List	なし。	なし。
UpdateTime	String	コンシューマーグループが最後に更新された時間。	なし。
RegionId	String	インスタンスのリージョン ID。	なし。
CreateTime	String	コンシューマーグループが作成された時間。	なし。
ConsumerGroupId	String	コンシューマーグループの ID。	なし。
Status	String	コンシューマーグループのステータス。	なし。
InstanceId	String	インスタンスの ID。	なし。
Remark	String	コンシューマーグループの説明。	なし。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Description:
      en: Instance ID.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      InstanceId:
        Ref: InstanceId
    Type: DATASOURCE::ROCKETMQ5::ConsumerGroups
Outputs:
  ConsumerGroupIds:
    Description: The list of consumer group IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ConsumerGroupIds
  ConsumerGroups:
    Description: The list of consumer groups.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ConsumerGroups

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "Instance ID."
      }
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ROCKETMQ5::ConsumerGroups",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "ConsumerGroups": {
      "Description": "コンシューマーグループのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConsumerGroups"
        ]
      }
    },
    "ConsumerGroupIds": {
      "Description": "コンシューマーグループ ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConsumerGroupIds"
        ]
      }
    }
  }
}