Package com.pulumi.aws.connect
Class UserHierarchyGroup
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.connect.UserHierarchyGroup
-
public class UserHierarchyGroup extends com.pulumi.resources.CustomResourceProvides an Amazon Connect User Hierarchy Group resource. For more information see [Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.html) > **NOTE:** The User Hierarchy Structure must be created before creating a User Hierarchy Group. ## Example Usage ### Basic
### With a parent grouppackage 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.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 UserHierarchyGroup("example", UserHierarchyGroupArgs.builder() .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111") .name("example") .tags(Map.of("Name", "Example User Hierarchy Group")) .build()); } }
## Import Using `pulumi import`, import Amazon Connect User Hierarchy Groups using the `instanceId` and `hierarchyGroupId` separated by a colon (`:`). For example: ```sh $ pulumi import aws:connect/userHierarchyGroup:UserHierarchyGroup example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ```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.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 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()); } }
-
-
Constructor Summary
Constructors Constructor Description UserHierarchyGroup(java.lang.String name)UserHierarchyGroup(java.lang.String name, UserHierarchyGroupArgs args)UserHierarchyGroup(java.lang.String name, UserHierarchyGroupArgs args, com.pulumi.resources.CustomResourceOptions options)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.lang.String>arn()static UserHierarchyGroupget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserHierarchyGroupState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>hierarchyGroupId()com.pulumi.core.Output<java.util.List<UserHierarchyGroupHierarchyPath>>hierarchyPaths()com.pulumi.core.Output<java.lang.String>instanceId()com.pulumi.core.Output<java.lang.String>levelId()com.pulumi.core.Output<java.lang.String>name()com.pulumi.core.Output<java.util.Optional<java.lang.String>>parentGroupId()com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>tags()com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>tagsAll()
-
-
-
Constructor Detail
-
UserHierarchyGroup
public UserHierarchyGroup(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
UserHierarchyGroup
public UserHierarchyGroup(java.lang.String name, UserHierarchyGroupArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
UserHierarchyGroup
public UserHierarchyGroup(java.lang.String name, UserHierarchyGroupArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- The ARN of the hierarchy group.
-
hierarchyGroupId
public com.pulumi.core.Output<java.lang.String> hierarchyGroupId()
- Returns:
- The identifier for the hierarchy group.
-
hierarchyPaths
public com.pulumi.core.Output<java.util.List<UserHierarchyGroupHierarchyPath>> hierarchyPaths()
- Returns:
- A block that contains information about the levels in the hierarchy group. The `hierarchyPath` block is documented below.
-
instanceId
public com.pulumi.core.Output<java.lang.String> instanceId()
- Returns:
- Specifies the identifier of the hosting Amazon Connect Instance.
-
levelId
public com.pulumi.core.Output<java.lang.String> levelId()
- Returns:
- The identifier of the level in the hierarchy group.
-
name
public com.pulumi.core.Output<java.lang.String> name()
- Returns:
- The name of the user hierarchy group. Must not be more than 100 characters.
-
parentGroupId
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> parentGroupId()
- Returns:
- The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
tags
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Tags to apply to the hierarchy group. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
get
public static UserHierarchyGroup get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable UserHierarchyGroupState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-