@pulumi/aws/quicksight/getQuicksightGroup.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * This data source can be used to fetch information about a specific
 * QuickSight group. By using this data source, you can reference QuickSight group
 * properties without having to hard code ARNs or unique IDs as input.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.quicksight.getQuicksightGroup({
 *     groupName: "example",
 * });
 * ```
 */
export declare function getQuicksightGroup(args: GetQuicksightGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetQuicksightGroupResult>;
/**
 * A collection of arguments for invoking getQuicksightGroup.
 */
export interface GetQuicksightGroupArgs {
    awsAccountId?: string;
    /**
     * The name of the group that you want to match.
     *
     * The following arguments are optional:
     */
    groupName: string;
    /**
     * QuickSight namespace. Defaults to `default`.
     */
    namespace?: 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;
}
/**
 * A collection of values returned by getQuicksightGroup.
 */
export interface GetQuicksightGroupResult {
    /**
     * The Amazon Resource Name (ARN) for the group.
     */
    readonly arn: string;
    readonly awsAccountId: string;
    /**
     * The group description.
     */
    readonly description: string;
    readonly groupName: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly namespace?: string;
    /**
     * The principal ID of the group.
     */
    readonly principalId: string;
    readonly region: string;
}
/**
 * This data source can be used to fetch information about a specific
 * QuickSight group. By using this data source, you can reference QuickSight group
 * properties without having to hard code ARNs or unique IDs as input.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.quicksight.getQuicksightGroup({
 *     groupName: "example",
 * });
 * ```
 */
export declare function getQuicksightGroupOutput(args: GetQuicksightGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetQuicksightGroupResult>;
/**
 * A collection of arguments for invoking getQuicksightGroup.
 */
export interface GetQuicksightGroupOutputArgs {
    awsAccountId?: pulumi.Input<string>;
    /**
     * The name of the group that you want to match.
     *
     * The following arguments are optional:
     */
    groupName: pulumi.Input<string>;
    /**
     * QuickSight namespace. Defaults to `default`.
     */
    namespace?: 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>;
}