class CfnUserSettingsPropsMixin

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

Implements IMixin

Extends Mixin

This resource specifies user settings 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.

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 } from '@aws-cdk/mixins-preview';
import { mixins as workspacesweb_mixins } from '@aws-cdk/mixins-preview/aws-workspacesweb';
const cfnUserSettingsPropsMixin = new workspacesweb_mixins.CfnUserSettingsPropsMixin({
  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',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnUserSettingsPropsMixin(props: CfnUserSettingsMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnUserSettingsMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::WorkSpacesWeb::UserSettings.

Properties

Name	Type	Description
props	CfnUserSettingsMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnUserSettingsMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.