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	awscc.connect.user_hierarchy_groups

Fields

get (all properties)

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.
name	string	The name of the user hierarchy group.
▶tags	array	One or more tags.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
user_hierarchy_group_arn	string	The Amazon Resource Name (ARN) for the user hierarchy group.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	user_hierarchy_groups	INSERT	Name, InstanceArn, region
delete_resource	user_hierarchy_groups	DELETE	Identifier, region
update_resource	user_hierarchy_groups	UPDATE	Identifier, PatchDocument, region
list_resources	user_hierarchy_groups_list_only	SELECT	region
get_resource	user_hierarchy_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual user_hierarchy_group.

SELECT
  region,
  instance_arn,
  user_hierarchy_group_arn,
  parent_group_arn,
  name,
  tags
FROM awscc.connect.user_hierarchy_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_hierarchy_group_arn }}';

list (identifiers only)

Lists all user_hierarchy_groups in a region.

SELECT
  region,
  user_hierarchy_group_arn
FROM awscc.connect.user_hierarchy_groups_list_only
WHERE
  region = '{{ region }}';

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 awscc.connect.user_hierarchy_groups (
  InstanceArn,
  Name,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.user_hierarchy_groups (
  InstanceArn,
  ParentGroupArn,
  Name,
  Tags,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ parent_group_arn }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ 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: user_hierarchy_group
  props:
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: parent_group_arn
      value: '{{ parent_group_arn }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.connect.user_hierarchy_groups
SET PatchDocument = string('{{ {
    "InstanceArn": instance_arn,
    "Name": name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_hierarchy_group_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.connect.user_hierarchy_groups
WHERE
  Identifier = '{{ user_hierarchy_group_arn }}' 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 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