ALIYUN::ADBLake::Account - Resource Orchestration Service

ALIYUN::ADBLake::Account is used to create a database account for an AnalyticDB for MySQL Data Lakehouse Edition cluster.

Syntax

{
  "Type": "ALIYUN::ADBLake::Account",
  "Properties": {
    "AccountType": String,
    "AccountName": String,
    "AccountPassword": String,
    "DBClusterId": String,
    "Engine": String,
    "AccountDescription": String,
    "RamUser": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint

Property	Type	Required	Editable	Description	Constraint
AccountType	String	Yes	No	The type of the database account.	Valid values: Normal: standard account. Super: privileged account.
AccountName	String	Yes	No	The name of the database account.	The name must meet the following requirements: The name must start with a lowercase letter and end with a lowercase letter or a digit. It can contain lowercase letters, digits, and underscores (_). It must be 2 to 16 characters in length. It cannot contain reserved usernames, such as root, admin, and opsadmin.
AccountPassword	String	Yes	Yes	The password of the database account.	The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `! @ # $ % ^ & * ( ) _ + - =` The password must be 8 to 32 characters in length.
DBClusterId	String	Yes	No	The ID of the Data Lakehouse Edition cluster.	None.
Engine	String	Yes	No	The database engine.	Valid values: AnalyticDB (default): AnalyticDB for MySQL engine. Clickhouse: wide table engine.
AccountDescription	String	No	Yes	The description of the database account.	The description cannot start with `http://` or `https://`. It can be up to 256 characters in length.
RamUser	String	No	Yes	The ID of the Resource Access Management (RAM) user.	None.

Return values

Fn::GetAtt

AccountName: the name of the database account.

Examples

YAML

JSON

YAML

            
            
          
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterId:
    Type: String
    Description:
      en: The ID of the ADB Lake cluster.
    Required: true
  AccountType:
    Type: String
    Description:
      en: 'The type of the account.Valid values: Normal: normal account. Super: super account.'
    AllowedValues:
      - Normal
      - Super
    Required: true
  Engine:
    Type: String
    Description:
      en: 'The engine of the account.Valid values: AnalyticDB / Clickhouse.'
    AllowedValues:
      - Clickhouse
      - AnalyticDB
    Required: true
    Default: AnalyticDB
  AccountName:
    Type: String
    Description:
      en: The name of the account.The database account name must meet the following requirements:Start with a lowercase letter and end with a lowercase letter or number.Consists of lowercase letters, numbers, or underscores (_).The length is 2 to 16 characters.Reserved user names such as root, admin, and opsadmin cannot be used.
    Required: true
    AllowedPattern: ^[a-z][a-z0-9_]{0,14}[a-z0-9]$
    MinLength: 2
    MaxLength: 16
  AccountPassword:
    Type: String
    Description:
      en: 'The password of the account.The password must meet the following requirements:Database account password.It consists of any three of uppercase letters, lowercase letters, numbers, and special characters.Special symbols include the following: !@#$%^&*()_+-=The password length is 8 to 32 characters.'
    Required: true
    MinLength: 8
    MaxLength: 32
Resources:
  Account:
    Type: ALIYUN::ADBLake::Account
    Properties:
      DBClusterId:
        Ref: DBClusterId
      AccountType:
        Ref: AccountType
      Engine:
        Ref: Engine
      AccountName:
        Ref: AccountName
      AccountPassword:
        Ref: AccountPassword
Outputs:
  AccountName:
    Description: The name of the account.
    Value:
      Fn::GetAtt:
        - Account
        - AccountName

JSON

            
            
          
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the ADB Lake cluster."
      },
      "Required": true
    },
    "AccountType": {
      "Type": "String",
      "Description": {
        "en": "The type of the account.Valid values: Normal: normal account. Super: super account."
      },
      "AllowedValues": [
        "Normal",
        "Super"
      ],
      "Required": true
    },
    "Engine": {
      "Type": "String",
      "Description": {
        "en": "The engine of the account.Valid values: AnalyticDB / Clickhouse."
      },
      "AllowedValues": [
        "Clickhouse",
        "AnalyticDB"
      ],
      "Required": true,
      "Default": "AnalyticDB"
    },
    "AccountName": {
      "Type": "String",
      "Description": {
        "en": "The name of the account.The database account name must meet the following requirements:Start with a lowercase letter and end with a lowercase letter or number.Consists of lowercase letters, numbers, or underscores (_).The length is 2 to 16 characters.Reserved user names such as root, admin, and opsadmin cannot be used."
      },
      "Required": true,
      "AllowedPattern": "^[a-z][a-z0-9_]{0,14}[a-z0-9]$",
      "MinLength": 2,
      "MaxLength": 16
    },
    "AccountPassword": {
      "Type": "String",
      "Description": {
        "en": "The password of the account.The password must meet the following requirements:Database account password.It consists of any three of uppercase letters, lowercase letters, numbers, and special characters.Special symbols include the following: !@#$%^&*()_+-=The password length is 8 to 32 characters."
      },
      "Required": true,
      "MinLength": 8,
      "MaxLength": 32
    }
  },
  "Resources": {
    "Account": {
      "Type": "ALIYUN::ADBLake::Account",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId"
        },
        "AccountType": {
          "Ref": "AccountType"
        },
        "Engine": {
          "Ref": "Engine"
        },
        "AccountName": {
          "Ref": "AccountName"
        },
        "AccountPassword": {
          "Ref": "AccountPassword"
        }
      }
    }
  },
  "Outputs": {
    "AccountName": {
      "Description": "The name of the account.",
      "Value": {
        "Fn::GetAtt": [
          "Account",
          "AccountName"
        ]
      }
    }
  }
}
                        