Class: Aws::WorkSpaces::Types::WorkspacesPoolSession

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpaces::Types::WorkspacesPoolSession

Defined in:

gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Describes a pool session.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authentication_type ⇒ String

  The authentication method.

• #connection_state ⇒ String

  Specifies whether a user is connected to the pool session.

• #expiration_time ⇒ Time

  The time that the pool session ended.

• #instance_id ⇒ String

  The identifier for the instance hosting the session.

• #network_access_configuration ⇒ Types::NetworkAccessConfiguration

  Describes the network details of the pool.

• #pool_id ⇒ String

  The identifier of the pool.

• #session_id ⇒ String

  The identifier of the session.

• #start_time ⇒ Time

  The time that the pool sission started.

• #user_id ⇒ String

  The identifier of the user.

Instance Attribute Details

#authentication_type ⇒ String

The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6187

class WorkspacesPoolSession < Struct.new(
  :authentication_type,
  :connection_state,
  :session_id,
  :instance_id,
  :pool_id,
  :expiration_time,
  :network_access_configuration,
  :start_time,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#connection_state ⇒ String

Specifies whether a user is connected to the pool session.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6187

class WorkspacesPoolSession < Struct.new(
  :authentication_type,
  :connection_state,
  :session_id,
  :instance_id,
  :pool_id,
  :expiration_time,
  :network_access_configuration,
  :start_time,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#expiration_time ⇒ Time

The time that the pool session ended.

Returns:

• (Time)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6187

class WorkspacesPoolSession < Struct.new(
  :authentication_type,
  :connection_state,
  :session_id,
  :instance_id,
  :pool_id,
  :expiration_time,
  :network_access_configuration,
  :start_time,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The identifier for the instance hosting the session.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6187

class WorkspacesPoolSession < Struct.new(
  :authentication_type,
  :connection_state,
  :session_id,
  :instance_id,
  :pool_id,
  :expiration_time,
  :network_access_configuration,
  :start_time,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#network_access_configuration ⇒ Types::NetworkAccessConfiguration

Describes the network details of the pool.

Returns:

• (Types::NetworkAccessConfiguration)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6187

class WorkspacesPoolSession < Struct.new(
  :authentication_type,
  :connection_state,
  :session_id,
  :instance_id,
  :pool_id,
  :expiration_time,
  :network_access_configuration,
  :start_time,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#pool_id ⇒ String

The identifier of the pool.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6187

class WorkspacesPoolSession < Struct.new(
  :authentication_type,
  :connection_state,
  :session_id,
  :instance_id,
  :pool_id,
  :expiration_time,
  :network_access_configuration,
  :start_time,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the session.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6187

class WorkspacesPoolSession < Struct.new(
  :authentication_type,
  :connection_state,
  :session_id,
  :instance_id,
  :pool_id,
  :expiration_time,
  :network_access_configuration,
  :start_time,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The time that the pool sission started.

Returns:

• (Time)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6187

class WorkspacesPoolSession < Struct.new(
  :authentication_type,
  :connection_state,
  :session_id,
  :instance_id,
  :pool_id,
  :expiration_time,
  :network_access_configuration,
  :start_time,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

The identifier of the user.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6187

class WorkspacesPoolSession < Struct.new(
  :authentication_type,
  :connection_state,
  :session_id,
  :instance_id,
  :pool_id,
  :expiration_time,
  :network_access_configuration,
  :start_time,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end