DATASOURCE::KAFKA::Instance_资源编排(ROS)-阿里云帮助中心

DATASOURCE::KAFKA::Instance类型用于查询单个Kafka实例信息。

语法

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

属性

属性名称

类型

必须

允许更新

描述

约束

InstanceId

String

是

Kafka实例 ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

DeployType：部署类型。
ResourceGroupId：资源组 ID。
SpecType：实例规格。
IoMax：流量峰值。
AllConfig：部署的云消息队列 Kafka 版的当前配置。
EndPoint：默认接入点的 IP 接入点。
SaslDomainEndpoint：SASL 接入点的域名接入点。
DiskType：磁盘类型。
SslDomainEndpoint：SSL 接入点的域名接入点。
AllowedList：白名单列表。
MsgRetain：消息保留时长。
ExpiredTime：到期时间。
DiskSize：磁盘容量。
PaymentType：资源的付费类型。
TopicNumLimit：Topic 最大数量。
Tags：标签列表。
SslEndPoint：SSL 接入点的 IP 接入点。
EipMax：公网流量峰值。
ZoneId：可用区 ID。
InstanceId：Kafka实例 ID。
VSwitchId：虚拟交换机ID。
CreateTime：实例创建时间。
InstanceName：实例名称。
VpcId：专有网络ID。
DomainEndpoint：默认接入点的域名接入点。
IoMaxSpec：流量规格。
ServiceVersion：已部署消息队列的Kafka版本。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description:
      en: The ID of the instance.
    Required: true
    AssociationProperty: ALIYUN::Kafka::Instance::InstanceId
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::KAFKA::Instance
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  DeployType:
    Description: Deployment method.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeployType
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  SpecType:
    Description: Instance type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SpecType
  IoMax:
    Description: Peak flow.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IoMax
  AllConfig:
    Description: The current configuration of the deployed message queue Kafka version.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AllConfig
  EndPoint:
    Description: Access point.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EndPoint
  SaslDomainEndpoint:
    Description: The domain name access point of the SASL access point. The Kafka instance supports domain name access points and IP access points.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SaslDomainEndpoint
  DiskType:
    Description: Disk type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskType
  SslDomainEndpoint:
    Description: The domain name of the SSL access point. The Kafka instance supports domain name access points and IP access points.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SslDomainEndpoint
  AllowedList:
    Description: White list.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AllowedList
  MsgRetain:
    Description: Message save time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MsgRetain
  ExpiredTime:
    Description: Expiration time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpiredTime
  DiskSize:
    Description: Disk size.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskSize
  PaymentType:
    Description: The paymen type of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  TopicNumLimit:
    Description: Maximum number of topic creation.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TopicNumLimit
  Tags:
    Description: The tag of the kafka console, which is used to group instance,topic, and consumption.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  SslEndPoint:
    Description: External access point.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SslEndPoint
  EipMax:
    Description: Peak public network traffic.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EipMax
  ZoneId:
    Description: The ID of the zone in which the instance is deployed.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneId
  InstanceId:
    Description: The ID of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceId
  VSwitchId:
    Description: Switch id.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VSwitchId
  CreateTime:
    Description: Creation time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  InstanceName:
    Description: Note name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceName
  VpcId:
    Description: VpcId.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcId
  DomainEndpoint:
    Description: The domain name access point of the default access point. The Kafka instance supports domain name access points and IP access points.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainEndpoint
  IoMaxSpec:
    Description: Flow specifications (recommended).
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IoMaxSpec
  ServiceVersion:
    Description: The version of the Kafka version of the deployed Message Queue. The value is 0.10.2 or 2.2.0.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceVersion

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the instance."
      },
      "Required": true,
      "AssociationProperty": "ALIYUN::Kafka::Instance::InstanceId"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::KAFKA::Instance",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DeployType": {
      "Description": "Deployment method.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeployType"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "SpecType": {
      "Description": "Instance type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SpecType"
        ]
      }
    },
    "IoMax": {
      "Description": "Peak flow.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IoMax"
        ]
      }
    },
    "AllConfig": {
      "Description": "The current configuration of the deployed message queue Kafka version.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AllConfig"
        ]
      }
    },
    "EndPoint": {
      "Description": "Access point.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EndPoint"
        ]
      }
    },
    "SaslDomainEndpoint": {
      "Description": "The domain name access point of the SASL access point. The Kafka instance supports domain name access points and IP access points.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SaslDomainEndpoint"
        ]
      }
    },
    "DiskType": {
      "Description": "Disk type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskType"
        ]
      }
    },
    "SslDomainEndpoint": {
      "Description": "The domain name of the SSL access point. The Kafka instance supports domain name access points and IP access points.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SslDomainEndpoint"
        ]
      }
    },
    "AllowedList": {
      "Description": "White list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AllowedList"
        ]
      }
    },
    "MsgRetain": {
      "Description": "Message save time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MsgRetain"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "Expiration time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "DiskSize": {
      "Description": "Disk size.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskSize"
        ]
      }
    },
    "PaymentType": {
      "Description": "The paymen type of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "TopicNumLimit": {
      "Description": "Maximum number of topic creation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TopicNumLimit"
        ]
      }
    },
    "Tags": {
      "Description": "The tag of the kafka console, which is used to group instance,topic, and consumption.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "SslEndPoint": {
      "Description": "External access point.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SslEndPoint"
        ]
      }
    },
    "EipMax": {
      "Description": "Peak public network traffic.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EipMax"
        ]
      }
    },
    "ZoneId": {
      "Description": "The ID of the zone in which the instance is deployed.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "InstanceId": {
      "Description": "The ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "Switch id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "CreateTime": {
      "Description": "Creation time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "InstanceName": {
      "Description": "Note name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceName"
        ]
      }
    },
    "VpcId": {
      "Description": "VpcId.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "DomainEndpoint": {
      "Description": "The domain name access point of the default access point. The Kafka instance supports domain name access points and IP access points.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainEndpoint"
        ]
      }
    },
    "IoMaxSpec": {
      "Description": "Flow specifications (recommended).",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IoMaxSpec"
        ]
      }
    },
    "ServiceVersion": {
      "Description": "The version of the Kafka version of the deployed Message Queue. The value is 0.10.2 or 2.2.0.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceVersion"
        ]
      }
    }
  }
}