groups

Creates, updates, deletes or gets a group resource or lists groups in a region

Overview

Name	groups
Type	Resource
Description	Resource Type definition for AWS::IdentityStore::Group
Id	awscc.identitystore.groups

Fields

get (all properties)

Name	Datatype	Description
description	string	A string containing the description of the group.
display_name	string	A string containing the name of the group. This value is commonly displayed when the group is referenced.
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.
region	string	AWS region.

list (identifiers only)

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.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	groups	INSERT	IdentityStoreId, DisplayName, region
delete_resource	groups	DELETE	Identifier, region
update_resource	groups	UPDATE	Identifier, PatchDocument, region
list_resources	groups_list_only	SELECT	region
get_resource	groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual group.

SELECT
  region,
  description,
  display_name,
  group_id,
  identity_store_id
FROM awscc.identitystore.groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ group_id }}|{{ identity_store_id }}';

list (identifiers only)

Lists all groups in a region.

SELECT
  region,
  group_id,
  identity_store_id
FROM awscc.identitystore.groups_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.identitystore.groups (
  DisplayName,
  IdentityStoreId,
  region
)
SELECT
  '{{ display_name }}',
  '{{ identity_store_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.identitystore.groups (
  Description,
  DisplayName,
  IdentityStoreId,
  region
)
SELECT
  '{{ description }}',
  '{{ display_name }}',
  '{{ identity_store_id }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: group
    props:
      - name: description
        value: '{{ description }}'
      - name: display_name
        value: '{{ display_name }}'
      - name: identity_store_id
        value: '{{ identity_store_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.identitystore.groups
SET PatchDocument = string('{{ {
    "Description": description,
    "DisplayName": display_name
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ group_id }}|{{ identity_store_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.identitystore.groups
WHERE
  Identifier = '{{ group_id }}|{{ identity_store_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

identitystore:CreateGroup,
identitystore:DescribeGroup

Read

identitystore:DescribeGroup

Update

identitystore:DescribeGroup,
identitystore:UpdateGroup

Delete

identitystore:DescribeGroup,
identitystore:DeleteGroup

List

identitystore:ListGroups