Class: Aws::WorkSpaces::Types::CapacityStatus

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

Overview

Describes the capacity status for a pool of WorkSpaces.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_user_sessions ⇒ Integer

The number of user sessions currently being used for your pool.

Returns:

  • (Integer) 


464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 464

class CapacityStatus < Struct.new(
  :available_user_sessions,
  :desired_user_sessions,
  :actual_user_sessions,
  :active_user_sessions)
  SENSITIVE = []
  include Aws::Structure
end

#actual_user_sessions ⇒ Integer

The total number of user sessions that are available for streaming or are currently streaming in your pool.

ActualUserSessions = AvailableUserSessions + ActiveUserSessions

Returns:

  • (Integer) 


464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 464

class CapacityStatus < Struct.new(
  :available_user_sessions,
  :desired_user_sessions,
  :actual_user_sessions,
  :active_user_sessions)
  SENSITIVE = []
  include Aws::Structure
end

#available_user_sessions ⇒ Integer

The number of user sessions currently available for streaming from your pool.

AvailableUserSessions = ActualUserSessions - ActiveUserSessions

Returns:

  • (Integer) 


464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 464

class CapacityStatus < Struct.new(
  :available_user_sessions,
  :desired_user_sessions,
  :actual_user_sessions,
  :active_user_sessions)
  SENSITIVE = []
  include Aws::Structure
end

#desired_user_sessions ⇒ Integer

The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.

Returns:

  • (Integer) 


464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 464

class CapacityStatus < Struct.new(
  :available_user_sessions,
  :desired_user_sessions,
  :actual_user_sessions,
  :active_user_sessions)
  SENSITIVE = []
  include Aws::Structure
end