CreateUser - Amazon ElastiCache

CreateUser

For Redis engine version 6.x onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

AccessString

Access permissions string used for this user account.

Type: String

Pattern: .*\S.*

Required: Yes

Engine

Must be Redis.

Type: String

Pattern: [a-zA-Z]*

Required: Yes

UserId

The ID of the user.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: Yes

UserName

The username of the user.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

NoPasswordRequired

Indicates a password is not required for this user account.

Type: Boolean

Required: No

Passwords.member.N

Passwords used for this user account. You can create up to two passwords for each user.

Type: Array of strings

Array Members: Minimum number of 1 item.

Required: No

Response Elements

The following elements are returned by the service.

AccessString

Access permissions string used for this user account.

Type: String

ARN

The Amazon Resource Name (ARN) of the user account.

Type: String

Authentication

Denotes whether the user requires a password to authenticate.

Type: Authentication object

Engine

Must be Redis.

Type: String

Pattern: [a-zA-Z]*

Status

Indicates the user status. Can be "active", "modifying" or "deleting".

Type: String

UserGroupIds.member.N

Returns a list of the user group IDs the user belongs to.

Type: Array of strings

Length Constraints: Minimum length of 1.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

UserId

The ID of the user.

Type: String

UserName

The username of the user.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DuplicateUserName

A user with this username already exists.

HTTP Status Code: 400

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

UserAlreadyExists

A user with this ID already exists.

HTTP Status Code: 400

UserQuotaExceeded

The quota of users has been exceeded.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: