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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a streaming session.

See Also:

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).

Possible values:

  • API
  • SAML
  • USERPOOL

Returns:

  • (String) —

    The authentication method.

#connection_state ⇒ String

Specifies whether a user is connected to the streaming session.

Possible values:

  • CONNECTED
  • NOT_CONNECTED

Returns:

  • (String) —

    Specifies whether a user is connected to the streaming session.

#fleet_name ⇒ String

The name of the fleet for the streaming session.

Returns:

  • (String) —

    The name of the fleet for the streaming session.

#id ⇒ String

The identifier of the streaming session.

Returns:

  • (String) —

    The identifier of the streaming session.

#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) —

    The time when the streaming session is set to expire.

#network_access_configuration ⇒ Types::NetworkAccessConfiguration

The network details for the streaming session.

Returns:

#stack_name ⇒ String

The name of the stack for the streaming session.

Returns:

  • (String) —

    The name of the stack for the streaming session.

#start_time ⇒ Time

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

Returns:

  • (Time) —

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

#state ⇒ String

The current state of the streaming session.

Possible values:

  • ACTIVE
  • PENDING
  • EXPIRED

Returns:

  • (String) —

    The current state of the streaming session.

#user_id ⇒ String

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

Returns:

  • (String) —

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