user_hierarchy_groups

Creates, updates, deletes or gets an user_hierarchy_group resource or lists user_hierarchy_groups in a region

Overview

Name	user_hierarchy_groups
Type	Resource
Description	Resource Type definition for AWS::Connect::UserHierarchyGroup
Id	aws.connect.user_hierarchy_groups

Fields

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
user_hierarchy_group_arn	string	The Amazon Resource Name (ARN) for the user hierarchy group.
parent_group_arn	string	The Amazon Resource Name (ARN) for the parent user hierarchy group.
name	string	The name of the user hierarchy group.
tags	array	One or more tags.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, InstanceArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all user_hierarchy_groups in a region.

SELECT
region,
instance_arn,
user_hierarchy_group_arn,
parent_group_arn,
name,
tags
FROM aws.connect.user_hierarchy_groups
WHERE region = 'us-east-1';

Gets all properties from an individual user_hierarchy_group.

SELECT
region,
instance_arn,
user_hierarchy_group_arn,
parent_group_arn,
name,
tags
FROM aws.connect.user_hierarchy_groups
WHERE region = 'us-east-1' AND data__Identifier = '<UserHierarchyGroupArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.connect.user_hierarchy_groups (
 InstanceArn,
 Name,
 region
)
SELECT 
'{{ InstanceArn }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.user_hierarchy_groups (
 InstanceArn,
 ParentGroupArn,
 Name,
 Tags,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ ParentGroupArn }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_hierarchy_group
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: ParentGroupArn
        value: '{{ ParentGroupArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.user_hierarchy_groups
WHERE data__Identifier = '<UserHierarchyGroupArn>'
AND region = 'us-east-1';

Permissions

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

Create

connect:CreateUserHierarchyGroup,
connect:TagResource

Read

connect:DescribeUserHierarchyGroup

Delete

connect:DeleteUserHierarchyGroup,
connect:UntagResource

Update

connect:UpdateUserHierarchyGroupName,
connect:TagResource,
connect:UntagResource

List

connect:ListUserHierarchyGroups