Class CfnUserSettings

This resource specifies user settings that can be associated with a web portal.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnUserSettings
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.WorkSpacesWeb
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUserSettings : CfnResource, IInspectable, IUserSettingsRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnUserSettings Inherits CfnResource Implements IInspectable, IUserSettingsRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

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.AWS.WorkSpacesWeb;

             var cfnUserSettings = new CfnUserSettings(this, "MyCfnUserSettings", 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"
             });

Synopsis

Constructors

CfnUserSettings(Construct, string, ICfnUserSettingsProps)

Create a new AWS::WorkSpacesWeb::UserSettings.

Properties

AdditionalEncryptionContext

The additional encryption context of the user settings.
AttrAssociatedPortalArns

A list of web portal ARNs that this user settings resource is associated with.
AttrBrandingConfigurationFaviconMetadata

Read-only.
AttrBrandingConfigurationLogoMetadata

Read-only.
AttrBrandingConfigurationWallpaperMetadata

Read-only.
AttrUserSettingsArn

The ARN of the user settings.
BrandingConfiguration

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

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

This resource specifies user settings that can be associated with a web portal.
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.
UserSettingsRef

A reference to a UserSettings resource.
WebAuthnAllowed

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

Methods

ArnForUserSettings(IUserSettingsRef)

This resource specifies user settings that can be associated with a web portal.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnUserSettings(object)

Checks whether the given object is a CfnUserSettings.
RenderProperties(IDictionary<string, object>)

This resource specifies user settings that can be associated with a web portal.

Constructors

CfnUserSettings(Construct, string, ICfnUserSettingsProps)

Create a new AWS::WorkSpacesWeb::UserSettings.

public CfnUserSettings(Construct scope, string id, ICfnUserSettingsProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnUserSettingsProps

Resource properties.

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

Properties

AdditionalEncryptionContext

The additional encryption context of the user settings.

public virtual object? AdditionalEncryptionContext { get; set; }
Property Value

object

Remarks

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

AttrAssociatedPortalArns

A list of web portal ARNs that this user settings resource is associated with.

public virtual string[] AttrAssociatedPortalArns { get; }
Property Value

string[]

Remarks

CloudformationAttribute: AssociatedPortalArns

AttrBrandingConfigurationFaviconMetadata

Read-only.

public virtual IResolvable AttrBrandingConfigurationFaviconMetadata { get; }
Property Value

IResolvable

Remarks

Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

CloudformationAttribute: BrandingConfiguration.FaviconMetadata

AttrBrandingConfigurationLogoMetadata

Read-only.

public virtual IResolvable AttrBrandingConfigurationLogoMetadata { get; }
Property Value

IResolvable

Remarks

Metadata for the logo image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

CloudformationAttribute: BrandingConfiguration.LogoMetadata

AttrBrandingConfigurationWallpaperMetadata

Read-only.

public virtual IResolvable AttrBrandingConfigurationWallpaperMetadata { get; }
Property Value

IResolvable

Remarks

Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

CloudformationAttribute: BrandingConfiguration.WallpaperMetadata

AttrUserSettingsArn

The ARN of the user settings.

public virtual string AttrUserSettingsArn { get; }
Property Value

string

Remarks

CloudformationAttribute: UserSettingsArn

BrandingConfiguration

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

public virtual object? BrandingConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnUserSettings.IBrandingConfigurationProperty

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

CfnProperties

This resource specifies user settings that can be associated with a web portal.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

CookieSynchronizationConfiguration

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

public virtual object? CookieSynchronizationConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnUserSettings.ICookieSynchronizationConfigurationProperty

CopyAllowed

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

public virtual string CopyAllowed { get; set; }
Property Value

string

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

CustomerManagedKey

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

public virtual string? CustomerManagedKey { get; set; }
Property Value

string

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

DeepLinkAllowed

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

public virtual string? DeepLinkAllowed { get; set; }
Property Value

string

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

DisconnectTimeoutInMinutes

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

public virtual double? DisconnectTimeoutInMinutes { get; set; }
Property Value

double?

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

DownloadAllowed

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

public virtual string DownloadAllowed { get; set; }
Property Value

string

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

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 virtual double? IdleDisconnectTimeoutInMinutes { get; set; }
Property Value

double?

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

PasteAllowed

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

public virtual string PasteAllowed { get; set; }
Property Value

string

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

PrintAllowed

Specifies whether the user can print to the local device.

public virtual string PrintAllowed { get; set; }
Property Value

string

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

Tags

The tags to add to the user settings resource.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

ToolbarConfiguration

The configuration of the toolbar.

public virtual object? ToolbarConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnUserSettings.IToolbarConfigurationProperty

UploadAllowed

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

public virtual string UploadAllowed { get; set; }
Property Value

string

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

UserSettingsRef

A reference to a UserSettings resource.

public virtual IUserSettingsReference UserSettingsRef { get; }
Property Value

IUserSettingsReference

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

WebAuthnAllowed

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

public virtual string? WebAuthnAllowed { get; set; }
Property Value

string

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

Methods

ArnForUserSettings(IUserSettingsRef)

This resource specifies user settings that can be associated with a web portal.

public static string ArnForUserSettings(IUserSettingsRef resource)
Parameters
resource IUserSettingsRef
Returns

string

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

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.AWS.WorkSpacesWeb;

             var cfnUserSettings = new CfnUserSettings(this, "MyCfnUserSettings", 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"
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

IsCfnUserSettings(object)

Checks whether the given object is a CfnUserSettings.

public static bool IsCfnUserSettings(object x)
Parameters
x object
Returns

bool

Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

This resource specifies user settings that can be associated with a web portal.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

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

CloudformationResource: AWS::WorkSpacesWeb::UserSettings

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable