interface CfnUserSettingsMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.WorkSpacesWeb.Mixins.CfnUserSettingsMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsworkspacesweb/mixins#CfnUserSettingsMixinProps
Java	software.amazon.awscdk.mixins.preview.services.workspacesweb.mixins.CfnUserSettingsMixinProps
Python	aws_cdk.mixins_preview.aws_workspacesweb.mixins.CfnUserSettingsMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_workspacesweb » mixins » CfnUserSettingsMixinProps

Properties for CfnUserSettingsPropsMixin.

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 { mixins as workspacesweb_mixins } from '@aws-cdk/mixins-preview/aws-workspacesweb';
const cfnUserSettingsMixinProps: workspacesweb_mixins.CfnUserSettingsMixinProps = {
  additionalEncryptionContext: {
    additionalEncryptionContextKey: 'additionalEncryptionContext',
  },
  brandingConfiguration: {
    colorTheme: 'colorTheme',
    favicon: 'favicon',
    faviconMetadata: {
      fileExtension: 'fileExtension',
      lastUploadTimestamp: 'lastUploadTimestamp',
      mimeType: 'mimeType',
    },
    localizedStrings: {
      localizedStringsKey: {
        browserTabTitle: 'browserTabTitle',
        contactButtonText: 'contactButtonText',
        contactLink: 'contactLink',
        loadingText: 'loadingText',
        loginButtonText: 'loginButtonText',
        loginDescription: 'loginDescription',
        loginTitle: 'loginTitle',
        welcomeText: 'welcomeText',
      },
    },
    logo: 'logo',
    logoMetadata: {
      fileExtension: 'fileExtension',
      lastUploadTimestamp: 'lastUploadTimestamp',
      mimeType: 'mimeType',
    },
    termsOfService: 'termsOfService',
    wallpaper: 'wallpaper',
    wallpaperMetadata: {
      fileExtension: 'fileExtension',
      lastUploadTimestamp: 'lastUploadTimestamp',
      mimeType: 'mimeType',
    },
  },
  cookieSynchronizationConfiguration: {
    allowlist: [{
      domain: 'domain',
      name: 'name',
      path: 'path',
    }],
    blocklist: [{
      domain: 'domain',
      name: 'name',
      path: 'path',
    }],
  },
  copyAllowed: 'copyAllowed',
  customerManagedKey: 'customerManagedKey',
  deepLinkAllowed: 'deepLinkAllowed',
  disconnectTimeoutInMinutes: 123,
  downloadAllowed: 'downloadAllowed',
  idleDisconnectTimeoutInMinutes: 123,
  pasteAllowed: 'pasteAllowed',
  printAllowed: 'printAllowed',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  toolbarConfiguration: {
    hiddenToolbarItems: ['hiddenToolbarItems'],
    maxDisplayResolution: 'maxDisplayResolution',
    toolbarType: 'toolbarType',
    visualMode: 'visualMode',
  },
  uploadAllowed: 'uploadAllowed',
  webAuthnAllowed: 'webAuthnAllowed',
};

Properties

Name	Type	Description
additionalEncryptionContext?	{ [string]: string } | IResolvable	The additional encryption context of the user settings.
brandingConfiguration?	IResolvable | BrandingConfigurationProperty	The branding configuration that customizes the appearance of the web portal for end users.
cookieSynchronizationConfiguration?	IResolvable | CookieSynchronizationConfigurationProperty	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
copyAllowed?	string	Specifies whether the user can copy text from the streaming session to the local device.
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.
downloadAllowed?	string	Specifies whether the user can download files from the streaming session to the local device.
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.
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.
tags?	CfnTag[]	The tags to add to the user settings resource.
toolbarConfiguration?	IResolvable | ToolbarConfigurationProperty	The configuration of the toolbar.
uploadAllowed?	string	Specifies whether the user can upload files from the local device to the streaming session.
webAuthnAllowed?	string	Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

---

additionalEncryptionContext?

Type: { [string]: string } | IResolvable (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

---

brandingConfiguration?

Type: IResolvable | BrandingConfigurationProperty (optional)

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

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

---

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

---

copyAllowed?

Type: string (optional)

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

---

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

---

downloadAllowed?

Type: string (optional)

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

---

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

---

pasteAllowed?

Type: string (optional)

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 (optional)

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

---

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

---

toolbarConfiguration?

Type: IResolvable | ToolbarConfigurationProperty (optional)

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.

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

---

uploadAllowed?

Type: string (optional)

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

---

webAuthnAllowed?

Type: string (optional)

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

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