This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Connect::UserHierarchyStructure
<a name="aws-resource-connect-userhierarchystructure"></a>

Contains information about a hierarchy structure.

## Syntax
<a name="aws-resource-connect-userhierarchystructure-syntax"></a>

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

### JSON
<a name="aws-resource-connect-userhierarchystructure-syntax.json"></a>

```
{
  "Type" : "AWS::Connect::UserHierarchyStructure",
  "Properties" : {
      "[InstanceArn](#cfn-connect-userhierarchystructure-instancearn)" : String,
      "[UserHierarchyStructure](#cfn-connect-userhierarchystructure-userhierarchystructure)" : UserHierarchyStructure
    }
}
```

### YAML
<a name="aws-resource-connect-userhierarchystructure-syntax.yaml"></a>

```
Type: AWS::Connect::UserHierarchyStructure
Properties:
  [InstanceArn](#cfn-connect-userhierarchystructure-instancearn): String
  [UserHierarchyStructure](#cfn-connect-userhierarchystructure-userhierarchystructure): 
    UserHierarchyStructure
```

## Properties
<a name="aws-resource-connect-userhierarchystructure-properties"></a>

`InstanceArn`  <a name="cfn-connect-userhierarchystructure-instancearn"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UserHierarchyStructure`  <a name="cfn-connect-userhierarchystructure-userhierarchystructure"></a>
Contains information about a hierarchy structure.  
*Required*: No  
*Type*: [UserHierarchyStructure](aws-properties-connect-userhierarchystructure-userhierarchystructure.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-connect-userhierarchystructure-return-values"></a>

### Ref
<a name="aws-resource-connect-userhierarchystructure-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-connect-userhierarchystructure-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-connect-userhierarchystructure-return-values-fn--getatt-fn--getatt"></a>

`UserHierarchyStructureArn`  <a name="UserHierarchyStructureArn-fn::getatt"></a>
The identifier for the user hierarchy structure.

# AWS::Connect::UserHierarchyStructure LevelFive
<a name="aws-properties-connect-userhierarchystructure-levelfive"></a>

The update for level five.

## Syntax
<a name="aws-properties-connect-userhierarchystructure-levelfive-syntax"></a>

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

### JSON
<a name="aws-properties-connect-userhierarchystructure-levelfive-syntax.json"></a>

```
{
  "[HierarchyLevelArn](#cfn-connect-userhierarchystructure-levelfive-hierarchylevelarn)" : String,
  "[HierarchyLevelId](#cfn-connect-userhierarchystructure-levelfive-hierarchylevelid)" : String,
  "[Name](#cfn-connect-userhierarchystructure-levelfive-name)" : String
}
```

### YAML
<a name="aws-properties-connect-userhierarchystructure-levelfive-syntax.yaml"></a>

```
  [HierarchyLevelArn](#cfn-connect-userhierarchystructure-levelfive-hierarchylevelarn): String
  [HierarchyLevelId](#cfn-connect-userhierarchystructure-levelfive-hierarchylevelid): String
  [Name](#cfn-connect-userhierarchystructure-levelfive-name): String
```

## Properties
<a name="aws-properties-connect-userhierarchystructure-levelfive-properties"></a>

`HierarchyLevelArn`  <a name="cfn-connect-userhierarchystructure-levelfive-hierarchylevelarn"></a>
The Amazon Resource Name (ARN) of the hierarchy level.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group-level/[-0-9]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HierarchyLevelId`  <a name="cfn-connect-userhierarchystructure-levelfive-hierarchylevelid"></a>
The identifier of the hierarchy level.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-connect-userhierarchystructure-levelfive-name"></a>
The name of the hierarchy level.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Connect::UserHierarchyStructure LevelFour
<a name="aws-properties-connect-userhierarchystructure-levelfour"></a>

The update for level four.

## Syntax
<a name="aws-properties-connect-userhierarchystructure-levelfour-syntax"></a>

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

### JSON
<a name="aws-properties-connect-userhierarchystructure-levelfour-syntax.json"></a>

```
{
  "[HierarchyLevelArn](#cfn-connect-userhierarchystructure-levelfour-hierarchylevelarn)" : String,
  "[HierarchyLevelId](#cfn-connect-userhierarchystructure-levelfour-hierarchylevelid)" : String,
  "[Name](#cfn-connect-userhierarchystructure-levelfour-name)" : String
}
```

### YAML
<a name="aws-properties-connect-userhierarchystructure-levelfour-syntax.yaml"></a>

```
  [HierarchyLevelArn](#cfn-connect-userhierarchystructure-levelfour-hierarchylevelarn): String
  [HierarchyLevelId](#cfn-connect-userhierarchystructure-levelfour-hierarchylevelid): String
  [Name](#cfn-connect-userhierarchystructure-levelfour-name): String
```

## Properties
<a name="aws-properties-connect-userhierarchystructure-levelfour-properties"></a>

`HierarchyLevelArn`  <a name="cfn-connect-userhierarchystructure-levelfour-hierarchylevelarn"></a>
The Amazon Resource Name (ARN) of the hierarchy level.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group-level/[-0-9]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HierarchyLevelId`  <a name="cfn-connect-userhierarchystructure-levelfour-hierarchylevelid"></a>
The identifier of the hierarchy level.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-connect-userhierarchystructure-levelfour-name"></a>
The name of the hierarchy level.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Connect::UserHierarchyStructure LevelOne
<a name="aws-properties-connect-userhierarchystructure-levelone"></a>

<a name="aws-properties-connect-userhierarchystructure-levelone-description"></a>The `LevelOne` property type specifies Property description not available. for an [AWS::Connect::UserHierarchyStructure](aws-resource-connect-userhierarchystructure.md).

## Syntax
<a name="aws-properties-connect-userhierarchystructure-levelone-syntax"></a>

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

### JSON
<a name="aws-properties-connect-userhierarchystructure-levelone-syntax.json"></a>

```
{
  "[HierarchyLevelArn](#cfn-connect-userhierarchystructure-levelone-hierarchylevelarn)" : String,
  "[HierarchyLevelId](#cfn-connect-userhierarchystructure-levelone-hierarchylevelid)" : String,
  "[Name](#cfn-connect-userhierarchystructure-levelone-name)" : String
}
```

### YAML
<a name="aws-properties-connect-userhierarchystructure-levelone-syntax.yaml"></a>

```
  [HierarchyLevelArn](#cfn-connect-userhierarchystructure-levelone-hierarchylevelarn): String
  [HierarchyLevelId](#cfn-connect-userhierarchystructure-levelone-hierarchylevelid): String
  [Name](#cfn-connect-userhierarchystructure-levelone-name): String
```

## Properties
<a name="aws-properties-connect-userhierarchystructure-levelone-properties"></a>

`HierarchyLevelArn`  <a name="cfn-connect-userhierarchystructure-levelone-hierarchylevelarn"></a>
The Amazon Resource Name (ARN) of the hierarchy level.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group-level/[-0-9]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HierarchyLevelId`  <a name="cfn-connect-userhierarchystructure-levelone-hierarchylevelid"></a>
The identifier of the hierarchy level.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-connect-userhierarchystructure-levelone-name"></a>
The name of the hierarchy level.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Connect::UserHierarchyStructure LevelThree
<a name="aws-properties-connect-userhierarchystructure-levelthree"></a>

The update for level three.

## Syntax
<a name="aws-properties-connect-userhierarchystructure-levelthree-syntax"></a>

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

### JSON
<a name="aws-properties-connect-userhierarchystructure-levelthree-syntax.json"></a>

```
{
  "[HierarchyLevelArn](#cfn-connect-userhierarchystructure-levelthree-hierarchylevelarn)" : String,
  "[HierarchyLevelId](#cfn-connect-userhierarchystructure-levelthree-hierarchylevelid)" : String,
  "[Name](#cfn-connect-userhierarchystructure-levelthree-name)" : String
}
```

### YAML
<a name="aws-properties-connect-userhierarchystructure-levelthree-syntax.yaml"></a>

```
  [HierarchyLevelArn](#cfn-connect-userhierarchystructure-levelthree-hierarchylevelarn): String
  [HierarchyLevelId](#cfn-connect-userhierarchystructure-levelthree-hierarchylevelid): String
  [Name](#cfn-connect-userhierarchystructure-levelthree-name): String
```

## Properties
<a name="aws-properties-connect-userhierarchystructure-levelthree-properties"></a>

`HierarchyLevelArn`  <a name="cfn-connect-userhierarchystructure-levelthree-hierarchylevelarn"></a>
The Amazon Resource Name (ARN) of the hierarchy level.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group-level/[-0-9]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HierarchyLevelId`  <a name="cfn-connect-userhierarchystructure-levelthree-hierarchylevelid"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-connect-userhierarchystructure-levelthree-name"></a>
The name of the hierarchy level.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Connect::UserHierarchyStructure LevelTwo
<a name="aws-properties-connect-userhierarchystructure-leveltwo"></a>

The update for level two.

## Syntax
<a name="aws-properties-connect-userhierarchystructure-leveltwo-syntax"></a>

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

### JSON
<a name="aws-properties-connect-userhierarchystructure-leveltwo-syntax.json"></a>

```
{
  "[HierarchyLevelArn](#cfn-connect-userhierarchystructure-leveltwo-hierarchylevelarn)" : String,
  "[HierarchyLevelId](#cfn-connect-userhierarchystructure-leveltwo-hierarchylevelid)" : String,
  "[Name](#cfn-connect-userhierarchystructure-leveltwo-name)" : String
}
```

### YAML
<a name="aws-properties-connect-userhierarchystructure-leveltwo-syntax.yaml"></a>

```
  [HierarchyLevelArn](#cfn-connect-userhierarchystructure-leveltwo-hierarchylevelarn): String
  [HierarchyLevelId](#cfn-connect-userhierarchystructure-leveltwo-hierarchylevelid): String
  [Name](#cfn-connect-userhierarchystructure-leveltwo-name): String
```

## Properties
<a name="aws-properties-connect-userhierarchystructure-leveltwo-properties"></a>

`HierarchyLevelArn`  <a name="cfn-connect-userhierarchystructure-leveltwo-hierarchylevelarn"></a>
The Amazon Resource Name (ARN) of the hierarchy level.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group-level/[-0-9]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HierarchyLevelId`  <a name="cfn-connect-userhierarchystructure-leveltwo-hierarchylevelid"></a>
The identifier of the hierarchy level.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-connect-userhierarchystructure-leveltwo-name"></a>
The name of the hierarchy level.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Connect::UserHierarchyStructure UserHierarchyStructure
<a name="aws-properties-connect-userhierarchystructure-userhierarchystructure"></a>

Contains information about a hierarchy structure.

## Syntax
<a name="aws-properties-connect-userhierarchystructure-userhierarchystructure-syntax"></a>

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

### JSON
<a name="aws-properties-connect-userhierarchystructure-userhierarchystructure-syntax.json"></a>

```
{
  "[LevelFive](#cfn-connect-userhierarchystructure-userhierarchystructure-levelfive)" : LevelFive,
  "[LevelFour](#cfn-connect-userhierarchystructure-userhierarchystructure-levelfour)" : LevelFour,
  "[LevelOne](#cfn-connect-userhierarchystructure-userhierarchystructure-levelone)" : LevelOne,
  "[LevelThree](#cfn-connect-userhierarchystructure-userhierarchystructure-levelthree)" : LevelThree,
  "[LevelTwo](#cfn-connect-userhierarchystructure-userhierarchystructure-leveltwo)" : LevelTwo
}
```

### YAML
<a name="aws-properties-connect-userhierarchystructure-userhierarchystructure-syntax.yaml"></a>

```
  [LevelFive](#cfn-connect-userhierarchystructure-userhierarchystructure-levelfive): 
    LevelFive
  [LevelFour](#cfn-connect-userhierarchystructure-userhierarchystructure-levelfour): 
    LevelFour
  [LevelOne](#cfn-connect-userhierarchystructure-userhierarchystructure-levelone): 
    LevelOne
  [LevelThree](#cfn-connect-userhierarchystructure-userhierarchystructure-levelthree): 
    LevelThree
  [LevelTwo](#cfn-connect-userhierarchystructure-userhierarchystructure-leveltwo): 
    LevelTwo
```

## Properties
<a name="aws-properties-connect-userhierarchystructure-userhierarchystructure-properties"></a>

`LevelFive`  <a name="cfn-connect-userhierarchystructure-userhierarchystructure-levelfive"></a>
Property description not available.  
*Required*: No  
*Type*: [LevelFive](aws-properties-connect-userhierarchystructure-levelfive.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LevelFour`  <a name="cfn-connect-userhierarchystructure-userhierarchystructure-levelfour"></a>
The update for level four.  
*Required*: No  
*Type*: [LevelFour](aws-properties-connect-userhierarchystructure-levelfour.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LevelOne`  <a name="cfn-connect-userhierarchystructure-userhierarchystructure-levelone"></a>
The update for level one.  
*Required*: No  
*Type*: [LevelOne](aws-properties-connect-userhierarchystructure-levelone.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LevelThree`  <a name="cfn-connect-userhierarchystructure-userhierarchystructure-levelthree"></a>
The update for level three.  
*Required*: No  
*Type*: [LevelThree](aws-properties-connect-userhierarchystructure-levelthree.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LevelTwo`  <a name="cfn-connect-userhierarchystructure-userhierarchystructure-leveltwo"></a>
The update for level two.  
*Required*: No  
*Type*: [LevelTwo](aws-properties-connect-userhierarchystructure-leveltwo.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)