Resource: awsConnectUserHierarchyGroup
Provides an Amazon Connect User Hierarchy Group resource. For more information see Amazon Connect: Getting Started
\~> NOTE: The User Hierarchy Structure must be created before creating a User Hierarchy Group.
Example Usage
Basic
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.connectUserHierarchyGroup.ConnectUserHierarchyGroup(this, "example", {
instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
name: "example",
tags: {
Name: "Example User Hierarchy Group",
},
});
With a parent group
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsConnectUserHierarchyGroupParent =
new aws.connectUserHierarchyGroup.ConnectUserHierarchyGroup(this, "parent", {
instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
name: "parent",
tags: {
Name: "Example User Hierarchy Group Parent",
},
});
new aws.connectUserHierarchyGroup.ConnectUserHierarchyGroup(this, "child", {
instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
name: "child",
parentGroupId: awsConnectUserHierarchyGroupParent.hierarchyGroupId,
tags: {
Name: "Example User Hierarchy Group Child",
},
});
Argument Reference
The following arguments are supported:
instanceId
- (Required) Specifies the identifier of the hosting Amazon Connect Instance.name
- (Required) The name of the user hierarchy group. Must not be more than 100 characters.parentGroupId
- (Optional) The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.tags
- (Optional) Tags to apply to the hierarchy group. If configured with a providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
arn
- The Amazon Resource Name (ARN) of the hierarchy group.hierarchyGroupId
- The identifier for the hierarchy group.hierarchyPath
- A block that contains information about the levels in the hierarchy group. ThehierarchyPath
block is documented below.id
- The identifier of the hosting Amazon Connect Instance and identifier of the hierarchy group separated by a colon (:
).levelId
- The identifier of the level in the hierarchy group.tagsAll
- A map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
A hierarchyPath
block supports the following attributes:
levelOne
- A block that defines the details of level one. The level block is documented below.levelTwo
- A block that defines the details of level two. The level block is documented below.levelThree
- A block that defines the details of level three. The level block is documented below.levelFour
- A block that defines the details of level four. The level block is documented below.levelFive
- A block that defines the details of level five. The level block is documented below.
A level block supports the following attributes:
arn
- The Amazon Resource Name (ARN) of the hierarchy group.id
- The identifier of the hierarchy group.name
- The name of the hierarchy group.
Import
Amazon Connect User Hierarchy Groups can be imported using the instanceId
and hierarchyGroupId
separated by a colon (:
), e.g.,