Specifies a new user hierarchy group.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Connect::UserHierarchyGroup",
"Properties" : {
"InstanceArn" : String,
"Name" : String,
"ParentGroupArn" : String,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::Connect::UserHierarchyGroup
Properties:
InstanceArn: String
Name: String
ParentGroupArn: String
Tags:
- Tag
Properties
InstanceArn-
The Amazon Resource Name (ARN) of the user hierarchy group.
Required: Yes
Type: String
Pattern:
^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$Update requires: No interruption
Name-
The name of the user hierarchy group.
Required: Yes
Type: String
Minimum:
1Maximum:
100Update requires: No interruption
ParentGroupArn-
The Amazon Resource Name (ARN) of the parent group.
Required: No
Type: String
Pattern:
^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group/[-a-zA-Z0-9]*$Update requires: Replacement
-
An array of key-value pairs to apply to this resource.
Required: No
Type: Array of Tag
Maximum:
50Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the user hierarchy group. For example:
{ "Ref": "myUserHierarchyGroup" }
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
UserHierarchyGroupArn-
The Amazon Resource Name (ARN) of the user hierarchy group.
Examples
Specify a user hierarchy group
The following example specifies a user hierarchy group for an Amazon Connect instance. This example specifies a user hierachy group for the instance on top of existing HierarchyStructure
YAML
AWSTemplateFormatVersion: 2010-09-09
Description: Specifies a user hierarchy group for an Amazon Connect instance
Resources:
HierarchyGroup:
Type: 'AWS::Connect::UserHierarchyGroup'
Properties:
Name: 'exampleUserHierarchyGroup'
InstanceArn: 'arn:aws:connect:region-name:aws-account-id:instance/instance-arn'