ALIYUN::REDIS::Account is used to create an Account with the specified permission for an apsaradb for Redis instance.

Syntax

{
  "Type": "ALIYUN::REDIS::Account",
  "Properties": {
    "AccountDescription": String,
    "InstanceId": String,
    "AccountName": String,
    "AccountPrivilege": String,
    "AccountType": String,
    "AccountPassword": String
  }
}

Properties

Parameter Type Required Editable Description Constraint
AccountDescription String Not supported Supported Account Description It must start with a Chinese or English letter and cannot start with a Chinese character. http: // or https: // the beginning. The name must be 2 to 256 characters in length, and can contain Chinese characters, uppercase letters, lowercase letters, hyphen (-), and numbers.
InstanceId String Yes Not supported The ID of the instance. None
AccountName String Yes Not supported Account name The name must be 1 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter.
AccountPrivilege String Not supported Supported Account permission Valid values:
  • RoleReadOnly: Read-only
  • RoleReadWrite (default): Read /Write
  • RoleRepl: copy. Replication permissions support read /write and open SYNC/PSYNC command. The RoleRepl permission can be granted to an account only in an ApsaraDB for Redis instance of the standard edition in Redis 4.0.
AccountType String No Released Account type Value: Normal (Normal account)
AccountPassword String Yes Not supported The password for the account. The password must be 8 to 32 characters in length and must contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters.
! @[$%^ *()_+-=
.

Return value

Fn::GetAtt

  • InstanceId: The ID of the instance.
  • AccountName: The name of the account.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Account": {
      "Type": "ALIYUN::REDIS::Account",
      "Properties": {
        "AccountDescription": {
          "Ref": "AccountDescription"
        },
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "AccountName": {
          "Ref": "AccountName"
        },
        "AccountPrivilege": {
          "Ref": "AccountPrivilege"
        },
        "AccountType": {
          "Ref": "AccountType"
        },
        "AccountPassword": {
          "Ref": "AccountPassword"
        }
      }
    }
  },
  "Parameters": {
    "AccountDescription": {
      "Type": "String",
      "Description": "The description of the account.\nThe description must start with a letter, and cannot start with http:// or https://.\nThe description can contain letters, underscores (_), hyphens (-), and digits.\nIt can be 2 to 256 characters in length."
    },
    "InstanceId": {
      "Type": "String",
      "Description": "The ID of the instance for which you want to create the account."
    },
    "AccountName": {
      "Type": "String",
      "Description": "The name of the account. The name must start with a lowercase letter and can contain\nlowercase letters, digits, and underscores (_). The name can be 1 to 16 characters\nin length."
    },
    "AccountPrivilege": {
      "Type": "String",
      "Description": "The permission of the account. Valid values:\nRoleReadOnly\nRoleReadWrite (default value)\nRoleRepl\nNote In addition to reading data from and writing data to the ApsaraDB for Redis instance,\nan account with the RoleRepl permission can run the SYNC and PSYNC commands. The RoleRepl\npermission can be granted to an account only in an ApsaraDB for Redis instance of\nthe standard edition in Redis 4.0."
    },
    "AccountType": {
      "Default": "Normal",
      "Type": "String",
      "Description": "The type of the account. Set this parameter to Normal."
    },
    "AccountPassword": {
      "Type": "String",
      "Description": "The password of the account. The password can be 8 to 32 characters in length and\nmust contain at least three types of the following characters: uppercase letters,\nlowercase letters, digits, and special characters. Special characters include! at signs (@), number signs (#), dollar signs ($), percent signs (%), carets (^),\nampersands (&), asterisks (*), parentheses (()), underscores (_), plus signs (+),\nhyphens (-), and equal signs (=)."
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "The name of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Account",
          "InstanceId"
        ]
      }
    },
    "AccountName": {
      "Description": "The name of the account.",
      "Value": {
        "Fn::GetAtt": [
          "Account",
          "AccountName"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  Account:
    Type: 'ALIYUN::REDIS::Account'
    Properties:
      AccountDescription:
        Ref: AccountDescription
      InstanceId:
        Ref: InstanceId
      AccountName:
        Ref: AccountName
      AccountPrivilege:
        Ref: AccountPrivilege
      AccountType:
        Ref: AccountType
      AccountPassword:
        Ref: AccountPassword
Parameters:
  AccountDescription:
    Type: String
    Description: >-
      The description of the account.

      The description must start with a letter, and cannot start with http:// or
      https://.

      The description can contain letters, underscores (_), hyphens (-), and
      digits.

      It can be 2 to 256 characters in length.
  InstanceId:
    Type: String
    Description: The ID of the instance for which you want to create the account.
  AccountName:
    Type: String
    Description: >-
      The name of the account. The name must start with a lowercase letter and
      can contain

      lowercase letters, digits, and underscores (_). The name can be 1 to 16
      Characters

      in length.
  AccountPrivilege:
    Type: String
    Description: >-
      The permission of the account. Valid values:

      RoleReadOnly

      RoleReadWrite (default value)

      RoleRepl

      Note In addition to reading data from and writing data to the ApsaraDB for
      Redis instance,

      an account with the RoleRepl permission can run the SYNC and PSYNC
      commands. The RoleRepl

      permission can be granted to an account only in an ApsaraDB for Redis
      instance of

      the standard edition in Redis 4.0.
  AccountType:
    Default: Normal
    Type: String
    Description: The type of the account. Set this parameter to Normal.
  AccountPassword:
    Type: String
    Description: >-
      The password of the account. The password can be 8 to 32 characters in
      length and

      must contain at least three types of the following characters: uppercase
      letters,

      lowercase letters, digits, and special characters. Special characters
      include! at signs (@), number signs (#), dollar signs ($), percent signs
      (%), carets (^),

      ampersands (&), asterisks (*), parentheses (()), underscores (_), plus
      signs (+),

      hyphens (-), and equal signs (=).
Outputs:
  InstanceId:
    Description: The name of the instance.
    Value:
      'Fn::GetAtt':
        -Account
        - InstanceId
  AccountName:
    Description: The name of the account.
    Value:
      'Fn::GetAtt':
        -Account
        -AccountName