UserHierarchyStructure class

Provides an Amazon Connect User Hierarchy Structure resource. For more information see Amazon Connect: Getting Started

Example Usage

Basic

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

const example = new aws.connect.UserHierarchyStructure("example", {
    hierarchyStructure: {
        levelOne: {
            name: "levelone",
        },
    },
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
});
import pulumi
import pulumi_aws as aws

example = aws.connect.UserHierarchyStructure("example",
    hierarchy_structure={
        "level_one": {
            "name": "levelone",
        },
    },
    instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Connect.UserHierarchyStructure("example", new()
    {
        HierarchyStructure = new Aws.Connect.Inputs.UserHierarchyStructureHierarchyStructureArgs
        {
            LevelOne = new Aws.Connect.Inputs.UserHierarchyStructureHierarchyStructureLevelOneArgs
            {
                Name = "levelone",
            },
        },
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewUserHierarchyStructure(ctx, "example", &connect.UserHierarchyStructureArgs{
			HierarchyStructure: &connect.UserHierarchyStructureHierarchyStructureArgs{
				LevelOne: &connect.UserHierarchyStructureHierarchyStructureLevelOneArgs{
					Name: pulumi.String("levelone"),
				},
			},
			InstanceId: pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_connect_userhierarchystructure" "example" {
  hierarchy_structure = {
    level_one = {
      name = "levelone"
    }
  }
  instance_id = "aaaaaaaa-bbbb-cccc-dddd-111111111111"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.UserHierarchyStructure;
import com.pulumi.aws.connect.UserHierarchyStructureArgs;
import com.pulumi.aws.connect.inputs.UserHierarchyStructureHierarchyStructureArgs;
import com.pulumi.aws.connect.inputs.UserHierarchyStructureHierarchyStructureLevelOneArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 UserHierarchyStructure("example", UserHierarchyStructureArgs.builder()
            .hierarchyStructure(UserHierarchyStructureHierarchyStructureArgs.builder()
                .levelOne(UserHierarchyStructureHierarchyStructureLevelOneArgs.builder()
                    .name("levelone")
                    .build())
                .build())
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .build());

    }
}
resources:
  example:
    type: aws:connect:UserHierarchyStructure
    properties:
      hierarchyStructure:
        levelOne:
          name: levelone
      instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111

With Five Levels

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

const example = new aws.connect.UserHierarchyStructure("example", {
    hierarchyStructure: {
        levelOne: {
            name: "levelone",
        },
        levelTwo: {
            name: "leveltwo",
        },
        levelThree: {
            name: "levelthree",
        },
        levelFour: {
            name: "levelfour",
        },
        levelFive: {
            name: "levelfive",
        },
    },
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
});
import pulumi
import pulumi_aws as aws

example = aws.connect.UserHierarchyStructure("example",
    hierarchy_structure={
        "level_one": {
            "name": "levelone",
        },
        "level_two": {
            "name": "leveltwo",
        },
        "level_three": {
            "name": "levelthree",
        },
        "level_four": {
            "name": "levelfour",
        },
        "level_five": {
            "name": "levelfive",
        },
    },
    instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Connect.UserHierarchyStructure("example", new()
    {
        HierarchyStructure = new Aws.Connect.Inputs.UserHierarchyStructureHierarchyStructureArgs
        {
            LevelOne = new Aws.Connect.Inputs.UserHierarchyStructureHierarchyStructureLevelOneArgs
            {
                Name = "levelone",
            },
            LevelTwo = new Aws.Connect.Inputs.UserHierarchyStructureHierarchyStructureLevelTwoArgs
            {
                Name = "leveltwo",
            },
            LevelThree = new Aws.Connect.Inputs.UserHierarchyStructureHierarchyStructureLevelThreeArgs
            {
                Name = "levelthree",
            },
            LevelFour = new Aws.Connect.Inputs.UserHierarchyStructureHierarchyStructureLevelFourArgs
            {
                Name = "levelfour",
            },
            LevelFive = new Aws.Connect.Inputs.UserHierarchyStructureHierarchyStructureLevelFiveArgs
            {
                Name = "levelfive",
            },
        },
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewUserHierarchyStructure(ctx, "example", &connect.UserHierarchyStructureArgs{
			HierarchyStructure: &connect.UserHierarchyStructureHierarchyStructureArgs{
				LevelOne: &connect.UserHierarchyStructureHierarchyStructureLevelOneArgs{
					Name: pulumi.String("levelone"),
				},
				LevelTwo: &connect.UserHierarchyStructureHierarchyStructureLevelTwoArgs{
					Name: pulumi.String("leveltwo"),
				},
				LevelThree: &connect.UserHierarchyStructureHierarchyStructureLevelThreeArgs{
					Name: pulumi.String("levelthree"),
				},
				LevelFour: &connect.UserHierarchyStructureHierarchyStructureLevelFourArgs{
					Name: pulumi.String("levelfour"),
				},
				LevelFive: &connect.UserHierarchyStructureHierarchyStructureLevelFiveArgs{
					Name: pulumi.String("levelfive"),
				},
			},
			InstanceId: pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_connect_userhierarchystructure" "example" {
  hierarchy_structure = {
    level_one = {
      name = "levelone"
    }
    level_two = {
      name = "leveltwo"
    }
    level_three = {
      name = "levelthree"
    }
    level_four = {
      name = "levelfour"
    }
    level_five = {
      name = "levelfive"
    }
  }
  instance_id = "aaaaaaaa-bbbb-cccc-dddd-111111111111"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.UserHierarchyStructure;
import com.pulumi.aws.connect.UserHierarchyStructureArgs;
import com.pulumi.aws.connect.inputs.UserHierarchyStructureHierarchyStructureArgs;
import com.pulumi.aws.connect.inputs.UserHierarchyStructureHierarchyStructureLevelOneArgs;
import com.pulumi.aws.connect.inputs.UserHierarchyStructureHierarchyStructureLevelTwoArgs;
import com.pulumi.aws.connect.inputs.UserHierarchyStructureHierarchyStructureLevelThreeArgs;
import com.pulumi.aws.connect.inputs.UserHierarchyStructureHierarchyStructureLevelFourArgs;
import com.pulumi.aws.connect.inputs.UserHierarchyStructureHierarchyStructureLevelFiveArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 UserHierarchyStructure("example", UserHierarchyStructureArgs.builder()
            .hierarchyStructure(UserHierarchyStructureHierarchyStructureArgs.builder()
                .levelOne(UserHierarchyStructureHierarchyStructureLevelOneArgs.builder()
                    .name("levelone")
                    .build())
                .levelTwo(UserHierarchyStructureHierarchyStructureLevelTwoArgs.builder()
                    .name("leveltwo")
                    .build())
                .levelThree(UserHierarchyStructureHierarchyStructureLevelThreeArgs.builder()
                    .name("levelthree")
                    .build())
                .levelFour(UserHierarchyStructureHierarchyStructureLevelFourArgs.builder()
                    .name("levelfour")
                    .build())
                .levelFive(UserHierarchyStructureHierarchyStructureLevelFiveArgs.builder()
                    .name("levelfive")
                    .build())
                .build())
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .build());

    }
}
resources:
  example:
    type: aws:connect:UserHierarchyStructure
    properties:
      hierarchyStructure:
        levelOne:
          name: levelone
        levelTwo:
          name: leveltwo
        levelThree:
          name: levelthree
        levelFour:
          name: levelfour
        levelFive:
          name: levelfive
      instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111

Import

Using pulumi import, import Amazon Connect User Hierarchy Structures using the instanceId. For example:

$ pulumi import aws:connect/userHierarchyStructure:UserHierarchyStructure example f1288a1f-6193-445a-b47e-af739b2

Constructors

UserHierarchyStructure(String name, {UserHierarchyStructureArgs? args, CustomResourceOptions? options})
Creates a new UserHierarchyStructure. name The Pulumi resource name. args Arguments used to configure this UserHierarchyStructure. The set of arguments for UserHierarchyStructure. options Resource options controlling this resource's behavior.
UserHierarchyStructure.reference(String urn)
Creates a typed reference to an existing UserHierarchyStructure resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
hierarchyStructure ↔ Output<UserHierarchyStructureHierarchyStructure>
A block that defines the hierarchy structure's levels. The hierarchyStructure block is documented below.
latefinal
id ↔ Output<String>
getter/setter pairinherited
instanceId ↔ Output<String>
Specifies the identifier of the hosting Amazon Connect Instance.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {UserHierarchyStructureState? state, CustomResourceOptions? options}) → UserHierarchyStructure
Gets an existing UserHierarchyStructure resource's state with the given name and id.