Amazon ElastiCache

{'Engine': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.modify_user(
    UserId='string',
    AccessString='string',
    AppendAccessString='string',
    Passwords=[
        'string',
    ],
    NoPasswordRequired=True|False,
    AuthenticationMode={
        'Type': 'password'|'no-password-required'|'iam',
        'Passwords': [
            'string',
        ]
    },
    Engine='string'
)

type UserId:

string

param UserId:

[REQUIRED]

The ID of the user.

type AccessString:

string

param AccessString:

Access permissions string used for this user.

type AppendAccessString:

string

param AppendAccessString:

Adds additional user permissions to the access string.

type Passwords:

list

param Passwords:

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

• (string) --

type NoPasswordRequired:

boolean

param NoPasswordRequired:

Indicates no password is required for the user.

type AuthenticationMode:

dict

param AuthenticationMode:

Specifies how to authenticate the user.

• Type (string) --

  Specifies the authentication type. Possible options are IAM authentication, password and no password.

• Passwords (list) --

  Specifies the passwords to use for authentication if Type is set to password.

  • (string) --

type Engine:

string

param Engine:

The engine for a specific user.

rtype:

dict

returns:

Response Syntax

{
    'UserId': 'string',
    'UserName': 'string',
    'Status': 'string',
    'Engine': 'string',
    'MinimumEngineVersion': 'string',
    'AccessString': 'string',
    'UserGroupIds': [
        'string',
    ],
    'Authentication': {
        'Type': 'password'|'no-password'|'iam',
        'PasswordCount': 123
    },
    'ARN': 'string'
}

Response Structure

• (dict) --

  • 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 OSS 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 (dict) --

    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.

{'Engine': 'string'}

Changes the list of users that belong to the user group.

See also: AWS API Documentation

Request Syntax

client.modify_user_group(
    UserGroupId='string',
    UserIdsToAdd=[
        'string',
    ],
    UserIdsToRemove=[
        'string',
    ],
    Engine='string'
)

type UserGroupId:

string

param UserGroupId:

[REQUIRED]

The ID of the user group.

type UserIdsToAdd:

list

param UserIdsToAdd:

The list of user IDs to add to the user group.

• (string) --

type UserIdsToRemove:

list

param UserIdsToRemove:

The list of user IDs to remove from the user group.

• (string) --

type Engine:

string

param Engine:

The engine for a user group.

rtype:

dict

returns:

Response Syntax

{
    'UserGroupId': 'string',
    'Status': 'string',
    'Engine': 'string',
    'UserIds': [
        'string',
    ],
    'MinimumEngineVersion': 'string',
    'PendingChanges': {
        'UserIdsToRemove': [
            'string',
        ],
        'UserIdsToAdd': [
            'string',
        ]
    },
    'ReplicationGroups': [
        'string',
    ],
    'ServerlessCaches': [
        'string',
    ],
    'ARN': 'string'
}

Response Structure

• (dict) --

  • UserGroupId (string) --

    The ID of the user group.

  • Status (string) --

    Indicates user group status. Can be "creating", "active", "modifying", "deleting".

  • Engine (string) --

    The current supported value is Redis user.

  • UserIds (list) --

    The list of user IDs that belong to the user group.

    • (string) --

  • MinimumEngineVersion (string) --

    The minimum engine version required, which is Redis OSS 6.0

  • PendingChanges (dict) --

    A list of updates being applied to the user group.

    • UserIdsToRemove (list) --

      The list of user IDs to remove.

      • (string) --

    • UserIdsToAdd (list) --

      The list of user IDs to add.

      • (string) --

  • ReplicationGroups (list) --

    A list of replication groups that the user group can access.

    • (string) --

  • ServerlessCaches (list) --

    Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.

    • (string) --

  • ARN (string) --

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