Package software.amazon.awscdk.cfnpropertymixins.services.workspacesweb

Class CfnUserSettingsPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.workspacesweb.CfnUserSettingsPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserSettingsPropsMixin>

Enclosing class:

CfnUserSettingsPropsMixin

@Stability(Stable)
public static final class CfnUserSettingsPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserSettingsPropsMixin>

A fluent builder for CfnUserSettingsPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnUserSettingsPropsMixin.Builder	additionalEncryptionContext(Map<String,String> additionalEncryptionContext)	The additional encryption context of the user settings.
CfnUserSettingsPropsMixin.Builder	additionalEncryptionContext(IResolvable additionalEncryptionContext)	The additional encryption context of the user settings.
CfnUserSettingsPropsMixin.Builder	brandingConfiguration(CfnUserSettingsPropsMixin.BrandingConfigurationProperty brandingConfiguration)	The branding configuration that customizes the appearance of the web portal for end users.
CfnUserSettingsPropsMixin.Builder	brandingConfiguration(IResolvable brandingConfiguration)	The branding configuration that customizes the appearance of the web portal for end users.
CfnUserSettingsPropsMixin	build()
CfnUserSettingsPropsMixin.Builder	cookieSynchronizationConfiguration(CfnUserSettingsPropsMixin.CookieSynchronizationConfigurationProperty cookieSynchronizationConfiguration)	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
CfnUserSettingsPropsMixin.Builder	cookieSynchronizationConfiguration(IResolvable cookieSynchronizationConfiguration)	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
CfnUserSettingsPropsMixin.Builder	copyAllowed(String copyAllowed)	Specifies whether the user can copy text from the streaming session to the local device.
static CfnUserSettingsPropsMixin.Builder	create()
static CfnUserSettingsPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnUserSettingsPropsMixin.Builder	customerManagedKey(String customerManagedKey)	The customer managed key used to encrypt sensitive information in the user settings.
CfnUserSettingsPropsMixin.Builder	deepLinkAllowed(String deepLinkAllowed)	Specifies whether the user can use deep links that open automatically when connecting to a session.
CfnUserSettingsPropsMixin.Builder	disconnectTimeoutInMinutes(Number disconnectTimeoutInMinutes)	The amount of time that a streaming session remains active after users disconnect.
CfnUserSettingsPropsMixin.Builder	downloadAllowed(String downloadAllowed)	Specifies whether the user can download files from the streaming session to the local device.
CfnUserSettingsPropsMixin.Builder	idleDisconnectTimeoutInMinutes(Number 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.
CfnUserSettingsPropsMixin.Builder	pasteAllowed(String pasteAllowed)	Specifies whether the user can paste text from the local device to the streaming session.
CfnUserSettingsPropsMixin.Builder	printAllowed(String printAllowed)	Specifies whether the user can print to the local device.
CfnUserSettingsPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The tags to add to the user settings resource.
CfnUserSettingsPropsMixin.Builder	toolbarConfiguration(CfnUserSettingsPropsMixin.ToolbarConfigurationProperty toolbarConfiguration)	The configuration of the toolbar.
CfnUserSettingsPropsMixin.Builder	toolbarConfiguration(IResolvable toolbarConfiguration)	The configuration of the toolbar.
CfnUserSettingsPropsMixin.Builder	uploadAllowed(String uploadAllowed)	Specifies whether the user can upload files from the local device to the streaming session.
CfnUserSettingsPropsMixin.Builder	webAuthnAllowed(String webAuthnAllowed)	Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnUserSettingsPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnUserSettingsPropsMixin.Builder.

create

@Stability(Stable)
public static CfnUserSettingsPropsMixin.Builder create()

Returns:

a new instance of CfnUserSettingsPropsMixin.Builder.

additionalEncryptionContext

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder additionalEncryptionContext(Map<String,String> additionalEncryptionContext)

The additional encryption context of the user settings.

Parameters:

additionalEncryptionContext - The additional encryption context of the user settings. This parameter is required.

Returns:

this

See Also:

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

additionalEncryptionContext

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder additionalEncryptionContext(IResolvable additionalEncryptionContext)

The additional encryption context of the user settings.

Parameters:

additionalEncryptionContext - The additional encryption context of the user settings. This parameter is required.

Returns:

this

See Also:

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

brandingConfiguration

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder brandingConfiguration(IResolvable brandingConfiguration)

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.

Parameters:

brandingConfiguration - The branding configuration that customizes the appearance of the web portal for end users. This parameter is required.

Returns:

this

See Also:

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

brandingConfiguration

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder brandingConfiguration(CfnUserSettingsPropsMixin.BrandingConfigurationProperty brandingConfiguration)

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.

Parameters:

brandingConfiguration - The branding configuration that customizes the appearance of the web portal for end users. This parameter is required.

Returns:

this

See Also:

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

cookieSynchronizationConfiguration

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder cookieSynchronizationConfiguration(IResolvable cookieSynchronizationConfiguration)

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

Parameters:

cookieSynchronizationConfiguration - The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. This parameter is required.

Returns:

this

See Also:

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

cookieSynchronizationConfiguration

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder cookieSynchronizationConfiguration(CfnUserSettingsPropsMixin.CookieSynchronizationConfigurationProperty cookieSynchronizationConfiguration)

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

Parameters:

cookieSynchronizationConfiguration - The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. This parameter is required.

Returns:

this

See Also:

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

copyAllowed

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder copyAllowed(String copyAllowed)

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

Parameters:

copyAllowed - Specifies whether the user can copy text from the streaming session to the local device. This parameter is required.

Returns:

this

See Also:

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

customerManagedKey

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder customerManagedKey(String customerManagedKey)

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

Parameters:

customerManagedKey - The customer managed key used to encrypt sensitive information in the user settings. This parameter is required.

Returns:

this

See Also:

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

deepLinkAllowed

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder deepLinkAllowed(String deepLinkAllowed)

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

Parameters:

deepLinkAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. This parameter is required.

Returns:

this

See Also:

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

disconnectTimeoutInMinutes

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder disconnectTimeoutInMinutes(Number disconnectTimeoutInMinutes)

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

Parameters:

disconnectTimeoutInMinutes - The amount of time that a streaming session remains active after users disconnect. This parameter is required.

Returns:

this

See Also:

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

downloadAllowed

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder downloadAllowed(String downloadAllowed)

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

Parameters:

downloadAllowed - Specifies whether the user can download files from the streaming session to the local device. This parameter is required.

Returns:

this

See Also:

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

idleDisconnectTimeoutInMinutes

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder idleDisconnectTimeoutInMinutes(Number 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

pasteAllowed

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder pasteAllowed(String pasteAllowed)

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

Parameters:

pasteAllowed - Specifies whether the user can paste text from the local device to the streaming session. This parameter is required.

Returns:

this

See Also:

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

printAllowed

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder printAllowed(String printAllowed)

Specifies whether the user can print to the local device.

Parameters:

printAllowed - Specifies whether the user can print to the local device. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder tags(List<? extends CfnTag> tags)

The tags to add to the user settings resource.

A tag is a key-value pair.

Parameters:

tags - The tags to add to the user settings resource. This parameter is required.

Returns:

this

See Also:

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

toolbarConfiguration

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder toolbarConfiguration(IResolvable toolbarConfiguration)

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.

Parameters:

toolbarConfiguration - The configuration of the toolbar. This parameter is required.

Returns:

this

See Also:

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

toolbarConfiguration

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder toolbarConfiguration(CfnUserSettingsPropsMixin.ToolbarConfigurationProperty toolbarConfiguration)

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.

Parameters:

toolbarConfiguration - The configuration of the toolbar. This parameter is required.

Returns:

this

See Also:

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

uploadAllowed

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder uploadAllowed(String uploadAllowed)

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

Parameters:

uploadAllowed - Specifies whether the user can upload files from the local device to the streaming session. This parameter is required.

Returns:

this

See Also:

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

webAuthnAllowed

@Stability(Stable)
public CfnUserSettingsPropsMixin.Builder webAuthnAllowed(String webAuthnAllowed)

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

Parameters:

webAuthnAllowed - Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnUserSettingsPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserSettingsPropsMixin>

Returns:

a newly built instance of CfnUserSettingsPropsMixin.