role_memberships

Creates, updates, deletes, gets or lists a role_memberships resource.

Overview

Name	role_memberships
Type	Resource
Id	aws.quicksight.role_memberships

Fields

The following fields are returned by SELECT queries:

list_role_memberships

Name	Datatype	Description
members	string	The list of groups associated with a role

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_role_memberships	select	role, aws_account_id, namespace, region	next-token, max-results	Lists all groups that are associated with a role.
create_role_membership	insert	member_name, aws_account_id, namespace, role, region		Use CreateRoleMembership to add an existing Quick Sight group to an existing role.
delete_role_membership	delete	member_name, role, aws_account_id, namespace, region		Removes a group from a role.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aws_account_id	string	The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
member_name	string	The name of the group.
namespace	string	The namespace that contains the role.
region	string	AWS region (default: us-east-1)
role	string	The role that you want to remove permissions from.
max-results	integer	The maximum number of results to return.
next-token	string	A pagination token that can be used in a subsequent request.

SELECT examples

list_role_memberships

Lists all groups that are associated with a role.

SELECT
members
FROM aws.quicksight.role_memberships
WHERE role = '{{ role }}' -- required
AND aws_account_id = '{{ aws_account_id }}' -- required
AND namespace = '{{ namespace }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_role_membership

Use CreateRoleMembership to add an existing Quick Sight group to an existing role.

INSERT INTO aws.quicksight.role_memberships (
member_name,
aws_account_id,
namespace,
role,
region
)
SELECT 
'{{ member_name }}',
'{{ aws_account_id }}',
'{{ namespace }}',
'{{ role }}',
'{{ region }}'
RETURNING
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: role_memberships
props:
  - name: member_name
    value: "{{ member_name }}"
    description: Required parameter for the role_memberships resource.
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the role_memberships resource.
  - name: namespace
    value: "{{ namespace }}"
    description: Required parameter for the role_memberships resource.
  - name: role
    value: "{{ role }}"
    description: Required parameter for the role_memberships resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the role_memberships resource.

DELETE examples

delete_role_membership

Removes a group from a role.

DELETE FROM aws.quicksight.role_memberships
WHERE member_name = '{{ member_name }}' --required
AND role = '{{ role }}' --required
AND aws_account_id = '{{ aws_account_id }}' --required
AND namespace = '{{ namespace }}' --required
AND region = '{{ region }}' --required
;