software.amazon.awscdk.services.quicksight

Interface CfnThemeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnThemeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:11.817Z")
 @Stability(value=Stable)
public interface CfnThemeProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnTheme`.

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.quicksight.*;
 CfnThemeProps cfnThemeProps = CfnThemeProps.builder()
         .awsAccountId("awsAccountId")
         .themeId("themeId")
         // the properties below are optional
         .baseThemeId("baseThemeId")
         .configuration(ThemeConfigurationProperty.builder()
                 .dataColorPalette(DataColorPaletteProperty.builder()
                         .colors(List.of("colors"))
                         .emptyFillColor("emptyFillColor")
                         .minMaxGradient(List.of("minMaxGradient"))
                         .build())
                 .sheet(SheetStyleProperty.builder()
                         .tile(TileStyleProperty.builder()
                                 .border(BorderStyleProperty.builder()
                                         .show(false)
                                         .build())
                                 .build())
                         .tileLayout(TileLayoutStyleProperty.builder()
                                 .gutter(GutterStyleProperty.builder()
                                         .show(false)
                                         .build())
                                 .margin(MarginStyleProperty.builder()
                                         .show(false)
                                         .build())
                                 .build())
                         .build())
                 .typography(TypographyProperty.builder()
                         .fontFamilies(List.of(FontProperty.builder()
                                 .fontFamily("fontFamily")
                                 .build()))
                         .build())
                 .uiColorPalette(UIColorPaletteProperty.builder()
                         .accent("accent")
                         .accentForeground("accentForeground")
                         .danger("danger")
                         .dangerForeground("dangerForeground")
                         .dimension("dimension")
                         .dimensionForeground("dimensionForeground")
                         .measure("measure")
                         .measureForeground("measureForeground")
                         .primaryBackground("primaryBackground")
                         .primaryForeground("primaryForeground")
                         .secondaryBackground("secondaryBackground")
                         .secondaryForeground("secondaryForeground")
                         .success("success")
                         .successForeground("successForeground")
                         .warning("warning")
                         .warningForeground("warningForeground")
                         .build())
                 .build())
         .name("name")
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .versionDescription("versionDescription")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnThemeProps.Builder	builder()
String	getAwsAccountId() The ID of the AWS account where you want to store the new theme.
default String	getBaseThemeId() The ID of the theme that a custom theme will inherit from.
default Object	getConfiguration() The theme configuration, which contains the theme display properties.
default String	getName() A display name for the theme.
default Object	getPermissions() A valid grouping of resource permissions to apply to the new theme.
default List<CfnTag>	getTags() A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
String	getThemeId() An ID for the theme that you want to create.
default String	getVersionDescription() A description of the first version of the theme that you're creating.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAwsAccountId

@Stability(value=Stable)
 @NotNull
String getAwsAccountId()

The ID of the AWS account where you want to store the new theme.

getThemeId

@Stability(value=Stable)
 @NotNull
String getThemeId()

An ID for the theme that you want to create.

The theme ID is unique per AWS Region in each AWS account.

getBaseThemeId

@Stability(value=Stable)
 @Nullable
default String getBaseThemeId()

The ID of the theme that a custom theme will inherit from.

All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

getConfiguration

@Stability(value=Stable)
 @Nullable
default Object getConfiguration()

The theme configuration, which contains the theme display properties.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

A display name for the theme.

getPermissions

@Stability(value=Stable)
 @Nullable
default Object getPermissions()

A valid grouping of resource permissions to apply to the new theme.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

getVersionDescription

@Stability(value=Stable)
 @Nullable
default String getVersionDescription()

A description of the first version of the theme that you're creating.

Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

builder

@Stability(value=Stable)
static CfnThemeProps.Builder builder()

Returns:

a CfnThemeProps.Builder of CfnThemeProps