ALIYUN::ADBLake::ResourceGroup

ALIYUN::ADBLake::ResourceGroup类型用于湖仓版集群创建资源组。

语法

{
  "Type": "ALIYUN::ADBLake::ResourceGroup",
  "Properties": {
    "DBClusterId": String,
    "Engine": String,
    "GroupName": String,
    "GroupType": String,
    "AutoStopInterval": String,
    "ClusterMode": String,
    "ClusterSizeResource": String,
    "EngineParams": Map,
    "EnableSpot": Boolean,
    "MaxComputeResource": String,
    "MinClusterCount": Integer,
    "MinComputeResource": String,
    "MaxClusterCount": Integer,
    "Rules": List
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

DBClusterId

String

AnalyticDB MySQL 湖仓版(3.0)集群 ID。

Engine

String

数据库引擎。

取值:

  • AnalyticDB(默认):AnalyticDB for MySQL 引擎。

  • SparkWarehouse:SparkWarehouse 引擎。

GroupName

String

资源组名称。

  • 长度不超过 255 个字符。

  • 必须以数字、大写字母或小写字母开头。

  • 可包含数字、大写字母、小写字母、中划线(-)和下划线(_)。

GroupType

String

资源组类型。

取值:

  • Interactive

  • Job

AutoStopInterval

String

自动停止时间。

单位为分钟(m)。

ClusterMode

String

集群模式。

取值:

  • AutoScale

ClusterSizeResource

String

预留参数。

EngineParams

Map

引擎配置。

EnableSpot

Boolean

资源组是否开启竞价实例功能。

MaxComputeResource

String

最大计算预留资源。

单位为 ACU。

  • 当资源组类型为 Interactive 时,计算预留资源最大为集群当前未分配资源,步长为 16 ACU。

  • 当资源组类型为 Job 时,计算预留资源最大为集群当前未分配资源,步长为 8 ACU。

MinClusterCount

Integer

预留参数。

MinComputeResource

String

最小计算预留资源。

单位为 ACU。

  • 当资源组类型为 Interactive 时,计算预留资源最小为 16 ACU。

  • 当资源组类型为 Job 时,计算预留资源最小为 0 ACU。

MaxClusterCount

Integer

预留参数。

Rules

List

作业投递规则。

更多信息,请参见Rules属性

Rules语法

"Rules": [
  {
    "GroupName": String,
    "QueryTime": String,
    "TargetGroupName": String
  }
]

Rules属性

属性名称

类型

必须

允许更新

描述

约束

GroupName

String

资源组名称。

  • 长度不超过 255 个字符。

  • 必须以数字、大写字母或小写字母开头。

  • 可包含数字、大写字母、小写字母、中划线(-)和下划线(_)。

QueryTime

String

查询执行时间阈值。

单位为毫秒(ms)。

TargetGroupName

String

目标资源组名称。

返回值

Fn::GetAtt

  • GroupName:资源组名称。

  • GroupType:资源组类型。

  • GroupUsers:资源组绑定的 RAM 用户。

示例

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupName:
    Type: String
    Description:
      en: |-
        The name of the resource group.
        The name can be up to 255 characters in length.
        The name must start with a letter or digit.
        The name can contain letters, digits, hyphens (-), and underscores (_).
    Required: true
    AllowedPattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{0,254}$
    MinLength: 1
    MaxLength: 255
  ClusterMode:
    Type: String
    Description:
      en: 'The mode of cluster. Default: AutoScale.'
    Required: false
    Default: AutoScale
  DBClusterId:
    Type: String
    Description:
      en: The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
    Required: true
  MinClusterCount:
    Type: Number
    Description:
      en: A reserved parameter.
    Required: false
  GroupType:
    Type: String
    Description:
      en: |-
        The type of the resource group. Valid values:
        Interactive
        Job
        Note For more information about resource groups, see Resource group overview.
    AllowedValues:
      - Interactive
      - Job
    Required: true
  ClusterSizeResource:
    Type: String
    Description:
      en: A reserved parameter.
    Required: false
  MinComputeResource:
    Type: String
    Description:
      en: |-
        The minimum reserved computing resources.
        When GroupType is set to Interactive, set this parameter to 16ACU.
        When GroupType is set to Job, set this parameter to 0ACU.
    Required: false
  Engine:
    Type: String
    Description:
      en: |-
        Database engine, value:
        AnalyticDB (default): AnalyticDB for mysql engine.
        Sparkwarehouse: Sparkwarehous engine.
    AllowedValues:
      - SparkWarehouse
      - AnalyticDB
    Required: true
    Default: AnalyticDB
  MaxClusterCount:
    Type: Number
    Description:
      en: A reserved parameter.
    Required: false
Resources:
  ResourceGroup:
    Type: ALIYUN::ADBLake::ResourceGroup
    Properties:
      GroupName:
        Ref: GroupName
      ClusterMode:
        Ref: ClusterMode
      DBClusterId:
        Ref: DBClusterId
      MinClusterCount:
        Ref: MinClusterCount
      GroupType:
        Ref: GroupType
      ClusterSizeResource:
        Ref: ClusterSizeResource
      MinComputeResource:
        Ref: MinComputeResource
      Engine:
        Ref: Engine
      MaxClusterCount:
        Ref: MaxClusterCount
Outputs:
  GroupName:
    Description: The name of the resource group.
    Value:
      Fn::GetAtt:
        - ResourceGroup
        - GroupName
  GroupType:
    Description: The type of the resource group.
    Value:
      Fn::GetAtt:
        - ResourceGroup
        - GroupType
  GroupUsers:
    Description: The list of users in the resource group.
    Value:
      Fn::GetAtt:
        - ResourceGroup
        - GroupUsers
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupName": {
      "Type": "String",
      "Description": {
        "en": "The name of the resource group.\nThe name can be up to 255 characters in length.\nThe name must start with a letter or digit.\nThe name can contain letters, digits, hyphens (-), and underscores (_)."
      },
      "Required": true,
      "AllowedPattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,254}$",
      "MinLength": 1,
      "MaxLength": 255
    },
    "ClusterMode": {
      "Type": "String",
      "Description": {
        "en": "The mode of cluster. Default: AutoScale."
      },
      "Required": false,
      "Default": "AutoScale"
    },
    "DBClusterId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster."
      },
      "Required": true
    },
    "MinClusterCount": {
      "Type": "Number",
      "Description": {
        "en": "A reserved parameter."
      },
      "Required": false
    },
    "GroupType": {
      "Type": "String",
      "Description": {
        "en": "The type of the resource group. Valid values:\nInteractive\nJob\nNote For more information about resource groups, see Resource group overview."
      },
      "AllowedValues": [
        "Interactive",
        "Job"
      ],
      "Required": true
    },
    "ClusterSizeResource": {
      "Type": "String",
      "Description": {
        "en": "A reserved parameter."
      },
      "Required": false
    },
    "MinComputeResource": {
      "Type": "String",
      "Description": {
        "en": "The minimum reserved computing resources.\nWhen GroupType is set to Interactive, set this parameter to 16ACU.\nWhen GroupType is set to Job, set this parameter to 0ACU."
      },
      "Required": false
    },
    "Engine": {
      "Type": "String",
      "Description": {
        "en": "Database engine, value:\nAnalyticDB (default): AnalyticDB for mysql engine.\nSparkwarehouse: Sparkwarehous engine."
      },
      "AllowedValues": [
        "SparkWarehouse",
        "AnalyticDB"
      ],
      "Required": true,
      "Default": "AnalyticDB"
    },
    "MaxClusterCount": {
      "Type": "Number",
      "Description": {
        "en": "A reserved parameter."
      },
      "Required": false
    }
  },
  "Resources": {
    "ResourceGroup": {
      "Type": "ALIYUN::ADBLake::ResourceGroup",
      "Properties": {
        "GroupName": {
          "Ref": "GroupName"
        },
        "ClusterMode": {
          "Ref": "ClusterMode"
        },
        "DBClusterId": {
          "Ref": "DBClusterId"
        },
        "MinClusterCount": {
          "Ref": "MinClusterCount"
        },
        "GroupType": {
          "Ref": "GroupType"
        },
        "ClusterSizeResource": {
          "Ref": "ClusterSizeResource"
        },
        "MinComputeResource": {
          "Ref": "MinComputeResource"
        },
        "Engine": {
          "Ref": "Engine"
        },
        "MaxClusterCount": {
          "Ref": "MaxClusterCount"
        }
      }
    }
  },
  "Outputs": {
    "GroupName": {
      "Description": "The name of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ResourceGroup",
          "GroupName"
        ]
      }
    },
    "GroupType": {
      "Description": "The type of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ResourceGroup",
          "GroupType"
        ]
      }
    },
    "GroupUsers": {
      "Description": "The list of users in the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ResourceGroup",
          "GroupUsers"
        ]
      }
    }
  }
}