pulumi-aws-kotlin/com.pulumi.aws.connect.kotlin/UserHierarchyGroup

UserHierarchyGroup

class UserHierarchyGroup : KotlinCustomResource

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",
    },
});
Content copied to clipboard
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",
    })
Content copied to clipboard
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" },
        },
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:connect:UserHierarchyGroup
    properties:
      instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
      name: example
      tags:
        Name: Example User Hierarchy Group
Content copied to clipboard

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",
    },
});
Content copied to clipboard
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",
    })
Content copied to clipboard
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" },
        },
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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
Content copied to clipboard

Properties

Link copied to clipboard
val arn: Output<String>

The Amazon Resource Name (ARN) of the hierarchy group.

Link copied to clipboard
val hierarchyGroupId: Output<String>

The identifier for the hierarchy group.

Link copied to clipboard
val hierarchyPaths: Output<List<UserHierarchyGroupHierarchyPath>>

A block that contains information about the levels in the hierarchy group. The hierarchy_path block is documented below.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val instanceId: Output<String>

Specifies the identifier of the hosting Amazon Connect Instance.

Link copied to clipboard
val levelId: Output<String>

The identifier of the level in the hierarchy group.

Link copied to clipboard
val name: Output<String>

The name of the user hierarchy group. Must not be more than 100 characters.

Link copied to clipboard
val parentGroupId: Output<String>?

The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val tags: Output<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.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val urn: Output<String>