Class CfnUserSettingsMixinProps

Properties for CfnUserSettingsPropsMixin.

Inheritance

object

CfnUserSettingsMixinProps

Implements

ICfnUserSettingsMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.WorkSpacesWeb.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnUserSettingsMixinProps : ICfnUserSettingsMixinProps

Syntax (vb)

Public Class CfnUserSettingsMixinProps Implements ICfnUserSettingsMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.WorkSpacesWeb.Mixins;

             var cfnUserSettingsMixinProps = new CfnUserSettingsMixinProps {
                 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",
                             ContactButtonText = "contactButtonText",
                             ContactLink = "contactLink",
                             LoadingText = "loadingText",
                             LoginButtonText = "loginButtonText",
                             LoginDescription = "loginDescription",
                             LoginTitle = "loginTitle",
                             WelcomeText = "welcomeText"
                         } }
                     },
                     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",
                         Name = "name",
                         Path = "path"
                     } },
                     Blocklist = new [] { new CookieSpecificationProperty {
                         Domain = "domain",
                         Name = "name",
                         Path = "path"
                     } }
                 },
                 CopyAllowed = "copyAllowed",
                 CustomerManagedKey = "customerManagedKey",
                 DeepLinkAllowed = "deepLinkAllowed",
                 DisconnectTimeoutInMinutes = 123,
                 DownloadAllowed = "downloadAllowed",
                 IdleDisconnectTimeoutInMinutes = 123,
                 PasteAllowed = "pasteAllowed",
                 PrintAllowed = "printAllowed",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 ToolbarConfiguration = new ToolbarConfigurationProperty {
                     HiddenToolbarItems = new [] { "hiddenToolbarItems" },
                     MaxDisplayResolution = "maxDisplayResolution",
                     ToolbarType = "toolbarType",
                     VisualMode = "visualMode"
                 },
                 UploadAllowed = "uploadAllowed",
                 WebAuthnAllowed = "webAuthnAllowed"
             };

Synopsis

Constructors

CfnUserSettingsMixinProps()

Properties for CfnUserSettingsPropsMixin.

Properties

AdditionalEncryptionContext	The additional encryption context of the user settings.
BrandingConfiguration	The branding configuration that customizes the appearance of the web portal for end users.
CookieSynchronizationConfiguration	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
CopyAllowed	Specifies whether the user can copy text from the streaming session to the local device.
CustomerManagedKey	The customer managed key used to encrypt sensitive information in the user settings.
DeepLinkAllowed	Specifies whether the user can use deep links that open automatically when connecting to a session.
DisconnectTimeoutInMinutes	The amount of time that a streaming session remains active after users disconnect.
DownloadAllowed	Specifies whether the user can download files from the streaming session to the local device.
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.
PasteAllowed	Specifies whether the user can paste text from the local device to the streaming session.
PrintAllowed	Specifies whether the user can print to the local device.
Tags	The tags to add to the user settings resource.
ToolbarConfiguration	The configuration of the toolbar.
UploadAllowed	Specifies whether the user can upload files from the local device to the streaming session.
WebAuthnAllowed	Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

Constructors

CfnUserSettingsMixinProps()

Properties for CfnUserSettingsPropsMixin.

public CfnUserSettingsMixinProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.WorkSpacesWeb.Mixins;

             var cfnUserSettingsMixinProps = new CfnUserSettingsMixinProps {
                 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",
                             ContactButtonText = "contactButtonText",
                             ContactLink = "contactLink",
                             LoadingText = "loadingText",
                             LoginButtonText = "loginButtonText",
                             LoginDescription = "loginDescription",
                             LoginTitle = "loginTitle",
                             WelcomeText = "welcomeText"
                         } }
                     },
                     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",
                         Name = "name",
                         Path = "path"
                     } },
                     Blocklist = new [] { new CookieSpecificationProperty {
                         Domain = "domain",
                         Name = "name",
                         Path = "path"
                     } }
                 },
                 CopyAllowed = "copyAllowed",
                 CustomerManagedKey = "customerManagedKey",
                 DeepLinkAllowed = "deepLinkAllowed",
                 DisconnectTimeoutInMinutes = 123,
                 DownloadAllowed = "downloadAllowed",
                 IdleDisconnectTimeoutInMinutes = 123,
                 PasteAllowed = "pasteAllowed",
                 PrintAllowed = "printAllowed",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 ToolbarConfiguration = new ToolbarConfigurationProperty {
                     HiddenToolbarItems = new [] { "hiddenToolbarItems" },
                     MaxDisplayResolution = "maxDisplayResolution",
                     ToolbarType = "toolbarType",
                     VisualMode = "visualMode"
                 },
                 UploadAllowed = "uploadAllowed",
                 WebAuthnAllowed = "webAuthnAllowed"
             };

Properties

AdditionalEncryptionContext

The additional encryption context of the user settings.

public object? AdditionalEncryptionContext { get; set; }

Property Value

object

Remarks

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

Type union: either Dictionary<string, string> or IResolvable

BrandingConfiguration

The branding configuration that customizes the appearance of the web portal for end users.

public object? BrandingConfiguration { get; set; }

Property Value

object

Remarks

This includes a custom logo, favicon, wallpaper, localized strings, color theme, and an optional terms of service.

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

Type union: either IResolvable or CfnUserSettingsPropsMixin.IBrandingConfigurationProperty

CookieSynchronizationConfiguration

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

public object? CookieSynchronizationConfiguration { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnUserSettingsPropsMixin.ICookieSynchronizationConfigurationProperty

CopyAllowed

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

public string? CopyAllowed { get; set; }

Property Value

string

Remarks

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

CustomerManagedKey

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

public string? CustomerManagedKey { get; set; }

Property Value

string

Remarks

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

DeepLinkAllowed

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

public string? DeepLinkAllowed { get; set; }

Property Value

string

Remarks

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

DisconnectTimeoutInMinutes

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

public double? DisconnectTimeoutInMinutes { get; set; }

Property Value

double?

Remarks

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

DownloadAllowed

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

public string? DownloadAllowed { get; set; }

Property Value

string

Remarks

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

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.

public double? IdleDisconnectTimeoutInMinutes { get; set; }

Property Value

double?

Remarks

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

PasteAllowed

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

public string? PasteAllowed { get; set; }

Property Value

string

Remarks

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

PrintAllowed

Specifies whether the user can print to the local device.

public string? PrintAllowed { get; set; }

Property Value

string

Remarks

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

Tags

The tags to add to the user settings resource.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

A tag is a key-value pair.

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

ToolbarConfiguration

The configuration of the toolbar.

public object? ToolbarConfiguration { get; set; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-toolbarconfiguration

Type union: either IResolvable or CfnUserSettingsPropsMixin.IToolbarConfigurationProperty

UploadAllowed

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

public string? UploadAllowed { get; set; }

Property Value

string

Remarks

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

WebAuthnAllowed

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

public string? WebAuthnAllowed { get; set; }

Property Value

string

Remarks

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

Implements

ICfnUserSettingsMixinProps