This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::WorkSpacesWeb::UserSettings
<a name="aws-resource-workspacesweb-usersettings"></a>

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. 

## Syntax
<a name="aws-resource-workspacesweb-usersettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-workspacesweb-usersettings-syntax.json"></a>

```
{
  "Type" : "AWS::WorkSpacesWeb::UserSettings",
  "Properties" : {
      "[AdditionalEncryptionContext](#cfn-workspacesweb-usersettings-additionalencryptioncontext)" : {Key: Value, ...},
      "[BrandingConfiguration](#cfn-workspacesweb-usersettings-brandingconfiguration)" : BrandingConfiguration,
      "[CookieSynchronizationConfiguration](#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration)" : CookieSynchronizationConfiguration,
      "[CopyAllowed](#cfn-workspacesweb-usersettings-copyallowed)" : String,
      "[CustomerManagedKey](#cfn-workspacesweb-usersettings-customermanagedkey)" : String,
      "[DeepLinkAllowed](#cfn-workspacesweb-usersettings-deeplinkallowed)" : String,
      "[DisconnectTimeoutInMinutes](#cfn-workspacesweb-usersettings-disconnecttimeoutinminutes)" : Number,
      "[DownloadAllowed](#cfn-workspacesweb-usersettings-downloadallowed)" : String,
      "[IdleDisconnectTimeoutInMinutes](#cfn-workspacesweb-usersettings-idledisconnecttimeoutinminutes)" : Number,
      "[PasteAllowed](#cfn-workspacesweb-usersettings-pasteallowed)" : String,
      "[PrintAllowed](#cfn-workspacesweb-usersettings-printallowed)" : String,
      "[Tags](#cfn-workspacesweb-usersettings-tags)" : [ Tag, ... ],
      "[ToolbarConfiguration](#cfn-workspacesweb-usersettings-toolbarconfiguration)" : ToolbarConfiguration,
      "[UploadAllowed](#cfn-workspacesweb-usersettings-uploadallowed)" : String,
      "[WebAuthnAllowed](#cfn-workspacesweb-usersettings-webauthnallowed)" : String
    }
}
```

### YAML
<a name="aws-resource-workspacesweb-usersettings-syntax.yaml"></a>

```
Type: AWS::WorkSpacesWeb::UserSettings
Properties:
  [AdditionalEncryptionContext](#cfn-workspacesweb-usersettings-additionalencryptioncontext): 
    Key: Value
  [BrandingConfiguration](#cfn-workspacesweb-usersettings-brandingconfiguration): 
    BrandingConfiguration
  [CookieSynchronizationConfiguration](#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration): 
    CookieSynchronizationConfiguration
  [CopyAllowed](#cfn-workspacesweb-usersettings-copyallowed): String
  [CustomerManagedKey](#cfn-workspacesweb-usersettings-customermanagedkey): String
  [DeepLinkAllowed](#cfn-workspacesweb-usersettings-deeplinkallowed): String
  [DisconnectTimeoutInMinutes](#cfn-workspacesweb-usersettings-disconnecttimeoutinminutes): Number
  [DownloadAllowed](#cfn-workspacesweb-usersettings-downloadallowed): String
  [IdleDisconnectTimeoutInMinutes](#cfn-workspacesweb-usersettings-idledisconnecttimeoutinminutes): Number
  [PasteAllowed](#cfn-workspacesweb-usersettings-pasteallowed): String
  [PrintAllowed](#cfn-workspacesweb-usersettings-printallowed): String
  [Tags](#cfn-workspacesweb-usersettings-tags): 
    - Tag
  [ToolbarConfiguration](#cfn-workspacesweb-usersettings-toolbarconfiguration): 
    ToolbarConfiguration
  [UploadAllowed](#cfn-workspacesweb-usersettings-uploadallowed): String
  [WebAuthnAllowed](#cfn-workspacesweb-usersettings-webauthnallowed): String
```

## Properties
<a name="aws-resource-workspacesweb-usersettings-properties"></a>

