Skip to content

Create User Settings

workspacesweb_create_user_settings R Documentation

Creates a user settings resource that can be associated with a web portal

Description

Creates 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.

Usage

workspacesweb_create_user_settings(additionalEncryptionContext,
  clientToken, cookieSynchronizationConfiguration, copyAllowed,
  customerManagedKey, deepLinkAllowed, disconnectTimeoutInMinutes,
  downloadAllowed, idleDisconnectTimeoutInMinutes, pasteAllowed,
  printAllowed, tags, uploadAllowed)

Arguments

additionalEncryptionContext

The additional encryption context of the user settings.

clientToken

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.

cookieSynchronizationConfiguration

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

copyAllowed

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

customerManagedKey

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

deepLinkAllowed

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

disconnectTimeoutInMinutes

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

downloadAllowed

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

idleDisconnectTimeoutInMinutes

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

pasteAllowed

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

printAllowed

[required] Specifies whether the user can print to the local device.

tags

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

uploadAllowed

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

Value

A list with the following syntax: 

list(
  userSettingsArn = "string"
)

Request syntax

svc$create_user_settings(
  additionalEncryptionContext = list(
    "string"
  ),
  clientToken = "string",
  cookieSynchronizationConfiguration = list(
    allowlist = list(
      list(
        domain = "string",
        name = "string",
        path = "string"
      )
    ),
    blocklist = list(
      list(
        domain = "string",
        name = "string",
        path = "string"
      )
    )
  ),
  copyAllowed = "Disabled"|"Enabled",
  customerManagedKey = "string",
  deepLinkAllowed = "Disabled"|"Enabled",
  disconnectTimeoutInMinutes = 123,
  downloadAllowed = "Disabled"|"Enabled",
  idleDisconnectTimeoutInMinutes = 123,
  pasteAllowed = "Disabled"|"Enabled",
  printAllowed = "Disabled"|"Enabled",
  tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  uploadAllowed = "Disabled"|"Enabled"
)