group_memberships

Creates, updates, deletes or gets a group_membership resource or lists group_memberships in a region

Overview

Name	group_memberships
Type	Resource
Description	Resource Type Definition for AWS:IdentityStore::GroupMembership
Id	aws.identitystore.group_memberships

Fields

Name	Datatype	Description
group_id	string	The unique identifier for a group in the identity store.
identity_store_id	string	The globally unique identifier for the identity store.
member_id	object	An object containing the identifier of a group member.
membership_id	string	The identifier for a GroupMembership in the identity store.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	IdentityStoreId, GroupId, MemberId, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all group_memberships in a region.

SELECT
region,
group_id,
identity_store_id,
member_id,
membership_id
FROM aws.identitystore.group_memberships
WHERE region = 'us-east-1';

Gets all properties from an individual group_membership.

SELECT
region,
group_id,
identity_store_id,
member_id,
membership_id
FROM aws.identitystore.group_memberships
WHERE region = 'us-east-1' AND data__Identifier = '<MembershipId>|<IdentityStoreId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.identitystore.group_memberships (
 GroupId,
 IdentityStoreId,
 MemberId,
 region
)
SELECT 
'{{ GroupId }}',
 '{{ IdentityStoreId }}',
 '{{ MemberId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.identitystore.group_memberships (
 GroupId,
 IdentityStoreId,
 MemberId,
 region
)
SELECT 
 '{{ GroupId }}',
 '{{ IdentityStoreId }}',
 '{{ MemberId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: group_membership
    props:
      - name: GroupId
        value: '{{ GroupId }}'
      - name: IdentityStoreId
        value: '{{ IdentityStoreId }}'
      - name: MemberId
        value:
          UserId: '{{ UserId }}'

DELETE example

/*+ delete */
DELETE FROM aws.identitystore.group_memberships
WHERE data__Identifier = '<MembershipId|IdentityStoreId>'
AND region = 'us-east-1';

Permissions

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

Create

identitystore:CreateGroupMembership,
identitystore:DescribeGroupMembership

Read

identitystore:DescribeGroupMembership

Delete

identitystore:DeleteGroupMembership,
identitystore:DescribeGroupMembership

List

identitystore:ListGroupMemberships