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	awscc.identitystore.group_memberships

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
identity_store_id	string	The globally unique identifier for the identity store.
membership_id	string	The identifier for a GroupMembership in the identity store.
region	string	AWS region.

For more information, see AWS::IdentityStore::GroupMembership.

Methods

Name	Resource	Accessible by	Required Params
create_resource	group_memberships	INSERT	IdentityStoreId, GroupId, MemberId, region
delete_resource	group_memberships	DELETE	Identifier, region
list_resources	group_memberships_list_only	SELECT	region
get_resource	group_memberships	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual group_membership.

SELECT
  region,
  group_id,
  identity_store_id,
  member_id,
  membership_id
FROM awscc.identitystore.group_memberships
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ membership_id }}|{{ identity_store_id }}';

list (identifiers only)

Lists all group_memberships in a region.

SELECT
  region,
  membership_id,
  identity_store_id
FROM awscc.identitystore.group_memberships_list_only
WHERE
  region = '{{ region }}';

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 awscc.identitystore.group_memberships (
  GroupId,
  IdentityStoreId,
  MemberId,
  region
)
SELECT
  '{{ group_id }}',
  '{{ identity_store_id }}',
  '{{ member_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.identitystore.group_memberships (
  GroupId,
  IdentityStoreId,
  MemberId,
  region
)
SELECT
  '{{ group_id }}',
  '{{ identity_store_id }}',
  '{{ member_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: group_membership
  props:
    - name: group_id
      value: '{{ group_id }}'
    - name: identity_store_id
      value: '{{ identity_store_id }}'
    - name: member_id
      value:
        user_id: '{{ user_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.identitystore.group_memberships
WHERE
  Identifier = '{{ membership_id }}|{{ identity_store_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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