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

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

Overview

Describes a streaming session.

Constant Summary collapse

SENSITIVE =
[]

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)


4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  include Aws::Structure
end

#connection_stateString

Specifies whether a user is connected to the streaming session.

Returns:

  • (String)


4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_nameString

The name of the fleet for the streaming session.

Returns:

  • (String)


4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The identifier of the streaming session.

Returns:

  • (String)


4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_idString

The identifier for the instance hosting the session.

Returns:

  • (String)


4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  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)


4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  include Aws::Structure
end

#network_access_configurationTypes::NetworkAccessConfiguration

The network details for the streaming session.



4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  include Aws::Structure
end

#stack_nameString

The name of the stack for the streaming session.

Returns:

  • (String)


4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

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

Returns:

  • (Time)


4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The current state of the streaming session.

Returns:

  • (String)


4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  include Aws::Structure
end

#user_idString

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

Returns:

  • (String)


4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/aws-sdk-appstream/types.rb', line 4628

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)
  SENSITIVE = []
  include Aws::Structure
end