Class: AWSCDK::Workspaces::CfnWorkspacesPool::TimeoutSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
workspaces/cfn_workspaces_pool.rb

Overview

Describes the timeout settings for the pool.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(disconnect_timeout_in_seconds: nil, idle_disconnect_timeout_in_seconds: nil, max_user_duration_in_seconds: nil) ⇒ TimeoutSettingsProperty

Returns a new instance of TimeoutSettingsProperty.

Parameters:

  • disconnect_timeout_in_seconds (Numeric, nil) (defaults to: nil) —

    Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect.

  • idle_disconnect_timeout_in_seconds (Numeric, nil) (defaults to: nil) —

    The amount of time in seconds a connection will stay active while idle.

  • max_user_duration_in_seconds (Numeric, nil) (defaults to: nil) —

    Specifies the maximum amount of time, in seconds, that a streaming session can remain active.



743
744
745
746
747
748
749
750
 
# File 'workspaces/cfn_workspaces_pool.rb', line 743

def initialize(disconnect_timeout_in_seconds: nil, idle_disconnect_timeout_in_seconds: nil, max_user_duration_in_seconds: nil)
  @disconnect_timeout_in_seconds = disconnect_timeout_in_seconds
  Jsii::Type.check_type(@disconnect_timeout_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "disconnectTimeoutInSeconds") unless @disconnect_timeout_in_seconds.nil?
  @idle_disconnect_timeout_in_seconds = idle_disconnect_timeout_in_seconds
  Jsii::Type.check_type(@idle_disconnect_timeout_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "idleDisconnectTimeoutInSeconds") unless @idle_disconnect_timeout_in_seconds.nil?
  @max_user_duration_in_seconds = max_user_duration_in_seconds
  Jsii::Type.check_type(@max_user_duration_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxUserDurationInSeconds") unless @max_user_duration_in_seconds.nil?
end

Instance Attribute Details

#disconnect_timeout_in_seconds ⇒ Numeric? (readonly)

Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect.

If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Returns:

  • (Numeric, nil)

See Also:



758
759
760
 
# File 'workspaces/cfn_workspaces_pool.rb', line 758

def disconnect_timeout_in_seconds
  @disconnect_timeout_in_seconds
end

#idle_disconnect_timeout_in_seconds ⇒ Numeric? (readonly)

The amount of time in seconds a connection will stay active while idle.

Returns:

  • (Numeric, nil)

See Also:



763
764
765
 
# File 'workspaces/cfn_workspaces_pool.rb', line 763

def idle_disconnect_timeout_in_seconds
  @idle_disconnect_timeout_in_seconds
end

#max_user_duration_in_seconds ⇒ Numeric? (readonly)

Specifies the maximum amount of time, in seconds, that a streaming session can remain active.

If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Returns:

  • (Numeric, nil)

See Also:



770
771
772
 
# File 'workspaces/cfn_workspaces_pool.rb', line 770

def max_user_duration_in_seconds
  @max_user_duration_in_seconds
end

Class Method Details

.jsii_properties ⇒ Object 



772
773
774
775
776
777
778
 
# File 'workspaces/cfn_workspaces_pool.rb', line 772

def self.jsii_properties
  {
    :disconnect_timeout_in_seconds => "disconnectTimeoutInSeconds",
    :idle_disconnect_timeout_in_seconds => "idleDisconnectTimeoutInSeconds",
    :max_user_duration_in_seconds => "maxUserDurationInSeconds",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



780
781
782
783
784
785
786
787
788
 
# File 'workspaces/cfn_workspaces_pool.rb', line 780

def to_jsii
  result = {}
  result.merge!({
    "disconnectTimeoutInSeconds" => @disconnect_timeout_in_seconds,
    "idleDisconnectTimeoutInSeconds" => @idle_disconnect_timeout_in_seconds,
    "maxUserDurationInSeconds" => @max_user_duration_in_seconds,
  })
  result.compact
end