DATASOURCE::KAFKA::Topics を使用したトピック情報のクエリ - ROS

DATASOURCE::KAFKA::トピックは、トピックに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::KAFKA::Topics",
  "Properties": {
    "InstanceId": String,
    "Topic": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	型	必須	編集可能	説明	制約
InstanceId	String	はい	はい	トピックが属するインスタンスの ID。	なし。
Topic	String	はい	はい	トピック名。	なし。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースのリフレッシュポリシー。	有効な値: Never（デフォルト）: スタックが更新されたときにデータソースリソースをリフレッシュしません。 Always: スタックが更新されたときにデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

Topics: トピックの詳細。

プロパティ	型	説明	制約
Topics	List	トピックの詳細。	なし。
Topic	String	トピック名。	なし。
PartitionNum	Number	トピックのパーティション数。	なし。
Tags	String	タグ。	なし。
StatusName	String	トピックの状態。	なし。
InstanceId	String	トピックが属するインスタンスの ID。	なし。
Remark	String	備考。	なし。
CompactTopic	String	トピックが使用するログクリーンアップポリシー。このプロパティは、LocalTopic が true に設定されている場合に返されます。	なし。
CreateTime	String	トピックが作成された日時を示すタイムスタンプ。単位: ミリ秒。	なし。
QuotaData	String	クォータデータ。	なし。
LocalTopic	String	トピックのストレージタイプ。	なし。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Description:
      en: Resource id.
    Required: true
    Type: String
  Topic:
    Description:
      en: Topic Name.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      InstanceId:
        Ref: InstanceId
      Topic:
        Ref: Topic
    Type: DATASOURCE::KAFKA::Topics
Outputs:
  Topics:
    Description: The list of topics.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Topics

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "リソース ID。"
      },
      "Required": true
    },
    "Topic": {
      "Type": "String",
      "Description": {
        "en": "トピック名。"
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::KAFKA::Topics",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "Topic": {
          "Ref": "Topic"
        }
      }
    }
  },
  "Outputs": {
    "Topics": {
      "Description": "トピックのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Topics"
        ]
      }
    }
  }
}