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

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.WorkspacesPool

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

    Create WorkspacesPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkspacesPool(name: string, args: WorkspacesPoolArgs, opts?: CustomResourceOptions);
    @overload
def WorkspacesPool(resource_name: str,
                   args: WorkspacesPoolArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def WorkspacesPool(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   bundle_id: Optional[str] = None,
                   capacity: Optional[WorkspacesPoolCapacityArgs] = None,
                   directory_id: Optional[str] = None,
                   application_settings: Optional[WorkspacesPoolApplicationSettingsArgs] = None,
                   description: Optional[str] = None,
                   pool_name: Optional[str] = None,
                   tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                   timeout_settings: Optional[WorkspacesPoolTimeoutSettingsArgs] = None)
    func NewWorkspacesPool(ctx *Context, name string, args WorkspacesPoolArgs, opts ...ResourceOption) (*WorkspacesPool, error)
    public WorkspacesPool(string name, WorkspacesPoolArgs args, CustomResourceOptions? opts = null)
    public WorkspacesPool(String name, WorkspacesPoolArgs args)
public WorkspacesPool(String name, WorkspacesPoolArgs args, CustomResourceOptions options)

    type: aws-native:workspaces:WorkspacesPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WorkspacesPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkspacesPoolArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkspacesPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspacesPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspacesPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    WorkspacesPool Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkspacesPool resource accepts the following input properties:

    BundleId string
    The identifier of the bundle used by the pool.
    Capacity Pulumi.AwsNative.WorkSpaces.Inputs.WorkspacesPoolCapacity
    Describes the user capacity for the pool.
    DirectoryId string
    The identifier of the directory used by the pool.
    ApplicationSettings Pulumi.AwsNative.WorkSpaces.Inputs.WorkspacesPoolApplicationSettings
    The persistent application settings for users of the pool.
    Description string
    The description of the pool.
    PoolName string
    The name of the pool.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    TimeoutSettings Pulumi.AwsNative.WorkSpaces.Inputs.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.
    BundleId string
    The identifier of the bundle used by the pool.
    Capacity WorkspacesPoolCapacityArgs
    Describes the user capacity for the pool.
    DirectoryId string
    The identifier of the directory used by the pool.
    ApplicationSettings WorkspacesPoolApplicationSettingsArgs
    The persistent application settings for users of the pool.
    Description string
    The description of the pool.
    PoolName string
    The name of the pool.
    Tags TagArgs
    TimeoutSettings WorkspacesPoolTimeoutSettingsArgs
    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.
    bundleId String
    The identifier of the bundle used by the pool.
    capacity WorkspacesPoolCapacity
    Describes the user capacity for the pool.
    directoryId String
    The identifier of the directory used by the pool.
    applicationSettings WorkspacesPoolApplicationSettings
    The persistent application settings for users of the pool.
    description String
    The description of the pool.
    poolName String
    The name 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.
    bundleId string
    The identifier of the bundle used by the pool.
    capacity WorkspacesPoolCapacity
    Describes the user capacity for the pool.
    directoryId string
    The identifier of the directory used by the pool.
    applicationSettings WorkspacesPoolApplicationSettings
    The persistent application settings for users of the pool.
    description string
    The description of the pool.
    poolName string
    The name 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.
    bundle_id str
    The identifier of the bundle used by the pool.
    capacity WorkspacesPoolCapacityArgs
    Describes the user capacity for the pool.
    directory_id str
    The identifier of the directory used by the pool.
    application_settings WorkspacesPoolApplicationSettingsArgs
    The persistent application settings for users of the pool.
    description str
    The description of the pool.
    pool_name str
    The name of the pool.
    tags Sequence[TagArgs]
    timeout_settings WorkspacesPoolTimeoutSettingsArgs
    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.
    bundleId String
    The identifier of the bundle used by the pool.
    capacity Property Map
    Describes the user capacity for the pool.
    directoryId String
    The identifier of the directory used by the pool.
    applicationSettings Property Map
    The persistent application settings for users of the pool.
    description String
    The description of the pool.
    poolName String
    The name 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkspacesPool resource produces the following output properties:

    CreatedAt string
    The time the pool was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    PoolArn string
    The Amazon Resource Name (ARN) for the pool.
    PoolId string
    The identifier of the pool.
    CreatedAt string
    The time the pool was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    PoolArn string
    The Amazon Resource Name (ARN) for the pool.
    PoolId string
    The identifier of the pool.
    createdAt String
    The time the pool was created.
    id String
    The provider-assigned unique ID for this managed resource.
    poolArn String
    The Amazon Resource Name (ARN) for the pool.
    poolId String
    The identifier of the pool.
    createdAt string
    The time the pool was created.
    id string
    The provider-assigned unique ID for this managed resource.
    poolArn string
    The Amazon Resource Name (ARN) for the pool.
    poolId string
    The identifier of the pool.
    created_at str
    The time the pool was created.
    id str
    The provider-assigned unique ID for this managed resource.
    pool_arn str
    The Amazon Resource Name (ARN) for the pool.
    pool_id str
    The identifier of the pool.
    createdAt String
    The time the pool was created.
    id String
    The provider-assigned unique ID for this managed resource.
    poolArn String
    The Amazon Resource Name (ARN) for the pool.
    poolId String
    The identifier of the pool.

    Supporting Types

    Tag, TagArgs

    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, WorkspacesPoolApplicationSettingsArgs

    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, WorkspacesPoolApplicationSettingsStatusArgs

    Disabled
    DISABLED
    Enabled
    ENABLED
    WorkspacesPoolApplicationSettingsStatusDisabled
    DISABLED
    WorkspacesPoolApplicationSettingsStatusEnabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    DISABLED
    DISABLED
    ENABLED
    ENABLED
    "DISABLED"
    DISABLED
    "ENABLED"
    ENABLED

    WorkspacesPoolCapacity, WorkspacesPoolCapacityArgs

    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, WorkspacesPoolTimeoutSettingsArgs

    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