`AdditionalEncryptionContext`  <a name="cfn-workspacesweb-usersettings-additionalencryptioncontext"></a>
The additional encryption context of the user settings.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[\s\S]*$`  
*Minimum*: `0`  
*Maximum*: `131072`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BrandingConfiguration`  <a name="cfn-workspacesweb-usersettings-brandingconfiguration"></a>
The branding configuration that customizes the appearance of the web portal for end users. This includes a custom logo, favicon, localized strings, color theme, and optionally a wallpaper and terms of service.  
*Required*: No  
*Type*: [BrandingConfiguration](aws-properties-workspacesweb-usersettings-brandingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CookieSynchronizationConfiguration`  <a name="cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration"></a>
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.  
*Required*: No  
*Type*: [CookieSynchronizationConfiguration](aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CopyAllowed`  <a name="cfn-workspacesweb-usersettings-copyallowed"></a>
Specifies whether the user can copy text from the streaming session to the local device.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Disabled | Enabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomerManagedKey`  <a name="cfn-workspacesweb-usersettings-customermanagedkey"></a>
The customer managed key used to encrypt sensitive information in the user settings.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeepLinkAllowed`  <a name="cfn-workspacesweb-usersettings-deeplinkallowed"></a>
Specifies whether the user can use deep links that open automatically when connecting to a session.  
*Required*: No  
*Type*: String  
*Allowed values*: `Disabled | Enabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DisconnectTimeoutInMinutes`  <a name="cfn-workspacesweb-usersettings-disconnecttimeoutinminutes"></a>
The amount of time that a streaming session remains active after users disconnect.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DownloadAllowed`  <a name="cfn-workspacesweb-usersettings-downloadallowed"></a>
Specifies whether the user can download files from the streaming session to the local device.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Disabled | Enabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IdleDisconnectTimeoutInMinutes`  <a name="cfn-workspacesweb-usersettings-idledisconnecttimeoutinminutes"></a>
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `60`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PasteAllowed`  <a name="cfn-workspacesweb-usersettings-pasteallowed"></a>
Specifies whether the user can paste text from the local device to the streaming session.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Disabled | Enabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PrintAllowed`  <a name="cfn-workspacesweb-usersettings-printallowed"></a>
Specifies whether the user can print to the local device.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Disabled | Enabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-workspacesweb-usersettings-tags"></a>
The tags to add to the user settings resource. A tag is a key-value pair.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-workspacesweb-usersettings-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ToolbarConfiguration`  <a name="cfn-workspacesweb-usersettings-toolbarconfiguration"></a>
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.  
*Required*: No  
*Type*: [ToolbarConfiguration](aws-properties-workspacesweb-usersettings-toolbarconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UploadAllowed`  <a name="cfn-workspacesweb-usersettings-uploadallowed"></a>
Specifies whether the user can upload files from the local device to the streaming session.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Disabled | Enabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WebAuthnAllowed`  <a name="cfn-workspacesweb-usersettings-webauthnallowed"></a>
Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.  
*Required*: No  
*Type*: String  
*Allowed values*: `Disabled | Enabled`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-workspacesweb-usersettings-return-values"></a>

### Ref
<a name="aws-resource-workspacesweb-usersettings-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource's Amazon Resource Name (ARN).

For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-workspacesweb-usersettings-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-workspacesweb-usersettings-return-values-fn--getatt-fn--getatt"></a>

`AssociatedPortalArns`  <a name="AssociatedPortalArns-fn::getatt"></a>
A list of web portal ARNs that this user settings resource is associated with.

`UserSettingsArn`  <a name="UserSettingsArn-fn::getatt"></a>
The ARN of the user settings.

# AWS::WorkSpacesWeb::UserSettings BrandingConfiguration
<a name="aws-properties-workspacesweb-usersettings-brandingconfiguration"></a>

The branding configuration that customizes the appearance of the web portal for end users. This includes a custom logo, favicon, localized strings, color theme, and optionally a wallpaper and terms of service. If you use an empty string as the wallpaper input during an update, it will remove your previously uploaded wallpaper and use the default wallpaper instead.

**Note**  
The `LogoMetadata`, `FaviconMetadata`, and `WallpaperMetadata` properties are read-only and cannot be specified in your template. They are automatically populated by the service after you upload images and can be retrieved using the `Fn::GetAtt` intrinsic function.

## Syntax
<a name="aws-properties-workspacesweb-usersettings-brandingconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspacesweb-usersettings-brandingconfiguration-syntax.json"></a>

```
{
  "[ColorTheme](#cfn-workspacesweb-usersettings-brandingconfiguration-colortheme)" : String,
  "[Favicon](#cfn-workspacesweb-usersettings-brandingconfiguration-favicon)" : String,
  "[FaviconMetadata](#cfn-workspacesweb-usersettings-brandingconfiguration-faviconmetadata)" : ImageMetadata,
  "[LocalizedStrings](#cfn-workspacesweb-usersettings-brandingconfiguration-localizedstrings)" : {Key: Value, ...},
  "[Logo](#cfn-workspacesweb-usersettings-brandingconfiguration-logo)" : String,
  "[LogoMetadata](#cfn-workspacesweb-usersettings-brandingconfiguration-logometadata)" : ImageMetadata,
  "[TermsOfService](#cfn-workspacesweb-usersettings-brandingconfiguration-termsofservice)" : String,
  "[Wallpaper](#cfn-workspacesweb-usersettings-brandingconfiguration-wallpaper)" : String,
  "[WallpaperMetadata](#cfn-workspacesweb-usersettings-brandingconfiguration-wallpapermetadata)" : ImageMetadata
}
```

### YAML
<a name="aws-properties-workspacesweb-usersettings-brandingconfiguration-syntax.yaml"></a>

```
  [ColorTheme](#cfn-workspacesweb-usersettings-brandingconfiguration-colortheme): String
  [Favicon](#cfn-workspacesweb-usersettings-brandingconfiguration-favicon): String
  [FaviconMetadata](#cfn-workspacesweb-usersettings-brandingconfiguration-faviconmetadata): 
    ImageMetadata
  [LocalizedStrings](#cfn-workspacesweb-usersettings-brandingconfiguration-localizedstrings): 
    Key: Value
  [Logo](#cfn-workspacesweb-usersettings-brandingconfiguration-logo): String
  [LogoMetadata](#cfn-workspacesweb-usersettings-brandingconfiguration-logometadata): 
    ImageMetadata
  [TermsOfService](#cfn-workspacesweb-usersettings-brandingconfiguration-termsofservice): String
  [Wallpaper](#cfn-workspacesweb-usersettings-brandingconfiguration-wallpaper): String
  [WallpaperMetadata](#cfn-workspacesweb-usersettings-brandingconfiguration-wallpapermetadata): 
    ImageMetadata
```

## Properties
<a name="aws-properties-workspacesweb-usersettings-brandingconfiguration-properties"></a>

`ColorTheme`  <a name="cfn-workspacesweb-usersettings-brandingconfiguration-colortheme"></a>
The color theme for components on the web portal. Choose `Light` if you upload a dark wallpaper, or `Dark` for a light wallpaper.  
*Required*: No  
*Type*: String  
*Allowed values*: `Light | Dark`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Favicon`  <a name="cfn-workspacesweb-usersettings-brandingconfiguration-favicon"></a>
The favicon image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.  
*Required*: No  
*Type*: String  
*Pattern*: `(^s3://[a-z0-9][a-z0-9\.\-]{1,61}[a-z0-9]/.+$)|(^(?=(.{4})*$)[A-Za-z0-9+/]*={0,2}$)`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FaviconMetadata`  <a name="cfn-workspacesweb-usersettings-brandingconfiguration-faviconmetadata"></a>
Read-only. 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.  
*Required*: No  
*Type*: [ImageMetadata](aws-properties-workspacesweb-usersettings-imagemetadata.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LocalizedStrings`  <a name="cfn-workspacesweb-usersettings-brandingconfiguration-localizedstrings"></a>
A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.  
*Required*: No  
*Type*: Object of [LocalizedBrandingStrings](aws-properties-workspacesweb-usersettings-localizedbrandingstrings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Logo`  <a name="cfn-workspacesweb-usersettings-brandingconfiguration-logo"></a>
The logo image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.  
*Required*: No  
*Type*: String  
*Pattern*: `(^s3://[a-z0-9][a-z0-9\.\-]{1,61}[a-z0-9]/.+$)|(^(?=(.{4})*$)[A-Za-z0-9+/]*={0,2}$)`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LogoMetadata`  <a name="cfn-workspacesweb-usersettings-brandingconfiguration-logometadata"></a>
Read-only. 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.  
*Required*: No  
*Type*: [ImageMetadata](aws-properties-workspacesweb-usersettings-imagemetadata.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TermsOfService`  <a name="cfn-workspacesweb-usersettings-brandingconfiguration-termsofservice"></a>
The terms of service text in Markdown format that users must accept before accessing the portal.  
*Required*: No  
*Type*: String  
*Maximum*: `153600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Wallpaper`  <a name="cfn-workspacesweb-usersettings-brandingconfiguration-wallpaper"></a>
The wallpaper image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG or PNG format. If not provided, a default wallpaper will be used as the background image.  
*Required*: No  
*Type*: String  
*Pattern*: `(^s3://[a-z0-9][a-z0-9\.\-]{1,61}[a-z0-9]/.+$)|(^(?=(.{4})*$)[A-Za-z0-9+/]*={0,2}$)`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WallpaperMetadata`  <a name="cfn-workspacesweb-usersettings-brandingconfiguration-wallpapermetadata"></a>
Read-only. 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.  
*Required*: No  
*Type*: [ImageMetadata](aws-properties-workspacesweb-usersettings-imagemetadata.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpacesWeb::UserSettings CookieSpecification
<a name="aws-properties-workspacesweb-usersettings-cookiespecification"></a>

Specifies a single cookie or set of cookies in an end user's browser.

## Syntax
<a name="aws-properties-workspacesweb-usersettings-cookiespecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspacesweb-usersettings-cookiespecification-syntax.json"></a>

```
{
  "[Domain](#cfn-workspacesweb-usersettings-cookiespecification-domain)" : String,
  "[Name](#cfn-workspacesweb-usersettings-cookiespecification-name)" : String,
  "[Path](#cfn-workspacesweb-usersettings-cookiespecification-path)" : String
}
```

### YAML
<a name="aws-properties-workspacesweb-usersettings-cookiespecification-syntax.yaml"></a>

```
  [Domain](#cfn-workspacesweb-usersettings-cookiespecification-domain): String
  [Name](#cfn-workspacesweb-usersettings-cookiespecification-name): String
  [Path](#cfn-workspacesweb-usersettings-cookiespecification-path): String
```

## Properties
<a name="aws-properties-workspacesweb-usersettings-cookiespecification-properties"></a>

`Domain`  <a name="cfn-workspacesweb-usersettings-cookiespecification-domain"></a>
The domain of the cookie.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(\.?)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$`  
*Minimum*: `0`  
*Maximum*: `253`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-workspacesweb-usersettings-cookiespecification-name"></a>
The name of the cookie.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `4096`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Path`  <a name="cfn-workspacesweb-usersettings-cookiespecification-path"></a>
The path of the cookie.  
*Required*: No  
*Type*: String  
*Pattern*: `^/(\S)*$`  
*Minimum*: `0`  
*Maximum*: `2000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpacesWeb::UserSettings CookieSynchronizationConfiguration
<a name="aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration"></a>

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

## Syntax
<a name="aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration-syntax.json"></a>

```
{
  "[Allowlist](#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration-allowlist)" : [ CookieSpecification, ... ],
  "[Blocklist](#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration-blocklist)" : [ CookieSpecification, ... ]
}
```

### YAML
<a name="aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration-syntax.yaml"></a>

```
  [Allowlist](#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration-allowlist): 
    - CookieSpecification
  [Blocklist](#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration-blocklist): 
    - CookieSpecification
```

## Properties
<a name="aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration-properties"></a>

`Allowlist`  <a name="cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration-allowlist"></a>
The list of cookie specifications that are allowed to be synchronized to the remote browser.  
*Required*: Yes  
*Type*: Array of [CookieSpecification](aws-properties-workspacesweb-usersettings-cookiespecification.md)  
*Minimum*: `0`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Blocklist`  <a name="cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration-blocklist"></a>
The list of cookie specifications that are blocked from being synchronized to the remote browser.  
*Required*: No  
*Type*: Array of [CookieSpecification](aws-properties-workspacesweb-usersettings-cookiespecification.md)  
*Minimum*: `0`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpacesWeb::UserSettings ImageMetadata
<a name="aws-properties-workspacesweb-usersettings-imagemetadata"></a>

Metadata information about an uploaded image file.

## Syntax
<a name="aws-properties-workspacesweb-usersettings-imagemetadata-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspacesweb-usersettings-imagemetadata-syntax.json"></a>

```
{
  "[FileExtension](#cfn-workspacesweb-usersettings-imagemetadata-fileextension)" : String,
  "[LastUploadTimestamp](#cfn-workspacesweb-usersettings-imagemetadata-lastuploadtimestamp)" : String,
  "[MimeType](#cfn-workspacesweb-usersettings-imagemetadata-mimetype)" : String
}
```

### YAML
<a name="aws-properties-workspacesweb-usersettings-imagemetadata-syntax.yaml"></a>

```
  [FileExtension](#cfn-workspacesweb-usersettings-imagemetadata-fileextension): String
  [LastUploadTimestamp](#cfn-workspacesweb-usersettings-imagemetadata-lastuploadtimestamp): String
  [MimeType](#cfn-workspacesweb-usersettings-imagemetadata-mimetype): String
```

## Properties
<a name="aws-properties-workspacesweb-usersettings-imagemetadata-properties"></a>

`FileExtension`  <a name="cfn-workspacesweb-usersettings-imagemetadata-fileextension"></a>
The file extension of the image.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[\s\S]*$`  
*Minimum*: `0`  
*Maximum*: `131072`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LastUploadTimestamp`  <a name="cfn-workspacesweb-usersettings-imagemetadata-lastuploadtimestamp"></a>
The timestamp when the image was last uploaded.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MimeType`  <a name="cfn-workspacesweb-usersettings-imagemetadata-mimetype"></a>
The MIME type of the image.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `image/png | image/jpeg | image/x-icon`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpacesWeb::UserSettings LocalizedBrandingStrings
<a name="aws-properties-workspacesweb-usersettings-localizedbrandingstrings"></a>

Localized text strings for a specific language that customize the web portal.

## Syntax
<a name="aws-properties-workspacesweb-usersettings-localizedbrandingstrings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspacesweb-usersettings-localizedbrandingstrings-syntax.json"></a>

```
{
  "[BrowserTabTitle](#cfn-workspacesweb-usersettings-localizedbrandingstrings-browsertabtitle)" : String,
  "[ContactButtonText](#cfn-workspacesweb-usersettings-localizedbrandingstrings-contactbuttontext)" : String,
  "[ContactLink](#cfn-workspacesweb-usersettings-localizedbrandingstrings-contactlink)" : String,
  "[LoadingText](#cfn-workspacesweb-usersettings-localizedbrandingstrings-loadingtext)" : String,
  "[LoginButtonText](#cfn-workspacesweb-usersettings-localizedbrandingstrings-loginbuttontext)" : String,
  "[LoginDescription](#cfn-workspacesweb-usersettings-localizedbrandingstrings-logindescription)" : String,
  "[LoginTitle](#cfn-workspacesweb-usersettings-localizedbrandingstrings-logintitle)" : String,
  "[WelcomeText](#cfn-workspacesweb-usersettings-localizedbrandingstrings-welcometext)" : String
}
```

### YAML
<a name="aws-properties-workspacesweb-usersettings-localizedbrandingstrings-syntax.yaml"></a>

```
  [BrowserTabTitle](#cfn-workspacesweb-usersettings-localizedbrandingstrings-browsertabtitle): String
  [ContactButtonText](#cfn-workspacesweb-usersettings-localizedbrandingstrings-contactbuttontext): String
  [ContactLink](#cfn-workspacesweb-usersettings-localizedbrandingstrings-contactlink): String
  [LoadingText](#cfn-workspacesweb-usersettings-localizedbrandingstrings-loadingtext): String
  [LoginButtonText](#cfn-workspacesweb-usersettings-localizedbrandingstrings-loginbuttontext): String
  [LoginDescription](#cfn-workspacesweb-usersettings-localizedbrandingstrings-logindescription): String
  [LoginTitle](#cfn-workspacesweb-usersettings-localizedbrandingstrings-logintitle): String
  [WelcomeText](#cfn-workspacesweb-usersettings-localizedbrandingstrings-welcometext): String
```

## Properties
<a name="aws-properties-workspacesweb-usersettings-localizedbrandingstrings-properties"></a>

`BrowserTabTitle`  <a name="cfn-workspacesweb-usersettings-localizedbrandingstrings-browsertabtitle"></a>
The text displayed in the browser tab title.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[^<>&'`~\\]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ContactButtonText`  <a name="cfn-workspacesweb-usersettings-localizedbrandingstrings-contactbuttontext"></a>
The text displayed on the contact button. This field is optional and defaults to "Contact us".  
*Required*: No  
*Type*: String  
*Pattern*: `^[^<>&'`~\\]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ContactLink`  <a name="cfn-workspacesweb-usersettings-localizedbrandingstrings-contactlink"></a>
A contact link URL. The URL must start with `https://` or `mailto:`. If not provided, the contact button will be hidden from the web portal screen.  
*Required*: No  
*Type*: String  
*Pattern*: `^(https?://|mailto:).*`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LoadingText`  <a name="cfn-workspacesweb-usersettings-localizedbrandingstrings-loadingtext"></a>
The text displayed during session loading. This field is optional and defaults to "Loading your session".  
*Required*: No  
*Type*: String  
*Pattern*: `^[^<>&'`~\\]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LoginButtonText`  <a name="cfn-workspacesweb-usersettings-localizedbrandingstrings-loginbuttontext"></a>
The text displayed on the login button. This field is optional and defaults to "Sign In".  
*Required*: No  
*Type*: String  
*Pattern*: `^[^<>&'`~\\]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LoginDescription`  <a name="cfn-workspacesweb-usersettings-localizedbrandingstrings-logindescription"></a>
The description text for the login section. This field is optional and defaults to "Sign in to your session".  
*Required*: No  
*Type*: String  
*Pattern*: `^[^<>&'`~\\]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LoginTitle`  <a name="cfn-workspacesweb-usersettings-localizedbrandingstrings-logintitle"></a>
The title text for the login section. This field is optional and defaults to "Sign In".  
*Required*: No  
*Type*: String  
*Pattern*: `^[^<>&'`~\\]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WelcomeText`  <a name="cfn-workspacesweb-usersettings-localizedbrandingstrings-welcometext"></a>
The welcome text displayed on the sign-in page.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[^<>&'`~\\]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpacesWeb::UserSettings Tag
<a name="aws-properties-workspacesweb-usersettings-tag"></a>

The tag.

## Syntax
<a name="aws-properties-workspacesweb-usersettings-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspacesweb-usersettings-tag-syntax.json"></a>

```
{
  "[Key](#cfn-workspacesweb-usersettings-tag-key)" : String,
  "[Value](#cfn-workspacesweb-usersettings-tag-value)" : String
}
```

### YAML
<a name="aws-properties-workspacesweb-usersettings-tag-syntax.yaml"></a>

```
  [Key](#cfn-workspacesweb-usersettings-tag-key): String
  [Value](#cfn-workspacesweb-usersettings-tag-value): String
```

## Properties
<a name="aws-properties-workspacesweb-usersettings-tag-properties"></a>

`Key`  <a name="cfn-workspacesweb-usersettings-tag-key"></a>
The key of the tag.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-workspacesweb-usersettings-tag-value"></a>
The value of the tag  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpacesWeb::UserSettings ToolbarConfiguration
<a name="aws-properties-workspacesweb-usersettings-toolbarconfiguration"></a>

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.

## Syntax
<a name="aws-properties-workspacesweb-usersettings-toolbarconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-workspacesweb-usersettings-toolbarconfiguration-syntax.json"></a>

```
{
  "[HiddenToolbarItems](#cfn-workspacesweb-usersettings-toolbarconfiguration-hiddentoolbaritems)" : [ String, ... ],
  "[MaxDisplayResolution](#cfn-workspacesweb-usersettings-toolbarconfiguration-maxdisplayresolution)" : String,
  "[ToolbarType](#cfn-workspacesweb-usersettings-toolbarconfiguration-toolbartype)" : String,
  "[VisualMode](#cfn-workspacesweb-usersettings-toolbarconfiguration-visualmode)" : String
}
```

### YAML
<a name="aws-properties-workspacesweb-usersettings-toolbarconfiguration-syntax.yaml"></a>

```
  [HiddenToolbarItems](#cfn-workspacesweb-usersettings-toolbarconfiguration-hiddentoolbaritems): 
    - String
  [MaxDisplayResolution](#cfn-workspacesweb-usersettings-toolbarconfiguration-maxdisplayresolution): String
  [ToolbarType](#cfn-workspacesweb-usersettings-toolbarconfiguration-toolbartype): String
  [VisualMode](#cfn-workspacesweb-usersettings-toolbarconfiguration-visualmode): String
```

## Properties
<a name="aws-properties-workspacesweb-usersettings-toolbarconfiguration-properties"></a>

`HiddenToolbarItems`  <a name="cfn-workspacesweb-usersettings-toolbarconfiguration-hiddentoolbaritems"></a>
The list of toolbar items to be hidden.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxDisplayResolution`  <a name="cfn-workspacesweb-usersettings-toolbarconfiguration-maxdisplayresolution"></a>
The maximum display resolution that is allowed for the session.  
*Required*: No  
*Type*: String  
*Allowed values*: `size4096X2160 | size3840X2160 | size3440X1440 | size2560X1440 | size1920X1080 | size1280X720 | size1024X768 | size800X600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ToolbarType`  <a name="cfn-workspacesweb-usersettings-toolbarconfiguration-toolbartype"></a>
The type of toolbar displayed during the session.  
*Required*: No  
*Type*: String  
*Allowed values*: `Floating | Docked`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VisualMode`  <a name="cfn-workspacesweb-usersettings-toolbarconfiguration-visualmode"></a>
The visual mode of the toolbar.  
*Required*: No  
*Type*: String  
*Allowed values*: `Dark | Light`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)