Class: Aws::WorkSpacesWeb::Types::CreateUserSettingsRequest

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpacesWeb::Types::CreateUserSettingsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-workspacesweb/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:tags, :cookie_synchronization_configuration]

Instance Attribute Summary

• #additional_encryption_context ⇒ Hash<String,String>

  The additional encryption context of the user settings.

• #branding_configuration_input ⇒ Types::BrandingConfigurationCreateInput

  The branding configuration input 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.

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

• #tags ⇒ Array<Types::Tag>

  The tags to add to the user settings resource.

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

• #web_authn_allowed ⇒ String

  Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

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 1366

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

#branding_configuration_input ⇒ Types::BrandingConfigurationCreateInput

The branding configuration input that customizes the appearance of the web portal for end users. This includes a custom logo, favicon, wallpaper, localized strings, color theme, and an optional terms of service.

Returns:

• (Types::BrandingConfigurationCreateInput)

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

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 returns 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.

Returns:

• (String)

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

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 1366

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 1366

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 1366

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 1366

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 1366

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 1366

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 1366

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 1366

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 1366

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

#tags ⇒ Array<Types::Tag>

The tags to add to the user settings resource. A tag is a key-value pair.

Returns:

• (Array<Types::Tag>)

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

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 'lib/aws-sdk-workspacesweb/types.rb', line 1366

class CreateUserSettingsRequest < Struct.new(
  :copy_allowed,
  :paste_allowed,
  :download_allowed,
  :upload_allowed,
  :print_allowed,
  :tags,
  :disconnect_timeout_in_minutes,
  :idle_disconnect_timeout_in_minutes,
  :client_token,
  :cookie_synchronization_configuration,
  :customer_managed_key,
  :additional_encryption_context,
  :deep_link_allowed,
  :toolbar_configuration,
  :branding_configuration_input,
  :web_authn_allowed)
  SENSITIVE = [:tags, :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 1366

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

#web_authn_allowed ⇒ String

Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

Returns:

• (String)

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

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