Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. connect
  5. UserHierarchyGroup
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

aws.connect.UserHierarchyGroup

Explore with Pulumi AI

aws logo
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

    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

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.UserHierarchyGroup("example", {
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "example",
    tags: {
        Name: "Example User Hierarchy Group",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.connect.UserHierarchyGroup("example",
    instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name="example",
    tags={
        "Name": "Example User Hierarchy Group",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewUserHierarchyGroup(ctx, "example", &connect.UserHierarchyGroupArgs{
			InstanceId: pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
			Name:       pulumi.String("example"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example User Hierarchy Group"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.UserHierarchyGroup("example", new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        Name = "example",
        Tags = 
        {
            { "Name", "Example User Hierarchy Group" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.UserHierarchyGroup;
import com.pulumi.aws.connect.UserHierarchyGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new UserHierarchyGroup("example", UserHierarchyGroupArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .name("example")
            .tags(Map.of("Name", "Example User Hierarchy Group"))
            .build());

    }
}

    resources:
  example:
    type: aws:connect:UserHierarchyGroup
    properties:
      instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
      name: example
      tags:
        Name: Example User Hierarchy Group

    With a parent group

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const parent = new aws.connect.UserHierarchyGroup("parent", {
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "parent",
    tags: {
        Name: "Example User Hierarchy Group Parent",
    },
});
const child = new aws.connect.UserHierarchyGroup("child", {
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "child",
    parentGroupId: parent.hierarchyGroupId,
    tags: {
        Name: "Example User Hierarchy Group Child",
    },
});

    import pulumi
import pulumi_aws as aws

parent = aws.connect.UserHierarchyGroup("parent",
    instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name="parent",
    tags={
        "Name": "Example User Hierarchy Group Parent",
    })
child = aws.connect.UserHierarchyGroup("child",
    instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name="child",
    parent_group_id=parent.hierarchy_group_id,
    tags={
        "Name": "Example User Hierarchy Group Child",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		parent, err := connect.NewUserHierarchyGroup(ctx, "parent", &connect.UserHierarchyGroupArgs{
			InstanceId: pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
			Name:       pulumi.String("parent"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example User Hierarchy Group Parent"),
			},
		})
		if err != nil {
			return err
		}
		_, err = connect.NewUserHierarchyGroup(ctx, "child", &connect.UserHierarchyGroupArgs{
			InstanceId:    pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
			Name:          pulumi.String("child"),
			ParentGroupId: parent.HierarchyGroupId,
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example User Hierarchy Group Child"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var parent = new Aws.Connect.UserHierarchyGroup("parent", new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        Name = "parent",
        Tags = 
        {
            { "Name", "Example User Hierarchy Group Parent" },
        },
    });

    var child = new Aws.Connect.UserHierarchyGroup("child", new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        Name = "child",
        ParentGroupId = parent.HierarchyGroupId,
        Tags = 
        {
            { "Name", "Example User Hierarchy Group Child" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.UserHierarchyGroup;
import com.pulumi.aws.connect.UserHierarchyGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var parent = new UserHierarchyGroup("parent", UserHierarchyGroupArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .name("parent")
            .tags(Map.of("Name", "Example User Hierarchy Group Parent"))
            .build());

        var child = new UserHierarchyGroup("child", UserHierarchyGroupArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .name("child")
            .parentGroupId(parent.hierarchyGroupId())
            .tags(Map.of("Name", "Example User Hierarchy Group Child"))
            .build());

    }
}

    resources:
  parent:
    type: aws:connect:UserHierarchyGroup
    properties:
      instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
      name: parent
      tags:
        Name: Example User Hierarchy Group Parent
  child:
    type: aws:connect:UserHierarchyGroup
    properties:
      instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
      name: child
      parentGroupId: ${parent.hierarchyGroupId}
      tags:
        Name: Example User Hierarchy Group Child

    Create UserHierarchyGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserHierarchyGroup(name: string, args: UserHierarchyGroupArgs, opts?: CustomResourceOptions);
    @overload
def UserHierarchyGroup(resource_name: str,
                       args: UserHierarchyGroupArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def UserHierarchyGroup(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       instance_id: Optional[str] = None,
                       name: Optional[str] = None,
                       parent_group_id: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
    func NewUserHierarchyGroup(ctx *Context, name string, args UserHierarchyGroupArgs, opts ...ResourceOption) (*UserHierarchyGroup, error)
    public UserHierarchyGroup(string name, UserHierarchyGroupArgs args, CustomResourceOptions? opts = null)
    public UserHierarchyGroup(String name, UserHierarchyGroupArgs args)
public UserHierarchyGroup(String name, UserHierarchyGroupArgs args, CustomResourceOptions options)

    type: aws:connect:UserHierarchyGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UserHierarchyGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserHierarchyGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserHierarchyGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserHierarchyGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserHierarchyGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userHierarchyGroupResource = new Aws.Connect.UserHierarchyGroup("userHierarchyGroupResource", new()
{
    InstanceId = "string",
    Name = "string",
    ParentGroupId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := connect.NewUserHierarchyGroup(ctx, "userHierarchyGroupResource", &connect.UserHierarchyGroupArgs{
	InstanceId:    pulumi.String("string"),
	Name:          pulumi.String("string"),
	ParentGroupId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var userHierarchyGroupResource = new UserHierarchyGroup("userHierarchyGroupResource", UserHierarchyGroupArgs.builder()
    .instanceId("string")
    .name("string")
    .parentGroupId("string")
    .tags(Map.of("string", "string"))
    .build());

    user_hierarchy_group_resource = aws.connect.UserHierarchyGroup("userHierarchyGroupResource",
    instance_id="string",
    name="string",
    parent_group_id="string",
    tags={
        "string": "string",
    })

    const userHierarchyGroupResource = new aws.connect.UserHierarchyGroup("userHierarchyGroupResource", {
    instanceId: "string",
    name: "string",
    parentGroupId: "string",
    tags: {
        string: "string",
    },
});

    type: aws:connect:UserHierarchyGroup
properties:
    instanceId: string
    name: string
    parentGroupId: string
    tags:
        string: string

    UserHierarchyGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UserHierarchyGroup resource accepts the following input properties:

    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    ParentGroupId string
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    Tags Dictionary<string, string>
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    ParentGroupId string
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    Tags map[string]string
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.
    parentGroupId String
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    tags Map<String,String>
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    instanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    parentGroupId string
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    tags {[key: string]: string}
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    instance_id str
    Specifies the identifier of the hosting Amazon Connect Instance.
    name str
    The name of the user hierarchy group. Must not be more than 100 characters.
    parent_group_id str
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    tags Mapping[str, str]
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.
    parentGroupId String
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    tags Map<String>
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserHierarchyGroup resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    HierarchyGroupId string
    The identifier for the hierarchy group.
    HierarchyPaths List<UserHierarchyGroupHierarchyPath>
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    LevelId string
    The identifier of the level in the hierarchy group.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    HierarchyGroupId string
    The identifier for the hierarchy group.
    HierarchyPaths []UserHierarchyGroupHierarchyPath
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    LevelId string
    The identifier of the level in the hierarchy group.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    hierarchyGroupId String
    The identifier for the hierarchy group.
    hierarchyPaths List<UserHierarchyGroupHierarchyPath>
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    levelId String
    The identifier of the level in the hierarchy group.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    hierarchyGroupId string
    The identifier for the hierarchy group.
    hierarchyPaths UserHierarchyGroupHierarchyPath[]
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    levelId string
    The identifier of the level in the hierarchy group.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) of the hierarchy group.
    hierarchy_group_id str
    The identifier for the hierarchy group.
    hierarchy_paths Sequence[UserHierarchyGroupHierarchyPath]
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    level_id str
    The identifier of the level in the hierarchy group.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    hierarchyGroupId String
    The identifier for the hierarchy group.
    hierarchyPaths List<Property Map>
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    levelId String
    The identifier of the level in the hierarchy group.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing UserHierarchyGroup Resource

    Get an existing UserHierarchyGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserHierarchyGroupState, opts?: CustomResourceOptions): UserHierarchyGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        hierarchy_group_id: Optional[str] = None,
        hierarchy_paths: Optional[Sequence[UserHierarchyGroupHierarchyPathArgs]] = None,
        instance_id: Optional[str] = None,
        level_id: Optional[str] = None,
        name: Optional[str] = None,
        parent_group_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> UserHierarchyGroup
    func GetUserHierarchyGroup(ctx *Context, name string, id IDInput, state *UserHierarchyGroupState, opts ...ResourceOption) (*UserHierarchyGroup, error)
    public static UserHierarchyGroup Get(string name, Input<string> id, UserHierarchyGroupState? state, CustomResourceOptions? opts = null)
    public static UserHierarchyGroup get(String name, Output<String> id, UserHierarchyGroupState state, CustomResourceOptions options)
    resources:  _:    type: aws:connect:UserHierarchyGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    HierarchyGroupId string
    The identifier for the hierarchy group.
    HierarchyPaths List<UserHierarchyGroupHierarchyPath>
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    LevelId string
    The identifier of the level in the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    ParentGroupId string
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    Tags Dictionary<string, string>
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    HierarchyGroupId string
    The identifier for the hierarchy group.
    HierarchyPaths []UserHierarchyGroupHierarchyPathArgs
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    LevelId string
    The identifier of the level in the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    ParentGroupId string
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    Tags map[string]string
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    hierarchyGroupId String
    The identifier for the hierarchy group.
    hierarchyPaths List<UserHierarchyGroupHierarchyPath>
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    levelId String
    The identifier of the level in the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.
    parentGroupId String
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    tags Map<String,String>
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    hierarchyGroupId string
    The identifier for the hierarchy group.
    hierarchyPaths UserHierarchyGroupHierarchyPath[]
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    instanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    levelId string
    The identifier of the level in the hierarchy group.
    name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    parentGroupId string
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    tags {[key: string]: string}
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) of the hierarchy group.
    hierarchy_group_id str
    The identifier for the hierarchy group.
    hierarchy_paths Sequence[UserHierarchyGroupHierarchyPathArgs]
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    instance_id str
    Specifies the identifier of the hosting Amazon Connect Instance.
    level_id str
    The identifier of the level in the hierarchy group.
    name str
    The name of the user hierarchy group. Must not be more than 100 characters.
    parent_group_id str
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    tags Mapping[str, str]
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    hierarchyGroupId String
    The identifier for the hierarchy group.
    hierarchyPaths List<Property Map>
    A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    levelId String
    The identifier of the level in the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.
    parentGroupId String
    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
    tags Map<String>
    Tags to apply to the hierarchy group. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    UserHierarchyGroupHierarchyPath, UserHierarchyGroupHierarchyPathArgs

    LevelFives List<UserHierarchyGroupHierarchyPathLevelFife>
    A block that defines the details of level five. The level block is documented below.
    LevelFours List<UserHierarchyGroupHierarchyPathLevelFour>
    A block that defines the details of level four. The level block is documented below.
    LevelOnes List<UserHierarchyGroupHierarchyPathLevelOne>
    A block that defines the details of level one. The level block is documented below.
    LevelThrees List<UserHierarchyGroupHierarchyPathLevelThree>
    A block that defines the details of level three. The level block is documented below.
    LevelTwos List<UserHierarchyGroupHierarchyPathLevelTwo>
    A block that defines the details of level two. The level block is documented below.
    LevelFives []UserHierarchyGroupHierarchyPathLevelFife
    A block that defines the details of level five. The level block is documented below.
    LevelFours []UserHierarchyGroupHierarchyPathLevelFour
    A block that defines the details of level four. The level block is documented below.
    LevelOnes []UserHierarchyGroupHierarchyPathLevelOne
    A block that defines the details of level one. The level block is documented below.
    LevelThrees []UserHierarchyGroupHierarchyPathLevelThree
    A block that defines the details of level three. The level block is documented below.
    LevelTwos []UserHierarchyGroupHierarchyPathLevelTwo
    A block that defines the details of level two. The level block is documented below.
    levelFives List<UserHierarchyGroupHierarchyPathLevelFife>
    A block that defines the details of level five. The level block is documented below.
    levelFours List<UserHierarchyGroupHierarchyPathLevelFour>
    A block that defines the details of level four. The level block is documented below.
    levelOnes List<UserHierarchyGroupHierarchyPathLevelOne>
    A block that defines the details of level one. The level block is documented below.
    levelThrees List<UserHierarchyGroupHierarchyPathLevelThree>
    A block that defines the details of level three. The level block is documented below.
    levelTwos List<UserHierarchyGroupHierarchyPathLevelTwo>
    A block that defines the details of level two. The level block is documented below.
    levelFives UserHierarchyGroupHierarchyPathLevelFife[]
    A block that defines the details of level five. The level block is documented below.
    levelFours UserHierarchyGroupHierarchyPathLevelFour[]
    A block that defines the details of level four. The level block is documented below.
    levelOnes UserHierarchyGroupHierarchyPathLevelOne[]
    A block that defines the details of level one. The level block is documented below.
    levelThrees UserHierarchyGroupHierarchyPathLevelThree[]
    A block that defines the details of level three. The level block is documented below.
    levelTwos UserHierarchyGroupHierarchyPathLevelTwo[]
    A block that defines the details of level two. The level block is documented below.
    level_fives Sequence[UserHierarchyGroupHierarchyPathLevelFife]
    A block that defines the details of level five. The level block is documented below.
    level_fours Sequence[UserHierarchyGroupHierarchyPathLevelFour]
    A block that defines the details of level four. The level block is documented below.
    level_ones Sequence[UserHierarchyGroupHierarchyPathLevelOne]
    A block that defines the details of level one. The level block is documented below.
    level_threes Sequence[UserHierarchyGroupHierarchyPathLevelThree]
    A block that defines the details of level three. The level block is documented below.
    level_twos Sequence[UserHierarchyGroupHierarchyPathLevelTwo]
    A block that defines the details of level two. The level block is documented below.
    levelFives List<Property Map>
    A block that defines the details of level five. The level block is documented below.
    levelFours List<Property Map>
    A block that defines the details of level four. The level block is documented below.
    levelOnes List<Property Map>
    A block that defines the details of level one. The level block is documented below.
    levelThrees List<Property Map>
    A block that defines the details of level three. The level block is documented below.
    levelTwos List<Property Map>
    A block that defines the details of level two. The level block is documented below.

    UserHierarchyGroupHierarchyPathLevelFife, UserHierarchyGroupHierarchyPathLevelFifeArgs

    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    Id string
    The identifier of the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    Id string
    The identifier of the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    id String
    The identifier of the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    id string
    The identifier of the hierarchy group.
    name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn str
    The Amazon Resource Name (ARN) of the hierarchy group.
    id str
    The identifier of the hierarchy group.
    name str
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    id String
    The identifier of the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.

    UserHierarchyGroupHierarchyPathLevelFour, UserHierarchyGroupHierarchyPathLevelFourArgs

    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    Id string
    The identifier of the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    Id string
    The identifier of the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    id String
    The identifier of the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    id string
    The identifier of the hierarchy group.
    name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn str
    The Amazon Resource Name (ARN) of the hierarchy group.
    id str
    The identifier of the hierarchy group.
    name str
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    id String
    The identifier of the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.

    UserHierarchyGroupHierarchyPathLevelOne, UserHierarchyGroupHierarchyPathLevelOneArgs

    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    Id string
    The identifier of the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    Id string
    The identifier of the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    id String
    The identifier of the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    id string
    The identifier of the hierarchy group.
    name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn str
    The Amazon Resource Name (ARN) of the hierarchy group.
    id str
    The identifier of the hierarchy group.
    name str
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    id String
    The identifier of the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.

    UserHierarchyGroupHierarchyPathLevelThree, UserHierarchyGroupHierarchyPathLevelThreeArgs

    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    Id string
    The identifier of the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    Id string
    The identifier of the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    id String
    The identifier of the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    id string
    The identifier of the hierarchy group.
    name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn str
    The Amazon Resource Name (ARN) of the hierarchy group.
    id str
    The identifier of the hierarchy group.
    name str
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    id String
    The identifier of the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.

    UserHierarchyGroupHierarchyPathLevelTwo, UserHierarchyGroupHierarchyPathLevelTwoArgs

    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    Id string
    The identifier of the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    Arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    Id string
    The identifier of the hierarchy group.
    Name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    id String
    The identifier of the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn string
    The Amazon Resource Name (ARN) of the hierarchy group.
    id string
    The identifier of the hierarchy group.
    name string
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn str
    The Amazon Resource Name (ARN) of the hierarchy group.
    id str
    The identifier of the hierarchy group.
    name str
    The name of the user hierarchy group. Must not be more than 100 characters.
    arn String
    The Amazon Resource Name (ARN) of the hierarchy group.
    id String
    The identifier of the hierarchy group.
    name String
    The name of the user hierarchy group. Must not be more than 100 characters.

    Import

    Using pulumi import, import Amazon Connect User Hierarchy Groups using the instance_id and hierarchy_group_id separated by a colon (:). For example:

    $ pulumi import aws:connect/userHierarchyGroup:UserHierarchyGroup example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-aws