DATASOURCE::KAFKA::Instance ROS スタック自動化リファレンス - Resource Orchestration Service

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

構文

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

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

InstanceId

String

はい

インスタンス ID。

なし。

RefreshOptions

String

いいえ

はい

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

有効な値:

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

戻り値

Fn::GetAtt

DeployType: デプロイメントタイプ。
ResourceGroupId: リソースグループ ID。
SpecType: インスタンスのエディション。
IoMax: ピークトラフィック。
AllConfig: デプロイされたインスタンスの構成。
EndPoint: IP アドレスモードのデフォルトエンドポイント。
SaslDomainEndpoint: ドメイン名モードの簡易認証およびセキュリティ層 ( SASL ) エンドポイント。
DiskType: ディスクタイプ。
SslDomainEndpoint: ドメイン名モードの SSL エンドポイント。
AllowedList: IP アドレスホワイトリスト。
MsgRetain: メッセージの保存期間。
ExpiredTime: 有効期限。
DiskSize: ディスクサイズ。
PaymentType: インスタンスの課金方法。
TopicNumLimit: トピックの最大数。
Tags: タグ。
SslEndPoint: IP アドレスモードの SSL エンドポイント。
EipMax: ピークインターネットトラフィック。
ZoneId: ゾーン ID。
InstanceId: インスタンス ID。
VSwitchId: vSwitch ID。
CreateTime: インスタンスの作成時間。
InstanceName: インスタンス名。
VpcId: 仮想プライベートクラウド ( VPC ) の ID。
DomainEndpoint: ドメイン名モードのデフォルトエンドポイント。
IoMaxSpec: トラフィック仕様。
ServiceVersion: デプロイされたインスタンスのバージョン。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description:
      en: The ID of the instance.
      ja: インスタンスの ID。
    Required: true
    AssociationProperty: ALIYUN::Kafka::Instance::InstanceId
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::KAFKA::Instance
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  DeployType:
    Description: デプロイ方法。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeployType
  ResourceGroupId:
    Description: リソースグループの ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  SpecType:
    Description: インスタンスタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SpecType
  IoMax:
    Description: ピークフロー。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IoMax
  AllConfig:
    Description: デプロイされたメッセージキュー Kafka バージョンの現在の構成。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AllConfig
  EndPoint:
    Description: アクセスポイント。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EndPoint
  SaslDomainEndpoint:
    Description: SASL アクセスポイントのドメイン名アクセスポイント。Kafka インスタンスは、ドメイン名アクセスポイントと IP アクセスポイントをサポートしています。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SaslDomainEndpoint
  DiskType:
    Description: ディスクタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskType
  SslDomainEndpoint:
    Description: SSL アクセスポイントのドメイン名。Kafka インスタンスは、ドメイン名アクセスポイントと IP アクセスポイントをサポートしています。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SslDomainEndpoint
  AllowedList:
    Description: ホワイトリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AllowedList
  MsgRetain:
    Description: メッセージ保存時間。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MsgRetain
  ExpiredTime:
    Description: 有効期限。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpiredTime
  DiskSize:
    Description: ディスクサイズ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskSize
  PaymentType:
    Description: リソースの支払いタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  TopicNumLimit:
    Description: トピック作成の最大数。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TopicNumLimit
  Tags:
    Description: kafka コンソールのタグ。インスタンス、トピック、および消費をグループ化するために使用されます。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  SslEndPoint:
    Description: 外部アクセスポイント。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SslEndPoint
  EipMax:
    Description: パブリックネットワークのピークトラフィック。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EipMax
  ZoneId:
    Description: インスタンスがデプロイされているゾーンの ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneId
  InstanceId:
    Description: インスタンスの ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceId
  VSwitchId:
    Description: スイッチ ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VSwitchId
  CreateTime:
    Description: 作成時間。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  InstanceName:
    Description: ノート名。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceName
  VpcId:
    Description: VpcId。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcId
  DomainEndpoint:
    Description: デフォルトアクセスポイントのドメイン名アクセスポイント。Kafka インスタンスは、ドメイン名アクセスポイントと IP アクセスポイントをサポートしています。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainEndpoint
  IoMaxSpec:
    Description: フロー仕様 (推奨)。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IoMaxSpec
  ServiceVersion:
    Description: デプロイされたメッセージキューの Kafka バージョンのバージョン。値は 0.10.2 または 2.2.0 です。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceVersion

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the instance.",
        "ja": "インスタンスの ID。"
      },
      "Required": true,
      "AssociationProperty": "ALIYUN::Kafka::Instance::InstanceId"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::KAFKA::Instance",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DeployType": {
      "Description": "デプロイ方法。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeployType"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "リソースグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "SpecType": {
      "Description": "インスタンスタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SpecType"
        ]
      }
    },
    "IoMax": {
      "Description": "ピークフロー。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IoMax"
        ]
      }
    },
    "AllConfig": {
      "Description": "デプロイされたメッセージキュー Kafka バージョンの現在の構成。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AllConfig"
        ]
      }
    },
    "EndPoint": {
      "Description": "アクセスポイント。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EndPoint"
        ]
      }
    },
    "SaslDomainEndpoint": {
      "Description": "SASL アクセスポイントのドメイン名アクセスポイント。Kafka インスタンスは、ドメイン名アクセスポイントと IP アクセスポイントをサポートしています。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SaslDomainEndpoint"
        ]
      }
    },
    "DiskType": {
      "Description": "ディスクタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskType"
        ]
      }
    },
    "SslDomainEndpoint": {
      "Description": "SSL アクセスポイントのドメイン名。Kafka インスタンスは、ドメイン名アクセスポイントと IP アクセスポイントをサポートしています。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SslDomainEndpoint"
        ]
      }
    },
    "AllowedList": {
      "Description": "ホワイトリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AllowedList"
        ]
      }
    },
    "MsgRetain": {
      "Description": "メッセージ保存時間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MsgRetain"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "有効期限。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "DiskSize": {
      "Description": "ディスクサイズ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskSize"
        ]
      }
    },
    "PaymentType": {
      "Description": "リソースの支払いタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "TopicNumLimit": {
      "Description": "トピック作成の最大数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TopicNumLimit"
        ]
      }
    },
    "Tags": {
      "Description": "kafka コンソールのタグ。インスタンス、トピック、および消費をグループ化するために使用されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "SslEndPoint": {
      "Description": "外部アクセスポイント。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SslEndPoint"
        ]
      }
    },
    "EipMax": {
      "Description": "パブリックネットワークのピークトラフィック。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EipMax"
        ]
      }
    },
    "ZoneId": {
      "Description": "インスタンスがデプロイされているゾーンの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "InstanceId": {
      "Description": "インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "スイッチ ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "CreateTime": {
      "Description": "作成時間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "InstanceName": {
      "Description": "ノート名。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceName"
        ]
      }
    },
    "VpcId": {
      "Description": "VpcId。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "DomainEndpoint": {
      "Description": "デフォルトアクセスポイントのドメイン名アクセスポイント。Kafka インスタンスは、ドメイン名アクセスポイントと IP アクセスポイントをサポートしています。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainEndpoint"
        ]
      }
    },
    "IoMaxSpec": {
      "Description": "フロー仕様 (推奨)。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IoMaxSpec"
        ]
      }
    },
    "ServiceVersion": {
      "Description": "デプロイされたメッセージキューの Kafka バージョンのバージョン。値は 0.10.2 または 2.2.0 です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceVersion"
        ]
      }
    }
  }
}