@pulumi/aws/workspaces/getWorkspace.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to get information about a workspace in [AWS Workspaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces.html) Service.
 *
 * ## Example Usage
 *
 * ### Filter By Workspace ID
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.workspaces.getWorkspace({
 *     workspaceId: "ws-cj5xcxsz5",
 * });
 * ```
 *
 * ### Filter By Directory ID & User Name
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.workspaces.getWorkspace({
 *     directoryId: "d-9967252f57",
 *     userName: "Example",
 * });
 * ```
 */
export declare function getWorkspace(args?: GetWorkspaceArgs, opts?: pulumi.InvokeOptions): Promise<GetWorkspaceResult>;
/**
 * A collection of arguments for invoking getWorkspace.
 */
export interface GetWorkspaceArgs {
    /**
     * ID of the directory for the WorkSpace. You have to specify `userName` along with `directoryId`. You cannot combine this parameter with `workspaceId`.
     */
    directoryId?: 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;
    /**
     * Tags for the WorkSpace.
     */
    tags?: {
        [key: string]: string;
    };
    /**
     * User name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. You cannot combine this parameter with `workspaceId`.
     */
    userName?: string;
    /**
     * ID of the WorkSpace. You cannot combine this parameter with `directoryId`.
     */
    workspaceId?: string;
}
/**
 * A collection of values returned by getWorkspace.
 */
export interface GetWorkspaceResult {
    readonly bundleId: string;
    /**
     * Name of the WorkSpace, as seen by the operating system.
     */
    readonly computerName: string;
    readonly directoryId: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * IP address of the WorkSpace.
     */
    readonly ipAddress: string;
    readonly region: string;
    readonly rootVolumeEncryptionEnabled: boolean;
    /**
     * Operational state of the WorkSpace.
     */
    readonly state: string;
    readonly tags: {
        [key: string]: string;
    };
    readonly userName: string;
    readonly userVolumeEncryptionEnabled: boolean;
    readonly volumeEncryptionKey: string;
    readonly workspaceId: string;
    readonly workspaceProperties: outputs.workspaces.GetWorkspaceWorkspaceProperty[];
}
/**
 * Use this data source to get information about a workspace in [AWS Workspaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces.html) Service.
 *
 * ## Example Usage
 *
 * ### Filter By Workspace ID
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.workspaces.getWorkspace({
 *     workspaceId: "ws-cj5xcxsz5",
 * });
 * ```
 *
 * ### Filter By Directory ID & User Name
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.workspaces.getWorkspace({
 *     directoryId: "d-9967252f57",
 *     userName: "Example",
 * });
 * ```
 */
export declare function getWorkspaceOutput(args?: GetWorkspaceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWorkspaceResult>;
/**
 * A collection of arguments for invoking getWorkspace.
 */
export interface GetWorkspaceOutputArgs {
    /**
     * ID of the directory for the WorkSpace. You have to specify `userName` along with `directoryId`. You cannot combine this parameter with `workspaceId`.
     */
    directoryId?: 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>;
    /**
     * Tags for the WorkSpace.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * User name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. You cannot combine this parameter with `workspaceId`.
     */
    userName?: pulumi.Input<string>;
    /**
     * ID of the WorkSpace. You cannot combine this parameter with `directoryId`.
     */
    workspaceId?: pulumi.Input<string>;
}