Class: Aws::WorkSpacesWeb::Types::UpdateUserSettingsRequest

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpacesWeb::Types::UpdateUserSettingsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-workspacesweb/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:cookie_synchronization_configuration]

Instance Attribute Summary

• #branding_configuration_input ⇒ Types::BrandingConfigurationUpdateInput

  The branding configuration that customizes the appearance of the web portal for end users.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #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.

• #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.

• #toolbar_configuration ⇒ Types::ToolbarConfiguration

  The configuration of the toolbar.

• #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

#branding_configuration_input ⇒ Types::BrandingConfigurationUpdateInput

The branding configuration that customizes the appearance of the web portal for end users. When updating user settings without an existing branding configuration, all fields (logo, favicon, wallpaper, localized strings, and color theme) are required except for terms of service. When updating user settings with an existing branding configuration, all fields are optional.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  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.

If the allowlist and blocklist are empty, the configuration becomes null.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  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.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  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.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  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.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  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.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  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.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  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.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#print_allowed ⇒ String

Specifies whether the user can print to the local device.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#toolbar_configuration ⇒ Types::ToolbarConfiguration

The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  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.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end

#user_settings_arn ⇒ String

The ARN of the user settings.

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

class UpdateUserSettingsRequest < Struct.new(
  :user_settings_arn,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input)
  SENSITIVE = [:cookie_synchronization_configuration]
  include Aws::Structure
end