All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::POLARDB::Account

Last Updated:Apr 18, 2023

ALIYUN::POLARDB::Account is used to create a database account for a specified PolarDB cluster.

Syntax

{
  "Type": "ALIYUN::POLARDB::Account",
  "Properties": {
    "DBClusterId": String,
    "AccountDescription": String,
    "AccountName": String,
    "AccountPrivilege": String,
    "DBName": String,
    "AccountType": String,
    "AccountPassword": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

DBClusterId

String

Yes

No

The ID of the cluster.

None

AccountDescription

String

No

Yes

The description of the database account.

The description must be 2 to 256 characters in length. It cannot start with http:// or https://.

AccountName

String

Yes

No

The name of the database account.

The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.

AccountPrivilege

String

No

No

The permissions of the database account.

Default value: ReadWrite. Valid values:

  • ReadWrite

  • ReadOnly

  • DMLOnly

  • DDLOnly

Note

This parameter takes effect only when the AccountType parameter is set to Normal.

DBName

String

No

No

The name of the database on which you want to grant permissions.

Separate multiple database names with commas (,).

Note

This parameter takes effect only when the AccountType parameter is set to Normal.

AccountType

String

No

No

The type of the database account.

Default value: Super. Valid values:

  • Normal: standard account

  • Super: privileged account

AccountPassword

String

Yes

Yes

The password of the database account.

The password must be 8 to 32 characters in length and can contain letters, digits, and special characters. Special characters include

! #$%^&*()_+-=

Response parameters

Fn::GetAtt

None

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterId:
    Type: String
    Description: The ID of the ApsaraDB for POLARDB cluster for which a database account is to be created.
  AccountName:
    Type: String
    Description: The name of the database account to be used.
    Default: mytest
  AccountPassword:
    Type: String
    Description: |-
      The password of the database account. The password must comply with the following rules:
      - It must consist of uppercase letters, lowercase letters, digits, and special characters.
      - Special characters include exclamation points (!), number signs (#), dollar signs ($), percent signs (%), carets (^), ampersands (&), asterisks (*), parentheses (()), underscores (_), plus signs (+), hyphens (-), and equal signs (=).
      - It must be 8 to 32 characters in length.
    MinLength: 8
    MaxLength: 32
Resources:
  Account:
    Type: ALIYUN::POLARDB::Account
    Properties:
      DBClusterId:
        Ref: DBClusterId
      AccountName:
        Ref: AccountName
      AccountPrivilege: ReadOnly
      AccountPassword:
        Ref: AccountPassword
      AccountType: Normal

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": "The ID of the ApsaraDB for POLARDB cluster for which a database account is to be created."
    },
    "AccountName": {
      "Type": "String",
      "Description": "The name of the database account to be used.",
      "Default": "mytest"
    },
    "AccountPassword": {
      "Type": "String",
      "Description": "The password of the database account. The password must comply with the following rules:\n- It must consist of uppercase letters, lowercase letters, digits, and special characters.\n- Special characters include exclamation points (!), number signs (#), dollar signs ($), percent signs (%), carets (^), ampersands (&), asterisks (*), parentheses (()), underscores (_), plus signs (+), hyphens (-), and equal signs (=).\n- It must be 8 to 32 characters in length.",
      "MinLength": 8,
      "MaxLength": 32
    }
  },
  "Resources": {
    "Account": {
      "Type": "ALIYUN::POLARDB::Account",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId"
        },
        "AccountName": {
          "Ref": "AccountName"
        },
        "AccountPrivilege": "ReadOnly",
        "AccountPassword": {
          "Ref": "AccountPassword"
        },
        "AccountType": "Normal"
      }
    }
  }
}