@pierskarsenbarg/sdm/getGroup.d.ts

A Pulumi package for creating and managing StrongDM cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * A Group is a named set of principals.
 * ## Example Usage
 *
 * <!--Start PulumiCodeChooser -->
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as sdm from "@pierskarsenbarg/sdm";
 *
 * const securityTeam = sdm.getGroup({
 *     name: "Security Team",
 * });
 * const administrators = sdm.getGroup({
 *     id: "group-1234567890abcdef",
 * });
 * const adminTeams = sdm.getGroup({
 *     tags: {
 *         admin: "true",
 *     },
 * });
 * ```
 * <!--End PulumiCodeChooser -->
 */
export declare function getGroup(args?: GetGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupResult>;
/**
 * A collection of arguments for invoking getGroup.
 */
export interface GetGroupArgs {
    /**
     * Description of the Group.
     */
    description?: string;
    /**
     * Unique identifier of the Group.
     */
    id?: string;
    /**
     * Unique human-readable name of the Group.
     */
    name?: string;
    /**
     * Tags is a map of key/value pairs that can be attached to a Group.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getGroup.
 */
export interface GetGroupResult {
    /**
     * Description of the Group.
     */
    readonly description?: string;
    /**
     * A list where each element has the following attributes:
     */
    readonly groups: outputs.GetGroupGroup[];
    /**
     * Unique identifier of the Group.
     */
    readonly id?: string;
    /**
     * a list of strings of ids of data sources that match the given arguments.
     */
    readonly ids: string[];
    /**
     * Unique human-readable name of the Group.
     */
    readonly name?: string;
    /**
     * Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
     */
    readonly source: string;
    /**
     * Tags is a map of key/value pairs that can be attached to a Group.
     */
    readonly tags?: {
        [key: string]: string;
    };
}
/**
 * A Group is a named set of principals.
 * ## Example Usage
 *
 * <!--Start PulumiCodeChooser -->
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as sdm from "@pierskarsenbarg/sdm";
 *
 * const securityTeam = sdm.getGroup({
 *     name: "Security Team",
 * });
 * const administrators = sdm.getGroup({
 *     id: "group-1234567890abcdef",
 * });
 * const adminTeams = sdm.getGroup({
 *     tags: {
 *         admin: "true",
 *     },
 * });
 * ```
 * <!--End PulumiCodeChooser -->
 */
export declare function getGroupOutput(args?: GetGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetGroupResult>;
/**
 * A collection of arguments for invoking getGroup.
 */
export interface GetGroupOutputArgs {
    /**
     * Description of the Group.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Unique identifier of the Group.
     */
    id?: pulumi.Input<string | undefined>;
    /**
     * Unique human-readable name of the Group.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Tags is a map of key/value pairs that can be attached to a Group.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
}
//# sourceMappingURL=getGroup.d.ts.map