user_hierarchy_structures

Creates, updates, deletes or gets an user_hierarchy_structure resource or lists user_hierarchy_structures in a region

Overview

Name	user_hierarchy_structures
Type	Resource
Description	Resource Type definition for AWS::Connect::UserHierarchyStructure
Id	aws.connect.user_hierarchy_structures

Fields

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
user_hierarchy_structure_arn	string	The identifier of the User Hierarchy Structure.
user_hierarchy_structure	object	Information about the hierarchy structure.
region	string	AWS region.

For more information, see AWS::Connect::UserHierarchyStructure.

Methods

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

SELECT examples

Gets all properties from an individual user_hierarchy_structure.

SELECT
region,
instance_arn,
user_hierarchy_structure_arn,
user_hierarchy_structure
FROM aws.connect.user_hierarchy_structures
WHERE region = 'us-east-1' AND data__Identifier = '<UserHierarchyStructureArn>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_hierarchy_structure
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: UserHierarchyStructure
        value:
          LevelOne:
            HierarchyLevelArn: '{{ HierarchyLevelArn }}'
            HierarchyLevelId: '{{ HierarchyLevelId }}'
            Name: '{{ Name }}'
          LevelTwo:
            HierarchyLevelArn: null
            HierarchyLevelId: null
            Name: null
          LevelThree:
            HierarchyLevelArn: null
            HierarchyLevelId: null
            Name: null
          LevelFour:
            HierarchyLevelArn: null
            HierarchyLevelId: null
            Name: null
          LevelFive:
            HierarchyLevelArn: null
            HierarchyLevelId: null
            Name: null

DELETE example

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

Permissions

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

Create

connect:UpdateUserHierarchyStructure

Read

connect:DescribeUserHierarchyStructure

Delete

connect:UpdateUserHierarchyStructure

Update

connect:UpdateUserHierarchyStructure