Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. workspaces
  5. getWorkspacesPool

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.workspaces.getWorkspacesPool

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::WorkSpaces::WorkspacesPool

    Using getWorkspacesPool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWorkspacesPool(args: GetWorkspacesPoolArgs, opts?: InvokeOptions): Promise<GetWorkspacesPoolResult>
function getWorkspacesPoolOutput(args: GetWorkspacesPoolOutputArgs, opts?: InvokeOptions): Output<GetWorkspacesPoolResult>
    def get_workspaces_pool(pool_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetWorkspacesPoolResult
def get_workspaces_pool_output(pool_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetWorkspacesPoolResult]
    func LookupWorkspacesPool(ctx *Context, args *LookupWorkspacesPoolArgs, opts ...InvokeOption) (*LookupWorkspacesPoolResult, error)
func LookupWorkspacesPoolOutput(ctx *Context, args *LookupWorkspacesPoolOutputArgs, opts ...InvokeOption) LookupWorkspacesPoolResultOutput

    > Note: This function is named LookupWorkspacesPool in the Go SDK.

    public static class GetWorkspacesPool 
{
    public static Task<GetWorkspacesPoolResult> InvokeAsync(GetWorkspacesPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspacesPoolResult> Invoke(GetWorkspacesPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkspacesPoolResult> getWorkspacesPool(GetWorkspacesPoolArgs args, InvokeOptions options)
public static Output<GetWorkspacesPoolResult> getWorkspacesPool(GetWorkspacesPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:workspaces:getWorkspacesPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PoolId string
    The identifier of the pool.
    PoolId string
    The identifier of the pool.
    poolId String
    The identifier of the pool.
    poolId string
    The identifier of the pool.
    pool_id str
    The identifier of the pool.
    poolId String
    The identifier of the pool.

    getWorkspacesPool Result

    The following output properties are available:

    ApplicationSettings Pulumi.AwsNative.WorkSpaces.Outputs.WorkspacesPoolApplicationSettings
    The persistent application settings for users of the pool.
    BundleId string
    The identifier of the bundle used by the pool.
    Capacity Pulumi.AwsNative.WorkSpaces.Outputs.WorkspacesPoolCapacity
    Describes the user capacity for the pool.
    CreatedAt string
    The time the pool was created.
    Description string
    The description of the pool.
    DirectoryId string
    The identifier of the directory used by the pool.
    PoolArn string
    The Amazon Resource Name (ARN) for the pool.
    PoolId string
    The identifier of the pool.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    TimeoutSettings Pulumi.AwsNative.WorkSpaces.Outputs.WorkspacesPoolTimeoutSettings
    The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
    ApplicationSettings WorkspacesPoolApplicationSettings
    The persistent application settings for users of the pool.
    BundleId string
    The identifier of the bundle used by the pool.
    Capacity WorkspacesPoolCapacity
    Describes the user capacity for the pool.
    CreatedAt string
    The time the pool was created.
    Description string
    The description of the pool.
    DirectoryId string
    The identifier of the directory used by the pool.
    PoolArn string
    The Amazon Resource Name (ARN) for the pool.
    PoolId string
    The identifier of the pool.
    Tags Tag
    TimeoutSettings WorkspacesPoolTimeoutSettings
    The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
    applicationSettings WorkspacesPoolApplicationSettings
    The persistent application settings for users of the pool.
    bundleId String
    The identifier of the bundle used by the pool.
    capacity WorkspacesPoolCapacity
    Describes the user capacity for the pool.
    createdAt String
    The time the pool was created.
    description String
    The description of the pool.
    directoryId String
    The identifier of the directory used by the pool.
    poolArn String
    The Amazon Resource Name (ARN) for the pool.
    poolId String
    The identifier of the pool.
    tags List<Tag>
    timeoutSettings WorkspacesPoolTimeoutSettings
    The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
    applicationSettings WorkspacesPoolApplicationSettings
    The persistent application settings for users of the pool.
    bundleId string
    The identifier of the bundle used by the pool.
    capacity WorkspacesPoolCapacity
    Describes the user capacity for the pool.
    createdAt string
    The time the pool was created.
    description string
    The description of the pool.
    directoryId string
    The identifier of the directory used by the pool.
    poolArn string
    The Amazon Resource Name (ARN) for the pool.
    poolId string
    The identifier of the pool.
    tags Tag[]
    timeoutSettings WorkspacesPoolTimeoutSettings
    The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
    application_settings WorkspacesPoolApplicationSettings
    The persistent application settings for users of the pool.
    bundle_id str
    The identifier of the bundle used by the pool.
    capacity WorkspacesPoolCapacity
    Describes the user capacity for the pool.
    created_at str
    The time the pool was created.
    description str
    The description of the pool.
    directory_id str
    The identifier of the directory used by the pool.
    pool_arn str
    The Amazon Resource Name (ARN) for the pool.
    pool_id str
    The identifier of the pool.
    tags Sequence[root_Tag]
    timeout_settings WorkspacesPoolTimeoutSettings
    The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
    applicationSettings Property Map
    The persistent application settings for users of the pool.
    bundleId String
    The identifier of the bundle used by the pool.
    capacity Property Map
    Describes the user capacity for the pool.
    createdAt String
    The time the pool was created.
    description String
    The description of the pool.
    directoryId String
    The identifier of the directory used by the pool.
    poolArn String
    The Amazon Resource Name (ARN) for the pool.
    poolId String
    The identifier of the pool.
    tags List<Property Map>
    timeoutSettings Property Map
    The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    WorkspacesPoolApplicationSettings

    Status Pulumi.AwsNative.WorkSpaces.WorkspacesPoolApplicationSettingsStatus
    Enables or disables persistent application settings for users during their pool sessions.
    SettingsGroup string
    The path prefix for the S3 bucket where users’ persistent application settings are stored.
    Status WorkspacesPoolApplicationSettingsStatus
    Enables or disables persistent application settings for users during their pool sessions.
    SettingsGroup string
    The path prefix for the S3 bucket where users’ persistent application settings are stored.
    status WorkspacesPoolApplicationSettingsStatus
    Enables or disables persistent application settings for users during their pool sessions.
    settingsGroup String
    The path prefix for the S3 bucket where users’ persistent application settings are stored.
    status WorkspacesPoolApplicationSettingsStatus
    Enables or disables persistent application settings for users during their pool sessions.
    settingsGroup string
    The path prefix for the S3 bucket where users’ persistent application settings are stored.
    status WorkspacesPoolApplicationSettingsStatus
    Enables or disables persistent application settings for users during their pool sessions.
    settings_group str
    The path prefix for the S3 bucket where users’ persistent application settings are stored.
    status "DISABLED" | "ENABLED"
    Enables or disables persistent application settings for users during their pool sessions.
    settingsGroup String
    The path prefix for the S3 bucket where users’ persistent application settings are stored.

    WorkspacesPoolApplicationSettingsStatus

    WorkspacesPoolCapacity

    DesiredUserSessions int
    The desired number of user sessions for the WorkSpaces in the pool.
    DesiredUserSessions int
    The desired number of user sessions for the WorkSpaces in the pool.
    desiredUserSessions Integer
    The desired number of user sessions for the WorkSpaces in the pool.
    desiredUserSessions number
    The desired number of user sessions for the WorkSpaces in the pool.
    desired_user_sessions int
    The desired number of user sessions for the WorkSpaces in the pool.
    desiredUserSessions Number
    The desired number of user sessions for the WorkSpaces in the pool.

    WorkspacesPoolTimeoutSettings

    DisconnectTimeoutInSeconds int
    Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
    IdleDisconnectTimeoutInSeconds int
    The amount of time in seconds a connection will stay active while idle.
    MaxUserDurationInSeconds int
    Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
    DisconnectTimeoutInSeconds int
    Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
    IdleDisconnectTimeoutInSeconds int
    The amount of time in seconds a connection will stay active while idle.
    MaxUserDurationInSeconds int
    Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
    disconnectTimeoutInSeconds Integer
    Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
    idleDisconnectTimeoutInSeconds Integer
    The amount of time in seconds a connection will stay active while idle.
    maxUserDurationInSeconds Integer
    Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
    disconnectTimeoutInSeconds number
    Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
    idleDisconnectTimeoutInSeconds number
    The amount of time in seconds a connection will stay active while idle.
    maxUserDurationInSeconds number
    Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
    disconnect_timeout_in_seconds int
    Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
    idle_disconnect_timeout_in_seconds int
    The amount of time in seconds a connection will stay active while idle.
    max_user_duration_in_seconds int
    Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
    disconnectTimeoutInSeconds Number
    Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
    idleDisconnectTimeoutInSeconds Number
    The amount of time in seconds a connection will stay active while idle.
    maxUserDurationInSeconds Number
    Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native