Class: Aws::WorkSpaces::Types::WorkspacesPool

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Describes a pool of WorkSpaces.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_settingsTypes::ApplicationSettingsResponse

The persistent application settings for users of the pool.



6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#bundle_idString

The identifier of the bundle used by the pool.

Returns:

  • (String)


6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_statusTypes::CapacityStatus

The capacity status for the pool



6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The time the pool was created.

Returns:

  • (Time)


6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the pool.

Returns:

  • (String)


6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#directory_idString

The identifier of the directory used by the pool.

Returns:

  • (String)


6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#errorsArray<Types::WorkspacesPoolError>

The pool errors.

Returns:



6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#pool_arnString

The Amazon Resource Name (ARN) for the pool.

Returns:

  • (String)


6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#pool_idString

The identifier of a pool.

Returns:

  • (String)


6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#pool_nameString

The name of the pool,

Returns:

  • (String)


6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The current state of the pool.

Returns:

  • (String)


6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_settingsTypes::TimeoutSettings

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.



6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6114

class WorkspacesPool < Struct.new(
  :pool_id,
  :pool_arn,
  :capacity_status,
  :pool_name,
  :description,
  :state,
  :created_at,
  :bundle_id,
  :directory_id,
  :errors,
  :application_settings,
  :timeout_settings)
  SENSITIVE = []
  include Aws::Structure
end