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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-workspacesweb/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.

Constant Summary collapse

SENSITIVE =

[:cookie_synchronization_configuration]

Instance Attribute Summary collapse

#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.
#branding_configuration ⇒ Types::BrandingConfiguration
The branding configuration output that customizes the appearance of the web portal for end users.
#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.
#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

#additional_encryption_context ⇒ `Hash<String,String>`

The additional encryption context of the user settings.

Returns:

(Hash<String,String>)

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

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 4688

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

#branding_configuration ⇒ `Types::BrandingConfiguration`

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

Returns:

(Types::BrandingConfiguration)

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

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 4688

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 4688

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 4688

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 4688

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 4688

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 4688

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 4688

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 4688

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

#print_allowed ⇒ `String`

Specifies whether the user can print to the local device.

Returns:

(String)

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

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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.

Returns:

(Types::ToolbarConfiguration)

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

class UserSettings < Struct.new(
  :user_settings_arn,
  :associated_portal_arns,
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration)
  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 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 4688

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

#user_settings_arn ⇒ `String`

The ARN of the user settings.

Returns:

(String)

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

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#additional_encryption_context ⇒ Hash<String,String>

#associated_portal_arns ⇒ Array<String>

#branding_configuration ⇒ Types::BrandingConfiguration

#cookie_synchronization_configuration ⇒ Types::CookieSynchronizationConfiguration

#copy_allowed ⇒ String

#customer_managed_key ⇒ String

#deep_link_allowed ⇒ String

#disconnect_timeout_in_minutes ⇒ Integer

#download_allowed ⇒ String

#idle_disconnect_timeout_in_minutes ⇒ Integer

#paste_allowed ⇒ String

#print_allowed ⇒ String

#toolbar_configuration ⇒ Types::ToolbarConfiguration

#upload_allowed ⇒ String

#user_settings_arn ⇒ String

#additional_encryption_context ⇒ `Hash<String,String>`

#associated_portal_arns ⇒ `Array<String>`

#branding_configuration ⇒ `Types::BrandingConfiguration`

#cookie_synchronization_configuration ⇒ `Types::CookieSynchronizationConfiguration`

#copy_allowed ⇒ `String`

#customer_managed_key ⇒ `String`

#deep_link_allowed ⇒ `String`

#disconnect_timeout_in_minutes ⇒ `Integer`

#download_allowed ⇒ `String`

#idle_disconnect_timeout_in_minutes ⇒ `Integer`

#paste_allowed ⇒ `String`

#print_allowed ⇒ `String`

#toolbar_configuration ⇒ `Types::ToolbarConfiguration`

#upload_allowed ⇒ `String`

#user_settings_arn ⇒ `String`