ROS DATASOURCE による ApsaraMQ for Kafka インスタンス属性 - ROS

DATASOURCE::KAFKA::Instances は、ApsaraMQ for Kafka インスタンスに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::KAFKA::Instances",
  "Properties": {
    "ResourceGroupId": String,
    "InstanceId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ResourceGroupId	String	いいえ	はい	リソースグループ ID。	なし。
InstanceId	String	いいえ	はい	インスタンス ID。	なし。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースのリフレッシュポリシー。	有効な値: Never (デフォルト): スタックの更新時にデータソースリソースをリフレッシュしません。 Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

Instances: インスタンスの詳細。
InstanceIds: インスタンスの ID。

プロパティ	タイプ	説明	制約
InstanceIds	List	インスタンスの ID。	なし。
Instances	List	インスタンスの詳細。	なし。
ExpiredTime	Integer	有効期限。	単位: ミリ秒。
SslEndPoint	String	IP アドレスモードのインスタンスの SSL エンドポイント。	なし。
Tags	String	タグ。	なし。
DiskType	Integer	ディスクタイプ。	なし。
RegionId	String	インスタンスのリージョン ID。	なし。
CreateTime	Integer	インスタンスが作成された時間。	単位: ミリ秒。
InstanceId	String	インスタンス ID。	なし。
Status	String	インスタンスの状態。	なし。
ZoneId	String	ゾーン ID。	なし。
DiskSize	Integer	ディスクサイズ。	単位: GB。
DeployType	Integer	デプロイメントタイプ。	なし。
DomainEndpoint	String	ドメイン名モードのインスタンスのデフォルトエンドポイント。	なし。
InstanceName	String	インスタンス名。	なし。
EndPoint	String	IP アドレスモードのインスタンスのデフォルトエンドポイント。	なし。
IoMax	Integer	インスタンスに許可されるピークトラフィック。	なし。
ResourceGroupId	String	リソースグループ ID。	なし。
VSwitchId	String	vSwitch ID。	なし。
EipMax	Integer	インスタンスに許可されるピークインターネットトラフィック。	なし。
PaymentType	String	課金方法。	なし。
TopicNumLimit	Integer	インスタンスに作成できるトピックの最大数。	なし。
SpecType	String	インスタンスのエディション。	なし。
MsgRetain	Integer	インスタンスのメッセージの保存期間。	単位: 時間。
VpcId	String	VPC（Virtual Private Cloud） ID。	なし。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Description:
      en: The ID of the instance.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      InstanceId:
        Ref: InstanceId
    Type: DATASOURCE::KAFKA::Instances
Outputs:
  InstanceIds:
    Description: The list of instance IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceIds
  Instances:
    Description: The list of instances.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Instances

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the instance."
      }
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::KAFKA::Instances",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "Instances": {
      "Description": "The list of instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Instances"
        ]
      }
    },
    "InstanceIds": {
      "Description": "The list of instance IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceIds"
        ]
      }
    }
  }
}