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

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()
default String	getFavicon()
default Object	getFaviconMetadata()	Returns union: either IResolvable or CfnUserSettings.ImageMetadataProperty
default Object	getLocalizedStrings()	Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnUserSettings.LocalizedBrandingStringsProperty>
default String	getLogo()
default Object	getLogoMetadata()	Returns union: either IResolvable or CfnUserSettings.ImageMetadataProperty
default String	getTermsOfService()
default String	getWallpaper()
default Object	getWallpaperMetadata()	Returns union: either IResolvable or CfnUserSettings.ImageMetadataProperty

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColorTheme

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

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()

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()

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()

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()

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()

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()

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()

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()

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