You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_typeString

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

Returns:

  • (String)


2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2861

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

#connection_stateString

Specifies whether a user is connected to the streaming session.

Returns:

  • (String)


2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2861

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

#fleet_nameString

The name of the fleet for the streaming session.

Returns:

  • (String)


2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2861

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

#idString

The identifier of the streaming session.

Returns:

  • (String)


2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2861

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

#max_expiration_timeTime

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)


2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2861

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

#network_access_configurationTypes::NetworkAccessConfiguration

The network details for the streaming session.



2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2861

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

#stack_nameString

The name of the stack for the streaming session.

Returns:

  • (String)


2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2861

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

#start_timeTime

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

Returns:

  • (Time)


2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2861

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

#stateString

The current state of the streaming session.

Returns:

  • (String)


2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2861

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

#user_idString

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

Returns:

  • (String)


2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2861

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