MemoryDB / Client / create_user

create_user

MemoryDB.Client.create_user(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    UserName='string',
    AuthenticationMode={
        'Type': 'password',
        'Passwords': [
            'string',
        ]
    },
    AccessString='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• UserName (string) –

  [REQUIRED]

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

• AuthenticationMode (dict) –

  [REQUIRED]

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

  • Type (string) –

    Indicates whether the user requires a password to authenticate. All newly-created users require a password.

  • Passwords (list) –

    The password(s) used for authentication

    • (string) –

• AccessString (string) –

  [REQUIRED]

  Access permissions string used for this user.

• Tags (list) –

  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.

  • (dict) –

    A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources

    • Key (string) –

      The key for the tag. May not be null.

    • Value (string) –

      The tag’s value. May be null.

Return type:

dict

Returns:

Response Syntax

{
    'User': {
        'Name': 'string',
        'Status': 'string',
        'AccessString': 'string',
        'ACLNames': [
            'string',
        ],
        'MinimumEngineVersion': 'string',
        'Authentication': {
            'Type': 'password'|'no-password',
            'PasswordCount': 123
        },
        'ARN': 'string'
    }
}

Response Structure

• (dict) –

  • User (dict) –

    The newly-created user.

    • Name (string) –

      The name of the user

    • Status (string) –

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

    • AccessString (string) –

      Access permissions string used for this user.

    • ACLNames (list) –

      The names of the Access Control Lists to which the user belongs

      • (string) –

    • MinimumEngineVersion (string) –

      The minimum engine version supported for the user

    • 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.

Exceptions

• MemoryDB.Client.exceptions.UserAlreadyExistsFault

• MemoryDB.Client.exceptions.UserQuotaExceededFault

• MemoryDB.Client.exceptions.DuplicateUserNameFault

• MemoryDB.Client.exceptions.InvalidParameterValueException

• MemoryDB.Client.exceptions.InvalidParameterCombinationException

• MemoryDB.Client.exceptions.TagQuotaPerResourceExceeded