MemoryDB / Client / create_acl

create_acl

MemoryDB.Client.create_acl(**kwargs)

Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).

See also: AWS API Documentation

Request Syntax

response = client.create_acl(
    ACLName='string',
    UserNames=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• ACLName (string) –

  [REQUIRED]

  The name of the Access Control List.

• UserNames (list) –

  The list of users that belong to the Access Control List.

  • (string) –

• 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

{
    'ACL': {
        'Name': 'string',
        'Status': 'string',
        'UserNames': [
            'string',
        ],
        'MinimumEngineVersion': 'string',
        'PendingChanges': {
            'UserNamesToRemove': [
                'string',
            ],
            'UserNamesToAdd': [
                'string',
            ]
        },
        'Clusters': [
            'string',
        ],
        'ARN': 'string'
    }
}

Response Structure

• (dict) –

  • ACL (dict) –

    The newly-created Access Control List.

    • Name (string) –

      The name of the Access Control List

    • Status (string) –

      Indicates ACL status. Can be “creating”, “active”, “modifying”, “deleting”.

    • UserNames (list) –

      The list of user names that belong to the ACL.

      • (string) –

    • MinimumEngineVersion (string) –

      The minimum engine version supported for the ACL

    • PendingChanges (dict) –

      A list of updates being applied to the ACL.

      • UserNamesToRemove (list) –

        A list of user names being removed from the ACL

        • (string) –

      • UserNamesToAdd (list) –

        A list of users being added to the ACL

        • (string) –

    • Clusters (list) –

      A list of clusters associated with the ACL.

      • (string) –

    • ARN (string) –

      The Amazon Resource Name (ARN) of the ACL

Exceptions

• MemoryDB.Client.exceptions.UserNotFoundFault

• MemoryDB.Client.exceptions.DuplicateUserNameFault

• MemoryDB.Client.exceptions.ACLAlreadyExistsFault

• MemoryDB.Client.exceptions.DefaultUserRequired

• MemoryDB.Client.exceptions.ACLQuotaExceededFault

• MemoryDB.Client.exceptions.InvalidParameterValueException

• MemoryDB.Client.exceptions.TagQuotaPerResourceExceeded