Package software.amazon.awscdk.services.workspacesweb

Interface CfnUserSettings.BrandingConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserSettings.BrandingConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnUserSettings

@Stability(Stable)
public static interface CfnUserSettings.BrandingConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.workspacesweb.*;
 BrandingConfigurationProperty brandingConfigurationProperty = BrandingConfigurationProperty.builder()
         .colorTheme("colorTheme")
         .favicon("favicon")
         .faviconMetadata(ImageMetadataProperty.builder()
                 .fileExtension("fileExtension")
                 .lastUploadTimestamp("lastUploadTimestamp")
                 .mimeType("mimeType")
                 .build())
         .localizedStrings(Map.of(
                 "localizedStringsKey", LocalizedBrandingStringsProperty.builder()
                         .browserTabTitle("browserTabTitle")
                         .welcomeText("welcomeText")
                         // the properties below are optional
                         .contactButtonText("contactButtonText")
                         .contactLink("contactLink")
                         .loadingText("loadingText")
                         .loginButtonText("loginButtonText")
                         .loginDescription("loginDescription")
                         .loginTitle("loginTitle")
                         .build()))
         .logo("logo")
         .logoMetadata(ImageMetadataProperty.builder()
                 .fileExtension("fileExtension")
                 .lastUploadTimestamp("lastUploadTimestamp")
                 .mimeType("mimeType")
                 .build())
         .termsOfService("termsOfService")
         .wallpaper("wallpaper")
         .wallpaperMetadata(ImageMetadataProperty.builder()
                 .fileExtension("fileExtension")
                 .lastUploadTimestamp("lastUploadTimestamp")
                 .mimeType("mimeType")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserSettings.BrandingConfigurationProperty.Builder	A builder for CfnUserSettings.BrandingConfigurationProperty
static final class	CfnUserSettings.BrandingConfigurationProperty.Jsii$Proxy	An implementation for CfnUserSettings.BrandingConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserSettings.BrandingConfigurationProperty.Builder	builder()
default String	getColorTheme()	The color theme for components on the web portal.
default String	getFavicon()	The favicon image for the portal.
default Object	getFaviconMetadata()	Read-only.
default Object	getLocalizedStrings()	A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.
default String	getLogo()	The logo image for the portal.
default Object	getLogoMetadata()	Read-only.
default String	getTermsOfService()	The terms of service text in Markdown format that users must accept before accessing the portal.
default String	getWallpaper()	The wallpaper image for the portal.
default Object	getWallpaperMetadata()	Read-only.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColorTheme

@Stability(Stable)
@Nullable
default String getColorTheme()

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

getFavicon

@Stability(Stable)
@Nullable
default String getFavicon()

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

getFaviconMetadata

@Stability(Stable)
@Nullable
default Object getFaviconMetadata()

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.

Returns union: either IResolvable or CfnUserSettings.ImageMetadataProperty

See Also:

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

getLocalizedStrings

@Stability(Stable)
@Nullable
default Object getLocalizedStrings()

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

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnUserSettings.LocalizedBrandingStringsProperty>

See Also:

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

getLogo

@Stability(Stable)
@Nullable
default String getLogo()

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

getLogoMetadata

@Stability(Stable)
@Nullable
default Object getLogoMetadata()

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.

Returns union: either IResolvable or CfnUserSettings.ImageMetadataProperty

See Also:

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

getTermsOfService

@Stability(Stable)
@Nullable
default String getTermsOfService()

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

getWallpaper

@Stability(Stable)
@Nullable
default String getWallpaper()

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

getWallpaperMetadata

@Stability(Stable)
@Nullable
default Object getWallpaperMetadata()

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.

Returns union: either IResolvable or CfnUserSettings.ImageMetadataProperty

See Also:

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

builder

@Stability(Stable)
static CfnUserSettings.BrandingConfigurationProperty.Builder builder()

Returns:

a CfnUserSettings.BrandingConfigurationProperty.Builder of CfnUserSettings.BrandingConfigurationProperty