users

Creates, updates, deletes or gets a user resource or lists users in a region

Overview

Name	users
Type	Resource
Description	Resource Type definition for AWS::MemoryDB::User
Id	aws.memorydb.users

Fields

Name	Datatype	Description
status	string	Indicates the user status. Can be "active", "modifying" or "deleting".
user_name	string	The name of the user.
access_string	string	Access permissions string used for this user account.
authentication_mode	object
arn	string	The Amazon Resource Name (ARN) of the user account.
tags	array	An array of key-value pairs to apply to this user.
region	string	AWS region.

For more information, see AWS::MemoryDB::User.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	UserName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all users in a region.

SELECT
region,
status,
user_name,
access_string,
authentication_mode,
arn,
tags
FROM aws.memorydb.users
WHERE region = 'us-east-1';

Gets all properties from an individual user.

SELECT
region,
status,
user_name,
access_string,
authentication_mode,
arn,
tags
FROM aws.memorydb.users
WHERE region = 'us-east-1' AND data__Identifier = '<UserName>';

INSERT example

Use the following StackQL query and manifest file to create a new user resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.memorydb.users (
 UserName,
 region
)
SELECT 
'{{ UserName }}',
'{{ region }}';

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user
    props:
      - name: UserName
        value: '{{ UserName }}'
      - name: AccessString
        value: '{{ AccessString }}'
      - name: AuthenticationMode
        value:
          Type: '{{ Type }}'
          Passwords:
            - '{{ Passwords[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.memorydb.users
WHERE data__Identifier = '<UserName>'
AND region = 'us-east-1';

Permissions

To operate on the users resource, the following permissions are required:

Create

memorydb:CreateUser,
memorydb:DescribeUsers,
memorydb:TagResource,
memorydb:ListTags

Read

memorydb:DescribeUsers,
memorydb:ListTags

Update

memorydb:UpdateUser,
memorydb:DescribeUsers,
memorydb:ListTags,
memorydb:TagResource,
memorydb:UntagResource

Delete

memorydb:DeleteUser,
memorydb:DescribeUsers

List

memorydb:DescribeUsers,
memorydb:ListTags