Skip to content
v2.277.0

CfnUserSettingsProps Struct ​

Properties for defining a CfnUserSettings.

Example ​

ts
// 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',
  },
  brandingConfiguration: {
    colorTheme: 'colorTheme',
    favicon: 'favicon',
    faviconMetadata: {
      fileExtension: 'fileExtension',
      lastUploadTimestamp: 'lastUploadTimestamp',
      mimeType: 'mimeType',
    },
    localizedStrings: {
      localizedStringsKey: {
        browserTabTitle: 'browserTabTitle',
        welcomeText: 'welcomeText',

        // the properties below are optional
        contactButtonText: 'contactButtonText',
        contactLink: 'contactLink',
        loadingText: 'loadingText',
        loginButtonText: 'loginButtonText',
        loginDescription: 'loginDescription',
        loginTitle: 'loginTitle',
      },
    },
    logo: 'logo',
    logoMetadata: {
      fileExtension: 'fileExtension',
      lastUploadTimestamp: 'lastUploadTimestamp',
      mimeType: 'mimeType',
    },
    termsOfService: 'termsOfService',
    wallpaper: 'wallpaper',
    wallpaperMetadata: {
      fileExtension: 'fileExtension',
      lastUploadTimestamp: 'lastUploadTimestamp',
      mimeType: 'mimeType',
    },
  },
  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',
  }],
  toolbarConfiguration: {
    hiddenToolbarItems: ['hiddenToolbarItems'],
    maxDisplayResolution: 'maxDisplayResolution',
    toolbarType: 'toolbarType',
    visualMode: 'visualMode',
  },
  webAuthnAllowed: 'webAuthnAllowed',
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspacesweb as workspacesweb

