RocketMQ 用 ApsaraMQ の ALIYUN::ROCKETMQ5::ConsumerGroup の使用方法 - Resource Orchestration Service

ALIYUN::ROCKETMQ5::ConsumerGroup は、RocketMQ 5.0 用 ApsaraMQ でコンシューマーグループを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ROCKETMQ5::ConsumerGroup",
  "Properties": {
    "ConsumerGroupId": String, // コンシューマーグループID
    "InstanceId": String, // インスタンスID
    "ConsumeRetryPolicy": Map, // 消費再試行ポリシー
    "DeliveryOrderType": String, // 配信順序タイプ
    "Remark": String // 備考
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ConsumerGroupId	String	はい	いいえ	コンシューマーグループの ID。	ID はグローバルに一意であり、コンシューマーグループを識別するために使用されます。 ID には以下の制限が適用されます。文字制限: ID には、文字、数字、アンダースコア (_)、ハイフン (-)、パーセント記号 (%) を使用できます。長さ制限: ID は 1 ～ 60 文字の長さでなければなりません。
InstanceId	String	はい	いいえ	コンシューマーグループを作成するインスタンスの ID。	なし。
ConsumeRetryPolicy	Map	はい	はい	コンシューマーグループの消費再試行ポリシー。	なし。
DeliveryOrderType	String	はい	はい	コンシューマーグループの配信順序タイプ。	有効な値: Concurrently: 同時。 Orderly: 順序付き。
Remark	String	いいえ	はい	コンシューマーグループに関する備考。	なし。

ConsumeRetryPolicy 構文

"ConsumeRetryPolicy": {
  "RetryPolicy": String, // 再試行ポリシーのタイプ
  "MaxRetryTimes": Integer, // 最大再試行回数
  "DeadLetterTargetTopic": String // デッドレターキューのトピック
}

ConsumeRetryPolicy プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
RetryPolicy	String	はい	はい	再試行ポリシーのタイプ。	有効な値: FixedRetryPolicy: システムは固定間隔で再試行ポリシーを実装します。 DefaultRetryPolicy: システムは増加間隔で再試行ポリシーを実装します。
MaxRetryTimes	Integer	いいえ	はい	最大再試行回数。	なし。
DeadLetterTargetTopic	String	いいえ	はい	デッドレタートピック。	メッセージに指定された最大再試行回数に達した後もコンシューマーがメッセージを消費できない場合、メッセージはデッドレタートピックに配信され、後続のビジネスリカバリまたはトラブルシューティングに使用されます。詳細については、「消費再試行」をご参照ください。

戻り値

Fn::GetAtt

ConsumerGroupId: コンシューマーグループの ID。
InstanceId: コンシューマーグループが作成されるインスタンスの ID。
DeliveryOrderType: コンシューマーグループの配信順序タイプ。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ConsumerGroupId:
    Type: String
    Description: |-
      作成されるコンシューマーグループの ID。コンシューマーグループを識別するために使用され、グローバルに一意です。
      値の説明は次のとおりです。
      文字制限: 文字 a～z または A～Z、数字 0～9、アンダースコア (_)、ダッシュ (-)、パーセント記号 (%) がサポートされています。
      長さ制限: 1～60 文字。
    MinLength: 1
    MaxLength: 60
  InstanceId:
    Type: String
    Description: インスタンスの ID。
Resources:
  ConsumerGroup:
    Type: ALIYUN::ROCKETMQ5::ConsumerGroup
    Properties:
      ConsumerGroupId:
        Ref: ConsumerGroupId
      InstanceId:
        Ref: InstanceId
      ConsumeRetryPolicy:
        RetryPolicy: DefaultRetryPolicy
        MaxRetryTimes: 5
      DeliveryOrderType: Concurrently
Outputs:
  ConsumerGroupId:
    Description: コンシューマーグループの ID。
    Value:
      Fn::GetAtt:
        - ConsumerGroup
        - ConsumerGroupId
  InstanceId:
    Description: インスタンスの ID。
    Value:
      Fn::GetAtt:
        - ConsumerGroup
        - InstanceId
  DeliveryOrderType:
    Description: コンシューマーグループの配信順序。
    Value:
      Fn::GetAtt:
        - ConsumerGroup
        - DeliveryOrderType

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ConsumerGroupId": {
      "Type": "String",
      "Description": "作成されるコンシューマーグループの ID。コンシューマーグループを識別するために使用され、グローバルに一意です。\n値の説明は次のとおりです。\n文字制限: 文字 a～z または A～Z、数字 0～9、アンダースコア (_)、ダッシュ (-)、パーセント記号 (%) がサポートされています。\n長さ制限: 1～60 文字。",
      "MinLength": 1,
      "MaxLength": 60
    },
    "InstanceId": {
      "Type": "String",
      "Description": "インスタンスの ID。"
    }
  },
  "Resources": {
    "ConsumerGroup": {
      "Type": "ALIYUN::ROCKETMQ5::ConsumerGroup",
      "Properties": {
        "ConsumerGroupId": {
          "Ref": "ConsumerGroupId"
        },
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "ConsumeRetryPolicy": {
          "RetryPolicy": "DefaultRetryPolicy", // デフォルトの再試行ポリシー
          "MaxRetryTimes": 5 // 最大再試行回数 5
        },
        "DeliveryOrderType": "Concurrently" // 同時配信
      }
    }
  },
  "Outputs": {
    "ConsumerGroupId": {
      "Description": "コンシューマーグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ConsumerGroup",
          "ConsumerGroupId"
        ]
      }
    },
    "InstanceId": {
      "Description": "インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ConsumerGroup",
          "InstanceId"
        ]
      }
    },
    "DeliveryOrderType": {
      "Description": "コンシューマーグループの配信順序。",
      "Value": {
        "Fn::GetAtt": [
          "ConsumerGroup",
          "DeliveryOrderType"
        ]
      }
    }
  }
}