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	awscc.memorydb.users

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
user_name	string	The name of the user.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	users	INSERT	UserName, region
delete_resource	users	DELETE	Identifier, region
update_resource	users	UPDATE	Identifier, PatchDocument, region
list_resources	users_list_only	SELECT	region
get_resource	users	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual user.

SELECT
  region,
  status,
  user_name,
  access_string,
  authentication_mode,
  arn,
  tags
FROM awscc.memorydb.users
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ user_name }}';

list (identifiers only)

Lists all users in a region.

SELECT
  region,
  user_name
FROM awscc.memorydb.users_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.memorydb.users (
  UserName,
  AccessString,
  AuthenticationMode,
  Tags,
  region
)
SELECT
  '{{ user_name }}',
  '{{ access_string }}',
  '{{ authentication_mode }}',
  '{{ 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: user_name
        value: '{{ user_name }}'
      - name: access_string
        value: '{{ access_string }}'
      - name: authentication_mode
        value:
          type: '{{ type }}'
          passwords:
            - '{{ passwords[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.memorydb.users
SET PatchDocument = string('{{ {
    "AccessString": access_string,
    "AuthenticationMode": authentication_mode,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.memorydb.users
WHERE
  Identifier = '{{ user_name }}' 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,
iam:CreateServiceLinkedRole

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