cfn_user_settings_props = workspacesweb.CfnUserSettingsProps(
    copy_allowed="copyAllowed",
    download_allowed="downloadAllowed",
    paste_allowed="pasteAllowed",
    print_allowed="printAllowed",
    upload_allowed="uploadAllowed",

    # the properties below are optional
    additional_encryption_context={
        "additional_encryption_context_key": "additionalEncryptionContext"
    },
    branding_configuration=workspacesweb.CfnUserSettings.BrandingConfigurationProperty(
        color_theme="colorTheme",
        favicon="favicon",
        favicon_metadata=workspacesweb.CfnUserSettings.ImageMetadataProperty(
            file_extension="fileExtension",
            last_upload_timestamp="lastUploadTimestamp",
            mime_type="mimeType"
        ),
        localized_strings={
            "localized_strings_key": workspacesweb.CfnUserSettings.LocalizedBrandingStringsProperty(
                browser_tab_title="browserTabTitle",
                welcome_text="welcomeText",

                # the properties below are optional
                contact_button_text="contactButtonText",
                contact_link="contactLink",
                loading_text="loadingText",
                login_button_text="loginButtonText",
                login_description="loginDescription",
                login_title="loginTitle"
            )
        },
        logo="logo",
        logo_metadata=workspacesweb.CfnUserSettings.ImageMetadataProperty(
            file_extension="fileExtension",
            last_upload_timestamp="lastUploadTimestamp",
            mime_type="mimeType"
        ),
        terms_of_service="termsOfService",
        wallpaper="wallpaper",
        wallpaper_metadata=workspacesweb.CfnUserSettings.ImageMetadataProperty(
            file_extension="fileExtension",
            last_upload_timestamp="lastUploadTimestamp",
            mime_type="mimeType"
        )
    ),
    cookie_synchronization_configuration=workspacesweb.CfnUserSettings.CookieSynchronizationConfigurationProperty(
        allowlist=[workspacesweb.CfnUserSettings.CookieSpecificationProperty(
            domain="domain",

            # the properties below are optional
            name="name",
            path="path"
        )],

        # the properties below are optional
        blocklist=[workspacesweb.CfnUserSettings.CookieSpecificationProperty(
            domain="domain",

            # the properties below are optional
            name="name",
            path="path"
        )]
    ),
    customer_managed_key="customerManagedKey",
    deep_link_allowed="deepLinkAllowed",
    disconnect_timeout_in_minutes=123,
    idle_disconnect_timeout_in_minutes=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    toolbar_configuration=workspacesweb.CfnUserSettings.ToolbarConfigurationProperty(
        hidden_toolbar_items=["hiddenToolbarItems"],
        max_display_resolution="maxDisplayResolution",
        toolbar_type="toolbarType",
        visual_mode="visualMode"
    ),
    web_authn_allowed="webAuthnAllowed"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.workspacesweb.*;

CfnUserSettingsProps cfnUserSettingsProps = CfnUserSettingsProps.builder()
        .copyAllowed("copyAllowed")
        .downloadAllowed("downloadAllowed")
        .pasteAllowed("pasteAllowed")
        .printAllowed("printAllowed")
        .uploadAllowed("uploadAllowed")

        // the properties below are optional
        .additionalEncryptionContext(Map.of(
                "additionalEncryptionContextKey", "additionalEncryptionContext"))
        .brandingConfiguration(BrandingConfigurationProperty.builder()
                .colorTheme("colorTheme")
                .favicon("favicon")
                .faviconMetadata(ImageMetadataProperty.builder()
                        .fileExtension("fileExtension")
                        .lastUploadTimestamp("lastUploadTimestamp")
                        .mimeType("mimeType")
                        .build())
                .localizedStrings(Map.of(
                        "localizedStringsKey", LocalizedBrandingStringsProperty.builder()
                                .browserTabTitle("browserTabTitle")
                                .welcomeText("welcomeText")

                                // the properties below are optional
                                .contactButtonText("contactButtonText")
                                .contactLink("contactLink")
                                .loadingText("loadingText")
                                .loginButtonText("loginButtonText")
                                .loginDescription("loginDescription")
                                .loginTitle("loginTitle")
                                .build()))
                .logo("logo")
                .logoMetadata(ImageMetadataProperty.builder()
                        .fileExtension("fileExtension")
                        .lastUploadTimestamp("lastUploadTimestamp")
                        .mimeType("mimeType")
                        .build())
                .termsOfService("termsOfService")
                .wallpaper("wallpaper")
                .wallpaperMetadata(ImageMetadataProperty.builder()
                        .fileExtension("fileExtension")
                        .lastUploadTimestamp("lastUploadTimestamp")
                        .mimeType("mimeType")
                        .build())
                .build())
        .cookieSynchronizationConfiguration(CookieSynchronizationConfigurationProperty.builder()
                .allowlist(List.of(CookieSpecificationProperty.builder()
                        .domain("domain")

                        // the properties below are optional
                        .name("name")
                        .path("path")
                        .build()))

                // the properties below are optional
                .blocklist(List.of(CookieSpecificationProperty.builder()
                        .domain("domain")

                        // the properties below are optional
                        .name("name")
                        .path("path")
                        .build()))
                .build())
        .customerManagedKey("customerManagedKey")
        .deepLinkAllowed("deepLinkAllowed")
        .disconnectTimeoutInMinutes(123)
        .idleDisconnectTimeoutInMinutes(123)
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .toolbarConfiguration(ToolbarConfigurationProperty.builder()
                .hiddenToolbarItems(List.of("hiddenToolbarItems"))
                .maxDisplayResolution("maxDisplayResolution")
                .toolbarType("toolbarType")
                .visualMode("visualMode")
                .build())
        .webAuthnAllowed("webAuthnAllowed")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WorkSpacesWeb;

var cfnUserSettingsProps = new CfnUserSettingsProps {
    CopyAllowed = "copyAllowed",
    DownloadAllowed = "downloadAllowed",
    PasteAllowed = "pasteAllowed",
    PrintAllowed = "printAllowed",
    UploadAllowed = "uploadAllowed",

    // the properties below are optional
    AdditionalEncryptionContext = new Dictionary<string, string> {
        { "additionalEncryptionContextKey", "additionalEncryptionContext" }
    },
    BrandingConfiguration = new BrandingConfigurationProperty {
        ColorTheme = "colorTheme",
        Favicon = "favicon",
        FaviconMetadata = new ImageMetadataProperty {
            FileExtension = "fileExtension",
            LastUploadTimestamp = "lastUploadTimestamp",
            MimeType = "mimeType"
        },
        LocalizedStrings = new Dictionary<string, object> {
            { "localizedStringsKey", new LocalizedBrandingStringsProperty {
                BrowserTabTitle = "browserTabTitle",
                WelcomeText = "welcomeText",

                // the properties below are optional
                ContactButtonText = "contactButtonText",
                ContactLink = "contactLink",
                LoadingText = "loadingText",
                LoginButtonText = "loginButtonText",
                LoginDescription = "loginDescription",
                LoginTitle = "loginTitle"
            } }
        },
        Logo = "logo",
        LogoMetadata = new ImageMetadataProperty {
            FileExtension = "fileExtension",
            LastUploadTimestamp = "lastUploadTimestamp",
            MimeType = "mimeType"
        },
        TermsOfService = "termsOfService",
        Wallpaper = "wallpaper",
        WallpaperMetadata = new ImageMetadataProperty {
            FileExtension = "fileExtension",
            LastUploadTimestamp = "lastUploadTimestamp",
            MimeType = "mimeType"
        }
    },
    CookieSynchronizationConfiguration = new CookieSynchronizationConfigurationProperty {
        Allowlist = new [] { new CookieSpecificationProperty {
            Domain = "domain",

            // the properties below are optional
            Name = "name",
            Path = "path"
        } },

        // the properties below are optional
        Blocklist = new [] { new CookieSpecificationProperty {
            Domain = "domain",

            // the properties below are optional
            Name = "name",
            Path = "path"
        } }
    },
    CustomerManagedKey = "customerManagedKey",
    DeepLinkAllowed = "deepLinkAllowed",
    DisconnectTimeoutInMinutes = 123,
    IdleDisconnectTimeoutInMinutes = 123,
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    ToolbarConfiguration = new ToolbarConfigurationProperty {
        HiddenToolbarItems = new [] { "hiddenToolbarItems" },
        MaxDisplayResolution = "maxDisplayResolution",
        ToolbarType = "toolbarType",
        VisualMode = "visualMode"
    },
    WebAuthnAllowed = "webAuthnAllowed"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnUserSettingsProps := &CfnUserSettingsProps{
	CopyAllowed: jsii.String("copyAllowed"),
	DownloadAllowed: jsii.String("downloadAllowed"),
	PasteAllowed: jsii.String("pasteAllowed"),
	PrintAllowed: jsii.String("printAllowed"),
	UploadAllowed: jsii.String("uploadAllowed"),

	// the properties below are optional
	AdditionalEncryptionContext: map[string]*string{
		"additionalEncryptionContextKey": jsii.String("additionalEncryptionContext"),
	},
	BrandingConfiguration: &BrandingConfigurationProperty{
		ColorTheme: jsii.String("colorTheme"),
		Favicon: jsii.String("favicon"),
		FaviconMetadata: &ImageMetadataProperty{
			FileExtension: jsii.String("fileExtension"),
			LastUploadTimestamp: jsii.String("lastUploadTimestamp"),
			MimeType: jsii.String("mimeType"),
		},
		LocalizedStrings: map[string]interface{}{
			"localizedStringsKey": &LocalizedBrandingStringsProperty{
				"browserTabTitle": jsii.String("browserTabTitle"),
				"welcomeText": jsii.String("welcomeText"),

				// the properties below are optional
				"contactButtonText": jsii.String("contactButtonText"),
				"contactLink": jsii.String("contactLink"),
				"loadingText": jsii.String("loadingText"),
				"loginButtonText": jsii.String("loginButtonText"),
				"loginDescription": jsii.String("loginDescription"),
				"loginTitle": jsii.String("loginTitle"),
			},
		},
		Logo: jsii.String("logo"),
		LogoMetadata: &ImageMetadataProperty{
			FileExtension: jsii.String("fileExtension"),
			LastUploadTimestamp: jsii.String("lastUploadTimestamp"),
			MimeType: jsii.String("mimeType"),
		},
		TermsOfService: jsii.String("termsOfService"),
		Wallpaper: jsii.String("wallpaper"),
		WallpaperMetadata: &ImageMetadataProperty{
			FileExtension: jsii.String("fileExtension"),
			LastUploadTimestamp: jsii.String("lastUploadTimestamp"),
			MimeType: jsii.String("mimeType"),
		},
	},
	CookieSynchronizationConfiguration: &CookieSynchronizationConfigurationProperty{
		Allowlist: []interface{}{
			&CookieSpecificationProperty{
				Domain: jsii.String("domain"),

				// the properties below are optional
				Name: jsii.String("name"),
				Path: jsii.String("path"),
			},
		},

		// the properties below are optional
		Blocklist: []interface{}{
			&CookieSpecificationProperty{
				Domain: jsii.String("domain"),

				// the properties below are optional
				Name: jsii.String("name"),
				Path: jsii.String("path"),
			},
		},
	},
	CustomerManagedKey: jsii.String("customerManagedKey"),
	DeepLinkAllowed: jsii.String("deepLinkAllowed"),
	DisconnectTimeoutInMinutes: jsii.Number(123),
	IdleDisconnectTimeoutInMinutes: jsii.Number(123),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	ToolbarConfiguration: &ToolbarConfigurationProperty{
		HiddenToolbarItems: []*string{
			jsii.String("hiddenToolbarItems"),
		},
		MaxDisplayResolution: jsii.String("maxDisplayResolution"),
		ToolbarType: jsii.String("toolbarType"),
		VisualMode: jsii.String("visualMode"),
	},
	WebAuthnAllowed: jsii.String("webAuthnAllowed"),
}

Properties ​

additionalEncryptionContextoptionalIResolvable | { [key: string]: string }additional_encryption_contextoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]additionalEncryptionContextoptionalIResolvableAdditionalEncryptionContextoptionalIResolvableAdditionalEncryptionContextoptionalinterface{} #
The additional encryption context of the user settings.
brandingConfigurationoptionalIResolvable | CfnUserSettings.BrandingConfigurationPropertybranding_configurationoptionaltyping.Union[IResolvable, BrandingConfigurationProperty]brandingConfigurationoptionalIResolvableBrandingConfigurationoptionalIResolvableBrandingConfigurationoptionalinterface{} #
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.

cookieSynchronizationConfigurationoptionalIResolvable | CfnUserSettings.CookieSynchronizationConfigurationPropertycookie_synchronization_configurationoptionaltyping.Union[IResolvable, CookieSynchronizationConfigurationProperty]cookieSynchronizationConfigurationoptionalIResolvableCookieSynchronizationConfigurationoptionalIResolvableCookieSynchronizationConfigurationoptionalinterface{} #
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
copyAllowedstringcopy_allowedstrcopyAllowedStringCopyAllowedstringCopyAllowed*string required #
Specifies whether the user can copy text from the streaming session to the local device.
customerManagedKeyoptionalstringcustomer_managed_keyoptionalstrcustomerManagedKeyoptionalStringCustomerManagedKeyoptionalstringCustomerManagedKeyoptional*string #
The customer managed key used to encrypt sensitive information in the user settings.
deepLinkAllowedoptionalstringdeep_link_allowedoptionalstrdeepLinkAllowedoptionalStringDeepLinkAllowedoptionalstringDeepLinkAllowedoptional*string #
Specifies whether the user can use deep links that open automatically when connecting to a session.
disconnectTimeoutInMinutesoptionalnumberdisconnect_timeout_in_minutesoptionalint | floatdisconnectTimeoutInMinutesoptionalNumberDisconnectTimeoutInMinutesoptionaldoubleDisconnectTimeoutInMinutesoptional*float64 #
The amount of time that a streaming session remains active after users disconnect.
downloadAllowedstringdownload_allowedstrdownloadAllowedStringDownloadAllowedstringDownloadAllowed*string required #
Specifies whether the user can download files from the streaming session to the local device.
idleDisconnectTimeoutInMinutesoptionalnumberidle_disconnect_timeout_in_minutesoptionalint | floatidleDisconnectTimeoutInMinutesoptionalNumberIdleDisconnectTimeoutInMinutesoptionaldoubleIdleDisconnectTimeoutInMinutesoptional*float64 #
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
pasteAllowedstringpaste_allowedstrpasteAllowedStringPasteAllowedstringPasteAllowed*string required #
Specifies whether the user can paste text from the local device to the streaming session.
printAllowedstringprint_allowedstrprintAllowedStringPrintAllowedstringPrintAllowed*string required #
Specifies whether the user can print to the local device.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
The tags to add to the user settings resource.

A tag is a key-value pair.

toolbarConfigurationoptionalIResolvable | CfnUserSettings.ToolbarConfigurationPropertytoolbar_configurationoptionaltyping.Union[IResolvable, ToolbarConfigurationProperty]toolbarConfigurationoptionalIResolvableToolbarConfigurationoptionalIResolvableToolbarConfigurationoptionalinterface{} #
The configuration of the toolbar.
notes

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.

uploadAllowedstringupload_allowedstruploadAllowedStringUploadAllowedstringUploadAllowed*string required #
Specifies whether the user can upload files from the local device to the streaming session.
webAuthnAllowedoptionalstringweb_authn_allowedoptionalstrwebAuthnAllowedoptionalStringWebAuthnAllowedoptionalstringWebAuthnAllowedoptional*string #
Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.