ALIYUN::ADBLake::ResourceGroup

ALIYUN::ADBLake::ResourceGroup is used to create a resource group for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

Syntax

{
  "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
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint

Property	Type	Required	Editable	Description	Constraint
DBClusterId	String	Yes	No	The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.	None.
Engine	String	Yes	No	The database engine.	Valid values: AnalyticDB (default): AnalyticDB for MySQL. SparkWarehouse: SparkWarehouse.
GroupName	String	Yes	No	The name of the resource group.	The name can be up to 255 characters in length. It must start with a letter or digit. It can contain digits, letters, hyphens (-), and underscores (_).
GroupType	String	Yes	No	The type of the resource group.	Valid values: Interactive Job
AutoStopInterval	String	No	Yes	The duration of inactivity before the database engine automatically stops.	Unit: minutes.
ClusterMode	String	No	Yes	The mode of the cluster.	Set the value to AutoScale.
ClusterSizeResource	String	No	Yes	This is a reserved property.	None.
EngineParams	Map	No	Yes	The configurations of the database engine.	None.
EnableSpot	Boolean	No	Yes	Specifies whether to enable the spot instance feature for the resource group.	None.
MaxComputeResource	String	No	Yes	The maximum number of reserved computing resources.	Unit: AnalyticDB compute unit (ACU). If GroupType is set to Interactive, the maximum number of reserved computing resources refers to the allocable resources of the cluster in increments of 16 ACUs. If GroupType is set to Job, the maximum number of reserved computing resources refers to the allocable resources of the cluster in increments of 8 ACUs.
MinClusterCount	Integer	No	Yes	This is a reserved property.	None.
MinComputeResource	String	No	Yes	The minimum number of reserved computing resources.	Unit: ACU. If GroupType is set to Interactive, the minimum number of reserved computing resources is 16 ACUs. If GroupType is set to Job, the minimum number of reserved computing resources is 0 ACU.
MaxClusterCount	Integer	No	Yes	This is a reserved property.	None.
Rules	List	No	Yes	The job resubmission rules.	For more information, see Rules properties.

Rules syntax

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

Rules properties

Property	Type	Required	Editable	Description	Constraint

Property	Type	Required	Editable	Description	Constraint
GroupName	String	Yes	No	The name of the resource group.	The name can be up to 255 characters in length. It must start with a letter or digit. It can contain digits, letters, hyphens (-), and underscores (_).
QueryTime	String	Yes	Yes	The threshold of the query execution time.	Unit: milliseconds.
TargetGroupName	String	Yes	Yes	The name of the destination resource group.	None.

Return values

Fn::GetAtt

GroupName: the name of the resource group.
GroupType: the type of the resource group.
GroupUsers: the Resource Access Management (RAM) users that are associated with the resource group.

Examples

YAML

JSON

YAML

            
            
          
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

JSON

            
            
          
{
  "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"
        ]
      }
    }
  }
}
                        

Syntax

Properties

Rules syntax

Rules properties

Return values

Examples

Sales Support

Technical Support

Connect & Report Abuse