acls

Creates, updates, deletes or gets an acl resource or lists acls in a region

Overview

Name	acls
Type	Resource
Description	Resource Type definition for AWS::MemoryDB::ACL
Id	awscc.memorydb.acls

Fields

get (all properties)

Name	Datatype	Description
status	string	Indicates acl status. Can be "creating", "active", "modifying", "deleting".
acl_name	string	The name of the acl.
user_names	array	List of users associated to this acl.
arn	string	The Amazon Resource Name (ARN) of the acl.
▶tags	array	An array of key-value pairs to apply to this cluster.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
acl_name	string	The name of the acl.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	acls	INSERT	ACLName, region
delete_resource	acls	DELETE	Identifier, region
update_resource	acls	UPDATE	Identifier, PatchDocument, region
list_resources	acls_list_only	SELECT	region
get_resource	acls	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual acl.

SELECT
  region,
  status,
  acl_name,
  user_names,
  arn,
  tags
FROM awscc.memorydb.acls
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ acl_name }}';

list (identifiers only)

Lists all acls in a region.

SELECT
  region,
  acl_name
FROM awscc.memorydb.acls_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.memorydb.acls (
  ACLName,
  region
)
SELECT
  '{{ acl_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.memorydb.acls (
  ACLName,
  UserNames,
  Tags,
  region
)
SELECT
  '{{ acl_name }}',
  '{{ user_names }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: acl
    props:
      - name: acl_name
        value: '{{ acl_name }}'
      - name: user_names
        value:
          - '{{ user_names[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.memorydb.acls
SET PatchDocument = string('{{ {
    "UserNames": user_names,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ acl_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.memorydb.acls
WHERE
  Identifier = '{{ acl_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

memorydb:CreateACL,
memorydb:DescribeACLs,
memorydb:TagResource,
memorydb:ListTags,
iam:CreateServiceLinkedRole

Read

memorydb:DescribeACLs,
memorydb:ListTags

Update

memorydb:UpdateACL,
memorydb:DescribeACLs,
memorydb:ListTags,
memorydb:TagResource,
memorydb:UntagResource

Delete

memorydb:ModifyReplicationGroup,
memorydb:DeleteACL,
memorydb:DescribeACLs

List

memorydb:DescribeACLs,
memorydb:ListTags