user_pool_user_to_group_attachments

Creates, updates, deletes or gets an user_pool_user_to_group_attachment resource or lists user_pool_user_to_group_attachments in a region

Overview

Name	user_pool_user_to_group_attachments
Type	Resource
Description	Resource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment
Id	awscc.cognito.user_pool_user_to_group_attachments

Fields

Name	Datatype	Description
user_pool_id	string
username	string
group_name	string
region	string	AWS region.

For more information, see AWS::Cognito::UserPoolUserToGroupAttachment.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	UserPoolId, Username, GroupName, region
delete_resource	DELETE	Identifier, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual user_pool_user_to_group_attachment.

SELECT
  region,
  user_pool_id,
  username,
  group_name
FROM awscc.cognito.user_pool_user_to_group_attachments
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ user_pool_id }}|{{ group_name }}|{{ username }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.cognito.user_pool_user_to_group_attachments (
  UserPoolId,
  Username,
  GroupName,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ username }}',
  '{{ group_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cognito.user_pool_user_to_group_attachments (
  UserPoolId,
  Username,
  GroupName,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ username }}',
  '{{ group_name }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_pool_user_to_group_attachment
    props:
      - name: user_pool_id
        value: '{{ user_pool_id }}'
      - name: username
        value: '{{ username }}'
      - name: group_name
        value: '{{ group_name }}'

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.user_pool_user_to_group_attachments
WHERE
  Identifier = '{{ user_pool_id }}|{{ group_name }}|{{ username }}' AND
  region = 'us-east-1';

Permissions

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

Create

cognito-idp:AdminAddUserToGroup,
cognito-idp:AdminListGroupsForUser

Delete

cognito-idp:AdminRemoveUserFromGroup,
cognito-idp:AdminListGroupsForUser

Read

cognito-idp:AdminListGroupsForUser