Class: Aws::WorkSpacesWeb::Types::UserSettings

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpacesWeb::Types::UserSettings

Includes:

Structure

Defined in:

lib/aws-sdk-workspacesweb/types.rb

Overview

A user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:cookie_synchronization_configuration]

Instance Attribute Summary

• #additional_encryption_context ⇒ Hash<String,String>

  The additional encryption context of the user settings.

• #associated_portal_arns ⇒ Array<String>

  A list of web portal ARNs that this user settings is associated with.

• #cookie_synchronization_configuration ⇒ Types::CookieSynchronizationConfiguration

  The configuration that specifies which cookies should be synchronized from the end user’s local browser to the remote browser.

• #copy_allowed ⇒ String

  Specifies whether the user can copy text from the streaming session to the local device.

• #customer_managed_key ⇒ String

  The customer managed key used to encrypt sensitive information in the user settings.

• #deep_link_allowed ⇒ String

  Specifies whether the user can use deep links that open automatically when connecting to a session.

• #disconnect_timeout_in_minutes ⇒ Integer

  The amount of time that a streaming session remains active after users disconnect.

• #download_allowed ⇒ String

  Specifies whether the user can download files from the streaming session to the local device.

• #idle_disconnect_timeout_in_minutes ⇒ Integer

  The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

• #paste_allowed ⇒ String

  Specifies whether the user can paste text from the local device to the streaming session.

• #print_allowed ⇒ String

  Specifies whether the user can print to the local device.

• #upload_allowed ⇒ String

  Specifies whether the user can upload files from the local device to the streaming session.

• #user_settings_arn ⇒ String

  The ARN of the user settings.

Instance Attribute Details

#additional_encryption_context ⇒ Hash<String,String>

The additional encryption context of the user settings.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#associated_portal_arns ⇒ Array<String>

A list of web portal ARNs that this user settings is associated with.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#cookie_synchronization_configuration ⇒ Types::CookieSynchronizationConfiguration

The configuration that specifies which cookies should be synchronized from the end user’s local browser to the remote browser.

Returns:

• (Types::CookieSynchronizationConfiguration)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#copy_allowed ⇒ String

Specifies whether the user can copy text from the streaming session to the local device.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#customer_managed_key ⇒ String

The customer managed key used to encrypt sensitive information in the user settings.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#deep_link_allowed ⇒ String

Specifies whether the user can use deep links that open automatically when connecting to a session.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#disconnect_timeout_in_minutes ⇒ Integer

The amount of time that a streaming session remains active after users disconnect.

Returns:

• (Integer)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#download_allowed ⇒ String

Specifies whether the user can download files from the streaming session to the local device.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#idle_disconnect_timeout_in_minutes ⇒ Integer

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

Returns:

• (Integer)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#paste_allowed ⇒ String

Specifies whether the user can paste text from the local device to the streaming session.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#print_allowed ⇒ String

Specifies whether the user can print to the local device.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#upload_allowed ⇒ String

Specifies whether the user can upload files from the local device to the streaming session.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#user_settings_arn ⇒ String

The ARN of the user settings.

Returns:

• (String)

# File 'lib/aws-sdk-workspacesweb/types.rb', line 3926

class UserSettings < Struct.new(
  :additional_encryption_context,
  :associated_portal_arns,
  :cookie_synchronization_configuration,
  :copy_allowed,
  :customer_managed_key,
  :deep_link_allowed,
  :disconnect_timeout_in_minutes,
  :download_allowed,
  :idle_disconnect_timeout_in_minutes,
  :paste_allowed,
  :print_allowed,
  :upload_allowed,
  :user_settings_arn)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end