users

Creates, updates, deletes, gets or lists a users resource.

Overview

Name	users
Type	Resource
Id	aws.memorydb.users

Fields

The following fields are returned by SELECT queries:

describe_users

Name	Datatype	Description
acl_names	array	The names of the Access Control Lists to which the user belongs
arn	string	The Amazon Resource Name (ARN) of the user.
access_string	string	Access permissions string used for this user.
authentication	object	Denotes whether the user requires a password to authenticate.
minimum_engine_version	string	The minimum engine version supported for the user
name	string	The name of the user
status	string	Indicates the user status. Can be "active", "modifying" or "deleting".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_users	select	region		Returns a list of users.
create_user	insert	region, UserName, AuthenticationMode, AccessString		Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
update_user	update	region, UserName		Changes user password(s) and/or access string.
delete_user	delete	region		Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_users

Returns a list of users.

SELECT
acl_names,
arn,
access_string,
authentication,
minimum_engine_version,
name,
status
FROM aws.memorydb.users
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_user

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

INSERT INTO aws.memorydb.users (
UserName,
AuthenticationMode,
AccessString,
Tags,
region
)
SELECT 
'{{ UserName }}' /* required */,
'{{ AuthenticationMode }}' /* required */,
'{{ AccessString }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
user
;

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the users resource.
  - name: UserName
    value: "{{ UserName }}"
    description: |
      The name of the user. This value must be unique as it also serves as the user identifier.
  - name: AuthenticationMode
    description: |
      Denotes the user's authentication properties, such as whether it requires a password to authenticate.
    value:
      Type: "{{ Type }}"
      Passwords:
        - "{{ Passwords }}"
  - name: AccessString
    value: "{{ AccessString }}"
    description: |
      Access permissions string used for this user.
  - name: Tags
    description: |
      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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_user

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

UPDATE aws.memorydb.users
SET 
UserName = '{{ UserName }}',
AuthenticationMode = '{{ AuthenticationMode }}',
AccessString = '{{ AccessString }}'
WHERE 
region = '{{ region }}' --required
AND UserName = '{{ UserName }}' --required
RETURNING
user;

DELETE examples

delete_user

Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

DELETE FROM aws.memorydb.users
WHERE region = '{{ region }}' --required
;