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	aws.memorydb.acls

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ACLName, 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 acls in a region.

SELECT
region,
status,
acl_name,
user_names,
arn,
tags
FROM aws.memorydb.acls
WHERE region = 'us-east-1';

Gets all properties from an individual acl.

SELECT
region,
status,
acl_name,
user_names,
arn,
tags
FROM aws.memorydb.acls
WHERE region = 'us-east-1' AND data__Identifier = '<ACLName>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.memorydb.acls (
 ACLName,
 UserNames,
 Tags,
 region
)
SELECT 
 '{{ ACLName }}',
 '{{ UserNames }}',
 '{{ 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: ACLName
        value: '{{ ACLName }}'
      - name: UserNames
        value:
          - '{{ UserNames[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.memorydb.acls
WHERE data__Identifier = '<ACLName>'
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

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