AWS::Connect::UserHierarchyStructure - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Connect::UserHierarchyStructure

Contains information about a hierarchy structure.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Connect::UserHierarchyStructure",
  "Properties" : {
      "InstanceArn" : String,
      "UserHierarchyStructure" : UserHierarchyStructure
    }
}

YAML

Type: AWS::Connect::UserHierarchyStructure
Properties:
  InstanceArn: String
  UserHierarchyStructure: 
    UserHierarchyStructure

Properties

InstanceArn

The Amazon Resource Name (ARN) of the instance.

Required: Yes

Type: String

Pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$

Update requires: Replacement

UserHierarchyStructure

Contains information about a hierarchy structure.

Required: No

Type: UserHierarchyStructure

Update 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 structure. For example:

{ "Ref": "myhierarchystructure" }

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.

UserHierarchyStructureArn

The identifier for the user hierarchy structure.