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

语法

{
  "Type": "DATASOURCE::ClickHouse::EnterpriseDBCluster",
  "Properties": {
    "DBInstanceId": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

DBInstanceId

String

是

集群ID。

无

RefreshOptions

String

否

是

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

取值：

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

返回值

Fn::GetAtt

NodeScaleMin：Serverless节点自动伸缩的最小数量。
Category：类型，取值说明：enterprise：企业版。
EngineMinorVersion：集群引擎的小版本号。
Description：集群描述。
ResourceGroupId：资源组ID。
InstanceNetworkType：实例的网络类型。
Endpoints：Endpoint详情列表。
MaintainEndTime：维护窗口的结束时间。
ObjectStoreSize：对象存储空间大小。
DBInstanceId：集群ID。
NodeScaleMax：Serverless节点自动伸缩的最大值。
DisabledPorts：禁用的数据库端口。支持多个端口，用逗号（,）分隔。
StorageQuota：预购存储容量（GB）。
ComputingGroupIds：计算组ID列表。
Engine：引擎类型。
Tags：标签详情。
MaintainStartTime：可维护时间的开始时间。
EngineVersion：引擎版本。
StorageType：存储类型。
ZoneId：可用区ID。
NodeCount：节点数量。取值范围为2~16。使用NodeScaleMin和NodeScaleMax配置弹性区间时需要此参数。
CreateTime：集群创建时间。
StorageSize：存储空间大小。单位：GB。
MultiZones：可用区信息。
ScaleMax：弹性伸缩的最大容量。
VswitchId：交换机ID。
Nodes：节点信息。
VpcId：VPC ID。
ChargeType：计费方式。企业版集群使用按量付费计费方式。
ScaleMin：弹性伸缩的最小容量。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description:
      en: The cluster ID.
    Required: true
  RefreshOptions:
    Type: String
    Description:
      en: |-
        The refresh strategy for the datasource resource when the stack is updated. Valid values:
        - Never: Never refresh the datasource resource when the stack is updated.
        - Always: Always refresh the datasource resource when the stack is updated.
        Default is Never.
    AllowedValues:
      - Always
      - Never
    Default: Never
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ClickHouse::EnterpriseDBCluster
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
      RefreshOptions:
        Ref: RefreshOptions
Outputs:
  Category:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Category
    Description: 'Type, value description: enterprise: Enterprise Edition.'
  EngineMinorVersion:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EngineMinorVersion
    Description: The minor version number of the cluster engine.
  NodeScaleMin:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - NodeScaleMin
    Description: Minimum number of Serverless nodes for auto-scaling.
  ObjectStoreSize:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ObjectStoreSize
    Description: The size of the object storage space.
  Nodes:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Nodes
    Description: The Node information.
  Engine:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Engine
    Description: The engine type.
  VpcId:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcId
    Description: The VPC ID.
  NodeScaleMax:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - NodeScaleMax
    Description: The maximum value of serverless node auto scaling.
  Description:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
    Description: The cluster description.
  ResourceGroupId:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
    Description: The ID of the resource group.
  MaintainEndTime:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MaintainEndTime
    Description: The end time of the maintenance window.
  StorageQuota:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - StorageQuota
    Description: Storage Pre-purchased Capacity (GB).
  InstanceNetworkType:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceNetworkType
    Description: The network type of the instance.
  DisabledPorts:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DisabledPorts
    Description: The specified database port is disabled. Multiple ports separated by commas (,) are supported.
  ScaleMax:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ScaleMax
    Description: The maximum capacity for elastic scaling.
  ComputingGroupIds:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ComputingGroupIds
    Description: The list of computing group IDs.
  ZoneId:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneId
    Description: The zone ID.
  EngineVersion:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EngineVersion
    Description: The engine version.
  Endpoints:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Endpoints
    Description: List of Endpoint details.
  StorageType:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - StorageType
    Description: The storage type.
  Tags:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
    Description: The details of the tags.
  DBInstanceId:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstanceId
    Description: The cluster ID.
  MultiZones:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MultiZones
    Description: The information about the zones.
  ChargeType:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ChargeType
    Description: The billing method. Enterprise Edition clusters use the pay-as-you-go billing method.
  NodeCount:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - NodeCount
    Description: The number of nodes. The value range is 2-16. Required when you use NodeScaleMin and NodeScaleMax to configure an elastic interval.
  VswitchId:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VswitchId
    Description: The VSwitch ID.
  ScaleMin:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ScaleMin
    Description: The minimum capacity for elastic scaling.
  StorageSize:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - StorageSize
    Description: 'The size of the storage space. Unit: GB.'
  CreateTime:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
    Description: The creation time of the cluster.
  MaintainStartTime:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MaintainStartTime
    Description: The maintainable time start time.

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": {
        "en": "The cluster ID."
      },
      "Required": true
    },
    "RefreshOptions": {
      "Type": "String",
      "Description": {
        "en": "The refresh strategy for the datasource resource when the stack is updated. Valid values:\n- Never: Never refresh the datasource resource when the stack is updated.\n- Always: Always refresh the datasource resource when the stack is updated.\nDefault is Never."
      },
      "AllowedValues": [
        "Always",
        "Never"
      ],
      "Default": "Never",
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ClickHouse::EnterpriseDBCluster",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "RefreshOptions": {
          "Ref": "RefreshOptions"
        }
      }
    }
  },
  "Outputs": {
    "Category": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Category"
        ]
      },
      "Description": "Type, value description: enterprise: Enterprise Edition."
    },
    "EngineMinorVersion": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EngineMinorVersion"
        ]
      },
      "Description": "The minor version number of the cluster engine."
    },
    "NodeScaleMin": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "NodeScaleMin"
        ]
      },
      "Description": "Minimum number of Serverless nodes for auto-scaling."
    },
    "ObjectStoreSize": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ObjectStoreSize"
        ]
      },
      "Description": "The size of the object storage space."
    },
    "Nodes": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Nodes"
        ]
      },
      "Description": "The Node information."
    },
    "Engine": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Engine"
        ]
      },
      "Description": "The engine type."
    },
    "VpcId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      },
      "Description": "The VPC ID."
    },
    "NodeScaleMax": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "NodeScaleMax"
        ]
      },
      "Description": "The maximum value of serverless node auto scaling."
    },
    "Description": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      },
      "Description": "The cluster description."
    },
    "ResourceGroupId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      },
      "Description": "The ID of the resource group."
    },
    "MaintainEndTime": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaintainEndTime"
        ]
      },
      "Description": "The end time of the maintenance window."
    },
    "StorageQuota": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StorageQuota"
        ]
      },
      "Description": "Storage Pre-purchased Capacity (GB)."
    },
    "InstanceNetworkType": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceNetworkType"
        ]
      },
      "Description": "The network type of the instance."
    },
    "DisabledPorts": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DisabledPorts"
        ]
      },
      "Description": "The specified database port is disabled. Multiple ports separated by commas (,) are supported."
    },
    "ScaleMax": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ScaleMax"
        ]
      },
      "Description": "The maximum capacity for elastic scaling."
    },
    "ComputingGroupIds": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ComputingGroupIds"
        ]
      },
      "Description": "The list of computing group IDs."
    },
    "ZoneId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      },
      "Description": "The zone ID."
    },
    "EngineVersion": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EngineVersion"
        ]
      },
      "Description": "The engine version."
    },
    "Endpoints": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Endpoints"
        ]
      },
      "Description": "List of Endpoint details."
    },
    "StorageType": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StorageType"
        ]
      },
      "Description": "The storage type."
    },
    "Tags": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      },
      "Description": "The details of the tags."
    },
    "DBInstanceId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceId"
        ]
      },
      "Description": "The cluster ID."
    },
    "MultiZones": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MultiZones"
        ]
      },
      "Description": "The information about the zones."
    },
    "ChargeType": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ChargeType"
        ]
      },
      "Description": "The billing method. Enterprise Edition clusters use the pay-as-you-go billing method."
    },
    "NodeCount": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "NodeCount"
        ]
      },
      "Description": "The number of nodes. The value range is 2-16. Required when you use NodeScaleMin and NodeScaleMax to configure an elastic interval."
    },
    "VswitchId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VswitchId"
        ]
      },
      "Description": "The VSwitch ID."
    },
    "ScaleMin": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ScaleMin"
        ]
      },
      "Description": "The minimum capacity for elastic scaling."
    },
    "StorageSize": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StorageSize"
        ]
      },
      "Description": "The size of the storage space. Unit: GB."
    },
    "CreateTime": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      },
      "Description": "The creation time of the cluster."
    },
    "MaintainStartTime": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaintainStartTime"
        ]
      },
      "Description": "The maintainable time start time."
    }
  }
}