software.amazon.awscdk.services.quicksight

Interface CfnThemeProps

All Known Implementing Classes:

CfnThemeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:28:59.932Z")
public interface CfnThemeProps

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

Method Detail

getAwsAccountId

java.lang.String getAwsAccountId()

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

getThemeId

java.lang.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

default java.lang.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

default java.lang.Object getConfiguration()

The theme configuration, which contains the theme display properties.

getName

default java.lang.String getName()

A display name for the theme.

getPermissions

default java.lang.Object getPermissions()

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

getTags

default java.util.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

default java.lang.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

static CfnThemeProps.Builder builder()

Returns:

a CfnThemeProps.Builder of CfnThemeProps