ALIYUN::KAFKA::ConsumerGroup - Resource Orchestration Service - Alibaba Cloud ドキュメントセンター

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

構文

{
  "Type": "ALIYUN::KAFKA::ConsumerGroup",
  "Properties": {
    "InstanceId": String,
    "ConsumerId": String,
    "Tags": List,
    "Remark": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
InstanceId	String	はい	いいえ	ApsaraMQ for Kafka インスタンスの ID。	なし。
ConsumerId	String	はい	いいえ	コンシューマーグループの名前。	有効な値: 名前には、英字、数字、ハイフン（-）、アンダースコア（_）のみを含めることができ、少なくとも 1 つの英字または数字を含める必要があります。名前は 3 ～ 128 文字である必要があります。長すぎる値は自動的に 128 文字に切り詰められます。コンシューマーグループを作成した後、コンシューマーグループの名前を変更することはできません。
Tags	List	いいえ	はい	タグ。	1 ～ 20 個のタグを指定できます。詳細については、「タグのプロパティ」をご参照ください。
Remark	String	いいえ	いいえ	コンシューマーグループの説明。	なし。

タグの構文

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Value	String	いいえ	いいえ	リソースのタグ値。	このプロパティは空のままにすることができます。タグ値は最大 128 文字で、`acs:` または `aliyun` で始めることはできません。タグ値には、`http://` または `https://` を含めることはできません。
Key	String	はい	いいえ	リソースのタグキー。	このプロパティを空にすることはできません。タグキーは 1 ～ 128 文字で、`acs:` または `aliyun` で始めることはできません。タグキーには、`http://` または `https://` を含めることはできません。

戻り値

Fn::GetAtt

ConsumerId: コンシューマーグループの ID。

例

YAML フォーマット

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ConsumerId:
    Description:
      ja: 'グループ名。値：
        英字、数字、ダッシュ（-）、アンダースコア（_）のみを含めることができ、少なくとも1つの英数字を含める必要があります。
        長さは3〜128文字に制限されており、128文字を超える場合は自動的に切り捨てられます。
        グループ名を作成したら、変更することはできません。'
    Type: String
  InstanceId:
    Description:
      ja: Kafka インスタンス ID。
    Type: String
  Remark:
    Description:
      ja: 説明の備考。
    Type: String
Resources:
  ConsumerGroup:
    Properties:
      ConsumerId:
        Ref: ConsumerId
      InstanceId:
        Ref: InstanceId
      Remark:
        Ref: Remark
    Type: ALIYUN::KAFKA::ConsumerGroup
Outputs:
  ConsumerId:
    Description: コンシューマーグループ ID
    Value:
      Fn::GetAtt:
      - ConsumerGroup
      - ConsumerId

JSON フォーマット

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "ja": "Kafka インスタンス ID。"
      }
    },
    "ConsumerId": {
      "Type": "String",
      "Description": {
        "ja": "グループ名。値：\n英字、数字、ダッシュ（-）、アンダースコア（_）のみを含めることができ、少なくとも1つの英数字を含める必要があります。\n長さは3〜128文字に制限されており、128文字を超える場合は自動的に切り捨てられます。\nグループ名を作成したら、変更することはできません。"
      }
    },
    "Remark": {
      "Type": "String",
      "Description": {
        "ja": "説明の備考。"
      }
    }
  },
  "Resources": {
    "ConsumerGroup": {
      "Type": "ALIYUN::KAFKA::ConsumerGroup",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "ConsumerId": {
          "Ref": "ConsumerId"
        },
        "Remark": {
          "Ref": "Remark"
        }
      }
    }
  },
  "Outputs": {
    "ConsumerId": {
      "Description": "コンシューマーグループ ID",
      "Value": {
        "Fn::GetAtt": [
          "ConsumerGroup",
          "ConsumerId"
        ]
      }
    }
  }
}