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::ElastiCache::User
Id	awscc.elasticache.users

Fields

get (all properties)

Name	Datatype	Description
status	string	Indicates the user status. Can be "active", "modifying" or "deleting".
user_id	string	The ID of the user.
user_name	string	The username of the user.
engine	string	The target cache engine for the user.
access_string	string	Access permissions string used for this user account.
no_password_required	boolean	Indicates a password is not required for this user account.
passwords	array	Passwords used for this user account. You can create up to two passwords for each user.
arn	string	The Amazon Resource Name (ARN) of the user account.
▶authentication_mode	object
▶tags	array	An array of key-value pairs to apply to this user.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
user_id	string	The ID of the user.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	users	INSERT	UserId, UserName, Engine, 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_id,
  user_name,
  engine,
  access_string,
  no_password_required,
  passwords,
  arn,
  authentication_mode,
  tags
FROM awscc.elasticache.users
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ user_id }}';

list (identifiers only)

Lists all users in a region.

SELECT
  region,
  user_id
FROM awscc.elasticache.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.elasticache.users (
  UserId,
  UserName,
  Engine,
  region
)
SELECT
  '{{ user_id }}',
  '{{ user_name }}',
  '{{ engine }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.elasticache.users (
  UserId,
  UserName,
  Engine,
  AccessString,
  NoPasswordRequired,
  Passwords,
  AuthenticationMode,
  Tags,
  region
)
SELECT
  '{{ user_id }}',
  '{{ user_name }}',
  '{{ engine }}',
  '{{ access_string }}',
  '{{ no_password_required }}',
  '{{ passwords }}',
  '{{ 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_id
        value: '{{ user_id }}'
      - name: user_name
        value: '{{ user_name }}'
      - name: engine
        value: '{{ engine }}'
      - name: access_string
        value: '{{ access_string }}'
      - name: no_password_required
        value: '{{ no_password_required }}'
      - name: passwords
        value:
          - '{{ passwords[0] }}'
      - 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.elasticache.users
SET PatchDocument = string('{{ {
    "Engine": engine,
    "AccessString": access_string,
    "NoPasswordRequired": no_password_required,
    "Passwords": passwords,
    "AuthenticationMode": authentication_mode,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.elasticache.users
WHERE
  Identifier = '{{ user_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

elasticache:CreateUser,
elasticache:DescribeUsers,
elasticache:ListTagsForResource,
elasticache:AddTagsToResource

Read

elasticache:DescribeUsers,
elasticache:ListTagsForResource

Update

elasticache:ModifyUser,
elasticache:DescribeUsers,
elasticache:ListTagsForResource,
elasticache:AddTagsToResource,
elasticache:RemoveTagsFromResource

Delete

elasticache:DeleteUser,
elasticache:DescribeUsers

List

elasticache:DescribeUsers,
elasticache:ListTagsForResource