modify-user¶

Description¶

Changes user password(s) and/or access string.

Synopsis¶

  modify-user
--user-id <value>
[--access-string <value>]
[--append-access-string <value>]
[--passwords <value>]
[--no-password-required | --no-no-password-required]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--user-id (string)

The ID of the user.

--access-string (string)

Access permissions string used for this user.

--append-access-string (string)

Adds additional user permissions to the access string.

--passwords (list)

The passwords belonging to the user. You are allowed up to two.

(string)

Syntax:

"string" "string" ...

--no-password-required | --no-no-password-required (boolean)

Indicates no password is required for the user.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To modify a user

The following modify-user example modifies a user’s access string.

aws elasticache modify-user \
    --user-id user2 \
    --append-access-string "on ~* +@all"

Output:

{
    "UserId": "user2",
    "UserName": "myUser",
    "Status": "modifying",
    "Engine": "redis",
    "AccessString": "on ~* +@all",
    "UserGroupIds": [],
    "Authentication": {
        "Type": "password",
        "PasswordCount": 1
    },
    "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:user:user2"
}

For more information, see Authenticating Users with Role-Based Access Control (RBAC) in the Elasticache User Guide.

Output¶

UserId -> (string)

The ID of the user.

UserName -> (string)

The username of the user.

Status -> (string)

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

Engine -> (string)

The current supported value is Redis.

MinimumEngineVersion -> (string)

The minimum engine version required, which is Redis 6.0

AccessString -> (string)

Access permissions string used for this user.

UserGroupIds -> (list)

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

(string)

Authentication -> (structure)

Denotes whether the user requires a password to authenticate.

Type -> (string)

Indicates whether the user requires a password to authenticate.

PasswordCount -> (integer)

The number of passwords belonging to the user. The maximum is two.

ARN -> (string)

The Amazon Resource Name (ARN) of the user.

Table of Contents

Feedback

User Guide