Class: Aws::AppStream::Types::Session

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

Overview

Describes a streaming session.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_type ⇒ String

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

Returns:

  • (String)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#connection_state ⇒ String

Specifies whether a user is connected to the streaming session.

Returns:

  • (String)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_name ⇒ String

The name of the fleet for the streaming session.

Returns:

  • (String)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier of the streaming session.

Returns:

  • (String)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#instance_drain_status ⇒ String

The drain status of the instance hosting the streaming session. This only applies to multi-session fleets.

Returns:

  • (String)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The identifier for the instance hosting the session.

Returns:

  • (String)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#max_expiration_time ⇒ Time

The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

Returns:

  • (Time)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#network_access_configuration ⇒ Types::NetworkAccessConfiguration

The network details for the streaming session.



6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#stack_name ⇒ String

The name of the stack for the streaming session.

Returns:

  • (String)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The time when a streaming instance is dedicated for the user.

Returns:

  • (Time)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of the streaming session.

Returns:

  • (String)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

The identifier of the user for whom the session was created.

Returns:

  • (String)


6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 6001

class Session < Struct.new(
  :id,
  :user_id,
  :stack_name,
  :fleet_name,
  :state,
  :connection_state,
  :start_time,
  :max_expiration_time,
  :authentication_type,
  :network_access_configuration,
  :instance_id,
  :instance_drain_status)
  SENSITIVE = []
  include Aws::Structure
end