Package software.amazon.awscdk.cfnpropertymixins.services.workspacesweb

Class CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.workspacesweb.CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserSettingsPropsMixin.BrandingConfigurationProperty>

Enclosing interface:

CfnUserSettingsPropsMixin.BrandingConfigurationProperty

@Stability(Stable)
public static final class CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserSettingsPropsMixin.BrandingConfigurationProperty>

A builder for CfnUserSettingsPropsMixin.BrandingConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnUserSettingsPropsMixin.BrandingConfigurationProperty	build()	Builds the configured instance.
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	colorTheme(String colorTheme)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getColorTheme()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	favicon(String favicon)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getFavicon()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	faviconMetadata(CfnUserSettingsPropsMixin.ImageMetadataProperty faviconMetadata)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getFaviconMetadata()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	faviconMetadata(IResolvable faviconMetadata)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getFaviconMetadata()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	localizedStrings(Map<String,? extends Object> localizedStrings)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getLocalizedStrings()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	localizedStrings(IResolvable localizedStrings)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getLocalizedStrings()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	logo(String logo)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getLogo()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	logoMetadata(CfnUserSettingsPropsMixin.ImageMetadataProperty logoMetadata)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getLogoMetadata()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	logoMetadata(IResolvable logoMetadata)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getLogoMetadata()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	termsOfService(String termsOfService)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getTermsOfService()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	wallpaper(String wallpaper)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getWallpaper()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	wallpaperMetadata(CfnUserSettingsPropsMixin.ImageMetadataProperty wallpaperMetadata)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getWallpaperMetadata()
CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder	wallpaperMetadata(IResolvable wallpaperMetadata)	Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getWallpaperMetadata()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

colorTheme

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder colorTheme(String colorTheme)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getColorTheme()

Parameters:

colorTheme - The color theme for components on the web portal. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.

Returns:

this

favicon

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder favicon(String favicon)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getFavicon()

Parameters:

favicon - 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.

Returns:

this

faviconMetadata

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder faviconMetadata(IResolvable faviconMetadata)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getFaviconMetadata()

Parameters:

faviconMetadata - 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:

this

faviconMetadata

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder faviconMetadata(CfnUserSettingsPropsMixin.ImageMetadataProperty faviconMetadata)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getFaviconMetadata()

Parameters:

faviconMetadata - 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:

this

localizedStrings

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder localizedStrings(IResolvable localizedStrings)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getLocalizedStrings()

Parameters:

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

Returns:

this

localizedStrings

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder localizedStrings(Map<String,? extends Object> localizedStrings)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getLocalizedStrings()

Parameters:

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

Returns:

this

logo

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder logo(String logo)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getLogo()

Parameters:

logo - 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.

Returns:

this

logoMetadata

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder logoMetadata(IResolvable logoMetadata)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getLogoMetadata()

Parameters:

logoMetadata - 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:

this

logoMetadata

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder logoMetadata(CfnUserSettingsPropsMixin.ImageMetadataProperty logoMetadata)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getLogoMetadata()

Parameters:

logoMetadata - 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:

this

termsOfService

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder termsOfService(String termsOfService)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getTermsOfService()

Parameters:

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

Returns:

this

wallpaper

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder wallpaper(String wallpaper)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getWallpaper()

Parameters:

wallpaper - 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.

Returns:

this

wallpaperMetadata

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder wallpaperMetadata(IResolvable wallpaperMetadata)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getWallpaperMetadata()

Parameters:

wallpaperMetadata - 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:

this

wallpaperMetadata

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty.Builder wallpaperMetadata(CfnUserSettingsPropsMixin.ImageMetadataProperty wallpaperMetadata)

Sets the value of CfnUserSettingsPropsMixin.BrandingConfigurationProperty.getWallpaperMetadata()

Parameters:

wallpaperMetadata - 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:

this

build

@Stability(Stable)
public CfnUserSettingsPropsMixin.BrandingConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserSettingsPropsMixin.BrandingConfigurationProperty>

Returns:

a new instance of CfnUserSettingsPropsMixin.BrandingConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided