CreateUser - Amazon MemoryDB
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CreateUser

Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).

Request Syntax

{ "AccessString": "string", "AuthenticationMode": { "Passwords": [ "string" ], "Type": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "UserName": "string" }

Request Parameters

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

The request accepts the following data in JSON format.

AccessString

Access permissions string used for this user.

Type: String

Pattern: .*\S.*

Required: Yes

AuthenticationMode

Denotes the user's authentication properties, such as whether it requires a password to authenticate.

Type: AuthenticationMode object

Required: Yes

Tags

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Type: Array of Tag objects

Array Members: Maximum number of 200 items.

Required: No

UserName

The name of the user. This value must be unique as it also serves as the user identifier.

Type: String

Length Constraints: Minimum length of 1.

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

Required: Yes

Response Syntax

{ "User": { "AccessString": "string", "ACLNames": [ "string" ], "ARN": "string", "Authentication": { "PasswordCount": number, "Type": "string" }, "MinimumEngineVersion": "string", "Name": "string", "Status": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

User

The newly-created user.

Type: User object

Errors

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

DuplicateUserNameFault

HTTP Status Code: 400

InvalidParameterCombinationException

HTTP Status Code: 400

InvalidParameterValueException

HTTP Status Code: 400

TagQuotaPerResourceExceeded

HTTP Status Code: 400

UserAlreadyExistsFault

HTTP Status Code: 400

UserQuotaExceededFault

HTTP Status Code: 400

See Also

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