interface BrandingConfigurationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.WorkSpacesWeb.Mixins.CfnUserSettingsPropsMixin.BrandingConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsworkspacesweb/mixins#CfnUserSettingsPropsMixin_BrandingConfigurationProperty
Java	software.amazon.awscdk.mixins.preview.services.workspacesweb.mixins.CfnUserSettingsPropsMixin.BrandingConfigurationProperty
Python	aws_cdk.mixins_preview.aws_workspacesweb.mixins.CfnUserSettingsPropsMixin.BrandingConfigurationProperty
TypeScript	@aws-cdk/mixins-preview » aws_workspacesweb » mixins » CfnUserSettingsPropsMixin » BrandingConfigurationProperty

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.

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as workspacesweb_mixins } from '@aws-cdk/mixins-preview/aws-workspacesweb';
const brandingConfigurationProperty: workspacesweb_mixins.CfnUserSettingsPropsMixin.BrandingConfigurationProperty = {
  colorTheme: 'colorTheme',
  favicon: 'favicon',
  faviconMetadata: {
    fileExtension: 'fileExtension',
    lastUploadTimestamp: 'lastUploadTimestamp',
    mimeType: 'mimeType',
  },
  localizedStrings: {
    localizedStringsKey: {
      browserTabTitle: 'browserTabTitle',
      contactButtonText: 'contactButtonText',
      contactLink: 'contactLink',
      loadingText: 'loadingText',
      loginButtonText: 'loginButtonText',
      loginDescription: 'loginDescription',
      loginTitle: 'loginTitle',
      welcomeText: 'welcomeText',
    },
  },
  logo: 'logo',
  logoMetadata: {
    fileExtension: 'fileExtension',
    lastUploadTimestamp: 'lastUploadTimestamp',
    mimeType: 'mimeType',
  },
  termsOfService: 'termsOfService',
  wallpaper: 'wallpaper',
  wallpaperMetadata: {
    fileExtension: 'fileExtension',
    lastUploadTimestamp: 'lastUploadTimestamp',
    mimeType: 'mimeType',
  },
};

Properties

Name	Type	Description
colorTheme?	string	The color theme for components on the web portal.
favicon?	string	The favicon image for the portal.
faviconMetadata?	IResolvable | ImageMetadataProperty	Read-only.
localizedStrings?	IResolvable | { [string]: IResolvable | LocalizedBrandingStringsProperty }	A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.
logo?	string	The logo image for the portal.
logoMetadata?	IResolvable | ImageMetadataProperty	Read-only.
termsOfService?	string	The terms of service text in Markdown format that users must accept before accessing the portal.
wallpaper?	string	The wallpaper image for the portal.
wallpaperMetadata?	IResolvable | ImageMetadataProperty	Read-only.

---

colorTheme?

Type: string (optional)

The color theme for components on the web portal.

Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.

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

---

favicon?

Type: string (optional)

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.

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

---

faviconMetadata?

Type: IResolvable | ImageMetadataProperty (optional)

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.

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

---

localizedStrings?

Type: IResolvable | { [string]: IResolvable | LocalizedBrandingStringsProperty } (optional)

A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.

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

---

logo?

Type: string (optional)

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.

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

---

logoMetadata?

Type: IResolvable | ImageMetadataProperty (optional)

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.

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

---

termsOfService?

Type: string (optional)

The terms of service text in Markdown format that users must accept before accessing the portal.

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

---

wallpaper?

Type: string (optional)

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.

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

---

wallpaperMetadata?

Type: IResolvable | ImageMetadataProperty (optional)

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.

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