@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
155 lines (154 loc) • 4.62 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Provides details about a specific Amazon Connect User Hierarchy Group.
*
* ## Example Usage
*
* By `name`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getUserHierarchyGroup({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "Example",
* });
* ```
*
* By `hierarchyGroupId`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getUserHierarchyGroup({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* hierarchyGroupId: "cccccccc-bbbb-cccc-dddd-111111111111",
* });
* ```
*/
export declare function getUserHierarchyGroup(args: GetUserHierarchyGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetUserHierarchyGroupResult>;
/**
* A collection of arguments for invoking getUserHierarchyGroup.
*/
export interface GetUserHierarchyGroupArgs {
/**
* Returns information on a specific hierarchy group by hierarchy group id
*/
hierarchyGroupId?: string;
/**
* Reference to the hosting Amazon Connect Instance
*/
instanceId: string;
/**
* Returns information on a specific hierarchy group by name
*
* > **NOTE:** `instanceId` and one of either `name` or `hierarchyGroupId` is required.
*/
name?: string;
/**
* 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.
*/
region?: string;
/**
* Map of tags to assign to the hierarchy group.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getUserHierarchyGroup.
*/
export interface GetUserHierarchyGroupResult {
/**
* ARN of the hierarchy group.
*/
readonly arn: string;
readonly hierarchyGroupId: string;
/**
* Block that contains information about the levels in the hierarchy group. The `hierarchyPath` block is documented below.
*/
readonly hierarchyPaths: outputs.connect.GetUserHierarchyGroupHierarchyPath[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly instanceId: string;
/**
* Identifier of the level in the hierarchy group.
*/
readonly levelId: string;
/**
* Name of the hierarchy group.
*/
readonly name: string;
readonly region: string;
/**
* Map of tags to assign to the hierarchy group.
*/
readonly tags: {
[key: string]: string;
};
}
/**
* Provides details about a specific Amazon Connect User Hierarchy Group.
*
* ## Example Usage
*
* By `name`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getUserHierarchyGroup({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "Example",
* });
* ```
*
* By `hierarchyGroupId`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getUserHierarchyGroup({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* hierarchyGroupId: "cccccccc-bbbb-cccc-dddd-111111111111",
* });
* ```
*/
export declare function getUserHierarchyGroupOutput(args: GetUserHierarchyGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetUserHierarchyGroupResult>;
/**
* A collection of arguments for invoking getUserHierarchyGroup.
*/
export interface GetUserHierarchyGroupOutputArgs {
/**
* Returns information on a specific hierarchy group by hierarchy group id
*/
hierarchyGroupId?: pulumi.Input<string>;
/**
* Reference to the hosting Amazon Connect Instance
*/
instanceId: pulumi.Input<string>;
/**
* Returns information on a specific hierarchy group by name
*
* > **NOTE:** `instanceId` and one of either `name` or `hierarchyGroupId` is required.
*/
name?: pulumi.Input<string>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* Map of tags to assign to the hierarchy group.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}