github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/connect/getUserHierarchyGroup.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package connect

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Provides details about a specific Amazon Connect User Hierarchy Group.
//
// ## Example Usage
//
// By `name`
//
// <!--Start PulumiCodeChooser -->
// ```go
// 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.LookupUserHierarchyGroup(ctx, &connect.LookupUserHierarchyGroupArgs{
//				InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
//				Name:       pulumi.StringRef("Example"),
//			}, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// By `hierarchyGroupId`
//
// <!--Start PulumiCodeChooser -->
// ```go
// 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.LookupUserHierarchyGroup(ctx, &connect.LookupUserHierarchyGroupArgs{
//				InstanceId:       "aaaaaaaa-bbbb-cccc-dddd-111111111111",
//				HierarchyGroupId: pulumi.StringRef("cccccccc-bbbb-cccc-dddd-111111111111"),
//			}, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
func LookupUserHierarchyGroup(ctx *pulumi.Context, args *LookupUserHierarchyGroupArgs, opts ...pulumi.InvokeOption) (*LookupUserHierarchyGroupResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv LookupUserHierarchyGroupResult
	err := ctx.Invoke("aws:connect/getUserHierarchyGroup:getUserHierarchyGroup", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getUserHierarchyGroup.
type LookupUserHierarchyGroupArgs struct {
	// Returns information on a specific hierarchy group by hierarchy group id
	HierarchyGroupId *string `pulumi:"hierarchyGroupId"`
	// Reference to the hosting Amazon Connect Instance
	InstanceId string `pulumi:"instanceId"`
	// Returns information on a specific hierarchy group by name
	Name *string `pulumi:"name"`
	// Map of tags to assign to the hierarchy group.
	Tags map[string]string `pulumi:"tags"`
}

// A collection of values returned by getUserHierarchyGroup.
type LookupUserHierarchyGroupResult struct {
	// ARN of the hierarchy group.
	Arn              string `pulumi:"arn"`
	HierarchyGroupId string `pulumi:"hierarchyGroupId"`
	// Block that contains information about the levels in the hierarchy group. The `hierarchyPath` block is documented below.
	HierarchyPaths []GetUserHierarchyGroupHierarchyPath `pulumi:"hierarchyPaths"`
	// The provider-assigned unique ID for this managed resource.
	Id         string `pulumi:"id"`
	InstanceId string `pulumi:"instanceId"`
	// Identifier of the level in the hierarchy group.
	LevelId string `pulumi:"levelId"`
	// Name of the hierarchy group.
	Name string `pulumi:"name"`
	// Map of tags to assign to the hierarchy group.
	Tags map[string]string `pulumi:"tags"`
}

func LookupUserHierarchyGroupOutput(ctx *pulumi.Context, args LookupUserHierarchyGroupOutputArgs, opts ...pulumi.InvokeOption) LookupUserHierarchyGroupResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (LookupUserHierarchyGroupResult, error) {
			args := v.(LookupUserHierarchyGroupArgs)
			r, err := LookupUserHierarchyGroup(ctx, &args, opts...)
			var s LookupUserHierarchyGroupResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(LookupUserHierarchyGroupResultOutput)
}

// A collection of arguments for invoking getUserHierarchyGroup.
type LookupUserHierarchyGroupOutputArgs struct {
	// Returns information on a specific hierarchy group by hierarchy group id
	HierarchyGroupId pulumi.StringPtrInput `pulumi:"hierarchyGroupId"`
	// Reference to the hosting Amazon Connect Instance
	InstanceId pulumi.StringInput `pulumi:"instanceId"`
	// Returns information on a specific hierarchy group by name
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Map of tags to assign to the hierarchy group.
	Tags pulumi.StringMapInput `pulumi:"tags"`
}

func (LookupUserHierarchyGroupOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupUserHierarchyGroupArgs)(nil)).Elem()
}

// A collection of values returned by getUserHierarchyGroup.
type LookupUserHierarchyGroupResultOutput struct{ *pulumi.OutputState }

func (LookupUserHierarchyGroupResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupUserHierarchyGroupResult)(nil)).Elem()
}

func (o LookupUserHierarchyGroupResultOutput) ToLookupUserHierarchyGroupResultOutput() LookupUserHierarchyGroupResultOutput {
	return o
}

func (o LookupUserHierarchyGroupResultOutput) ToLookupUserHierarchyGroupResultOutputWithContext(ctx context.Context) LookupUserHierarchyGroupResultOutput {
	return o
}

// ARN of the hierarchy group.
func (o LookupUserHierarchyGroupResultOutput) Arn() pulumi.StringOutput {
	return o.ApplyT(func(v LookupUserHierarchyGroupResult) string { return v.Arn }).(pulumi.StringOutput)
}

func (o LookupUserHierarchyGroupResultOutput) HierarchyGroupId() pulumi.StringOutput {
	return o.ApplyT(func(v LookupUserHierarchyGroupResult) string { return v.HierarchyGroupId }).(pulumi.StringOutput)
}

// Block that contains information about the levels in the hierarchy group. The `hierarchyPath` block is documented below.
func (o LookupUserHierarchyGroupResultOutput) HierarchyPaths() GetUserHierarchyGroupHierarchyPathArrayOutput {
	return o.ApplyT(func(v LookupUserHierarchyGroupResult) []GetUserHierarchyGroupHierarchyPath { return v.HierarchyPaths }).(GetUserHierarchyGroupHierarchyPathArrayOutput)
}

// The provider-assigned unique ID for this managed resource.
func (o LookupUserHierarchyGroupResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v LookupUserHierarchyGroupResult) string { return v.Id }).(pulumi.StringOutput)
}

func (o LookupUserHierarchyGroupResultOutput) InstanceId() pulumi.StringOutput {
	return o.ApplyT(func(v LookupUserHierarchyGroupResult) string { return v.InstanceId }).(pulumi.StringOutput)
}

// Identifier of the level in the hierarchy group.
func (o LookupUserHierarchyGroupResultOutput) LevelId() pulumi.StringOutput {
	return o.ApplyT(func(v LookupUserHierarchyGroupResult) string { return v.LevelId }).(pulumi.StringOutput)
}

// Name of the hierarchy group.
func (o LookupUserHierarchyGroupResultOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v LookupUserHierarchyGroupResult) string { return v.Name }).(pulumi.StringOutput)
}

// Map of tags to assign to the hierarchy group.
func (o LookupUserHierarchyGroupResultOutput) Tags() pulumi.StringMapOutput {
	return o.ApplyT(func(v LookupUserHierarchyGroupResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
}

func init() {
	pulumi.RegisterOutputType(LookupUserHierarchyGroupResultOutput{})
}