interface CfnUserSettingsProps

Language	Type name
.NET	Amazon.CDK.aws_workspacesweb.CfnUserSettingsProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsworkspacesweb#CfnUserSettingsProps
Java	software.amazon.awscdk.services.workspacesweb.CfnUserSettingsProps
Python	aws_cdk.aws_workspacesweb.CfnUserSettingsProps
TypeScript	aws-cdk-lib » aws_workspacesweb » CfnUserSettingsProps

Properties for defining a CfnUserSettings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesweb as workspacesweb } from 'aws-cdk-lib';
const cfnUserSettingsProps: workspacesweb.CfnUserSettingsProps = {
  copyAllowed: 'copyAllowed',
  downloadAllowed: 'downloadAllowed',
  pasteAllowed: 'pasteAllowed',
  printAllowed: 'printAllowed',
  uploadAllowed: 'uploadAllowed',

  // the properties below are optional
  additionalEncryptionContext: {
    additionalEncryptionContextKey: 'additionalEncryptionContext',
  },
  cookieSynchronizationConfiguration: {
    allowlist: [{
      domain: 'domain',

      // the properties below are optional
      name: 'name',
      path: 'path',
    }],

    // the properties below are optional
    blocklist: [{
      domain: 'domain',

      // the properties below are optional
      name: 'name',
      path: 'path',
    }],
  },
  customerManagedKey: 'customerManagedKey',
  deepLinkAllowed: 'deepLinkAllowed',
  disconnectTimeoutInMinutes: 123,
  idleDisconnectTimeoutInMinutes: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
copyAllowed	string	Specifies whether the user can copy text from the streaming session to the local device.
downloadAllowed	string	Specifies whether the user can download files from the streaming session to the local device.
pasteAllowed	string	Specifies whether the user can paste text from the local device to the streaming session.
printAllowed	string	Specifies whether the user can print to the local device.
uploadAllowed	string	Specifies whether the user can upload files from the local device to the streaming session.
additionalEncryptionContext?	IResolvable | { [string]: string }	The additional encryption context of the user settings.
cookieSynchronizationConfiguration?	IResolvable | CookieSynchronizationConfigurationProperty	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
customerManagedKey?	string	The customer managed key used to encrypt sensitive information in the user settings.
deepLinkAllowed?	string	Specifies whether the user can use deep links that open automatically when connecting to a session.
disconnectTimeoutInMinutes?	number	The amount of time that a streaming session remains active after users disconnect.
idleDisconnectTimeoutInMinutes?	number	The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
tags?	CfnTag[]	The tags to add to the user settings resource.

---

copyAllowed

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-copyallowed

---

downloadAllowed

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-downloadallowed

---

pasteAllowed

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-pasteallowed

---

printAllowed

Type: string

Specifies whether the user can print to the local device.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-printallowed

---

uploadAllowed

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-uploadallowed

---

additionalEncryptionContext?

Type: IResolvable | { [string]: string } (optional)

The additional encryption context of the user settings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-additionalencryptioncontext

---

cookieSynchronizationConfiguration?

Type: IResolvable | CookieSynchronizationConfigurationProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration

---

customerManagedKey?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-customermanagedkey

---

deepLinkAllowed?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-deeplinkallowed

---

disconnectTimeoutInMinutes?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-disconnecttimeoutinminutes

---

idleDisconnectTimeoutInMinutes?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-idledisconnecttimeoutinminutes

---

tags?

Type: CfnTag[] (optional)

The tags to add to the user settings resource.

A tag is a key-value pair.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-tags