import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a WorkSpaces Pool in the AWS WorkSpaces service. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.workspaces.getBundle({ * owner: "AMAZON", * name: "Standard with Windows 10 (Server 2022 based) (WSP)", * }); * const exampleDirectory = new aws.workspaces.Directory("example", { * subnetIds: [ * exampleC.id, * exampleD.id, * ], * workspaceType: "POOLS", * workspaceDirectoryName: "example-directory", * workspaceDirectoryDescription: "Example WorkSpaces Directory for Pools", * userIdentityType: "CUSTOMER_MANAGED", * }); * const examplePool = new aws.workspaces.Pool("example", { * capacity: { * desiredUserSessions: 10, * }, * bundleId: example.then(example => example.id), * poolName: "example-pool", * description: "Example WorkSpaces Pool", * directoryId: exampleDirectory.directoryId, * runningMode: "AUTO_STOP", * }); * ``` * * ### With Application Settings * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.workspaces.Pool("example", { * capacity: { * desiredUserSessions: 10, * }, * bundleId: exampleAwsWorkspacesBundle.id, * poolName: "example-pool", * description: "Example WorkSpaces Pool with Application Settings", * directoryId: exampleAwsWorkspacesDirectory.directoryId, * runningMode: "AUTO_STOP", * applicationSettings: [{ * status: "ENABLED", * settingsGroup: "my-settings-group", * }], * }); * ``` * * ### With Timeout Settings * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.workspaces.Pool("example", { * capacity: { * desiredUserSessions: 10, * }, * bundleId: exampleAwsWorkspacesBundle.id, * poolName: "example-pool", * description: "Example WorkSpaces Pool with Timeout Settings", * directoryId: exampleAwsWorkspacesDirectory.directoryId, * runningMode: "AUTO_STOP", * timeoutSettings: [{ * disconnectTimeoutInSeconds: 900, * idleDisconnectTimeoutInSeconds: 900, * maxUserDurationInSeconds: 14400, * }], * }); * ``` * * ## Import * * Using `pulumi import`, import WorkSpaces Pool using the pool ID. For example: * * ```sh * $ pulumi import aws:workspaces/pool:Pool example wspool-12345678 * ``` * * ### Identity Schema * * #### Required * * * `poolId` (String) WorkSpaces Pool identifier. * * #### Optional * * * `accountId` (String) AWS Account where this resource is managed. * * `region` (String) Region where this resource is managed. */ export declare class Pool extends pulumi.CustomResource { /** * Get an existing Pool resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: PoolState, opts?: pulumi.CustomResourceOptions): Pool; /** * Returns true if the given object is an instance of Pool. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Pool; /** * Application settings configuration for the WorkSpaces Pool. See `applicationSettings` Block below. */ readonly applicationSettings: pulumi.Output; /** * ID of the bundle for the WorkSpaces Pool. */ readonly bundleId: pulumi.Output; /** * Capacity configuration for the WorkSpaces Pool. See `capacity` below. */ readonly capacity: pulumi.Output; /** * Capacity status of the WorkSpaces Pool. See `capacityStatus` Block below. */ readonly capacityStatuses: pulumi.Output; /** * Date and time the WorkSpaces Pool was created. */ readonly createdAt: pulumi.Output; /** * Description of the WorkSpaces Pool. */ readonly description: pulumi.Output; /** * ID of the directory for the WorkSpaces Pool. */ readonly directoryId: pulumi.Output; /** * ARN of the WorkSpaces Pool. */ readonly poolArn: pulumi.Output; /** * ID of the WorkSpaces Pool. */ readonly poolId: pulumi.Output; /** * Name of the WorkSpaces Pool. This cannot be changed after creation. */ readonly poolName: pulumi.Output; /** * 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. */ readonly region: pulumi.Output; /** * Running mode of the WorkSpaces Pool. Valid values are `AUTO_STOP` and `ALWAYS_ON`. * * The following arguments are optional: */ readonly runningMode: pulumi.Output; /** * S3 bucket where application settings are stored when `applicationSettings` is enabled. */ readonly s3BucketName: pulumi.Output; /** * Current state of the WorkSpaces Pool. */ readonly state: pulumi.Output; /** * Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * Timeout settings configuration for the WorkSpaces Pool. See `timeoutSettings` Block below. */ readonly timeoutSettings: pulumi.Output; readonly timeouts: pulumi.Output; /** * Create a Pool resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: PoolArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Pool resources. */ export interface PoolState { /** * Application settings configuration for the WorkSpaces Pool. See `applicationSettings` Block below. */ applicationSettings?: pulumi.Input[] | undefined>; /** * ID of the bundle for the WorkSpaces Pool. */ bundleId?: pulumi.Input; /** * Capacity configuration for the WorkSpaces Pool. See `capacity` below. */ capacity?: pulumi.Input; /** * Capacity status of the WorkSpaces Pool. See `capacityStatus` Block below. */ capacityStatuses?: pulumi.Input[] | undefined>; /** * Date and time the WorkSpaces Pool was created. */ createdAt?: pulumi.Input; /** * Description of the WorkSpaces Pool. */ description?: pulumi.Input; /** * ID of the directory for the WorkSpaces Pool. */ directoryId?: pulumi.Input; /** * ARN of the WorkSpaces Pool. */ poolArn?: pulumi.Input; /** * ID of the WorkSpaces Pool. */ poolId?: pulumi.Input; /** * Name of the WorkSpaces Pool. This cannot be changed after creation. */ poolName?: pulumi.Input; /** * 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; /** * Running mode of the WorkSpaces Pool. Valid values are `AUTO_STOP` and `ALWAYS_ON`. * * The following arguments are optional: */ runningMode?: pulumi.Input; /** * S3 bucket where application settings are stored when `applicationSettings` is enabled. */ s3BucketName?: pulumi.Input; /** * Current state of the WorkSpaces Pool. */ state?: pulumi.Input; /** * Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Timeout settings configuration for the WorkSpaces Pool. See `timeoutSettings` Block below. */ timeoutSettings?: pulumi.Input[] | undefined>; timeouts?: pulumi.Input; } /** * The set of arguments for constructing a Pool resource. */ export interface PoolArgs { /** * Application settings configuration for the WorkSpaces Pool. See `applicationSettings` Block below. */ applicationSettings?: pulumi.Input[] | undefined>; /** * ID of the bundle for the WorkSpaces Pool. */ bundleId: pulumi.Input; /** * Capacity configuration for the WorkSpaces Pool. See `capacity` below. */ capacity?: pulumi.Input; /** * Description of the WorkSpaces Pool. */ description: pulumi.Input; /** * ID of the directory for the WorkSpaces Pool. */ directoryId: pulumi.Input; /** * Name of the WorkSpaces Pool. This cannot be changed after creation. */ poolName: pulumi.Input; /** * 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; /** * Running mode of the WorkSpaces Pool. Valid values are `AUTO_STOP` and `ALWAYS_ON`. * * The following arguments are optional: */ runningMode: pulumi.Input; /** * Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Timeout settings configuration for the WorkSpaces Pool. See `timeoutSettings` Block below. */ timeoutSettings?: pulumi.Input[] | undefined>; timeouts?: pulumi.Input; } //# sourceMappingURL=pool.d.ts.map