Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnThemeMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnThemeMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.218Z")
@Stability(Stable)
public interface CfnThemeMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnThemePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.quicksight.*;
 CfnThemeMixinProps cfnThemeMixinProps = CfnThemeMixinProps.builder()
         .awsAccountId("awsAccountId")
         .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")
                 .resource("resource")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .themeId("themeId")
         .versionDescription("versionDescription")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnThemeMixinProps.Builder	builder()
default 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.
default 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 Details

getAwsAccountId

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-awsaccountid

getBaseThemeId

@Stability(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 Quick Sight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-basethemeid

getConfiguration

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

The theme configuration, which contains the theme display properties.

Returns union: either IResolvable or CfnThemePropsMixin.ThemeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-configuration

getName

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

A display name for the theme.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-name

getPermissions

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

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnThemePropsMixin.ResourcePermissionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-permissions

getTags

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-tags

getThemeId

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

An ID for the theme that you want to create.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-themeid

getVersionDescription

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-versiondescription

builder

@Stability(Stable)
static CfnThemeMixinProps.Builder builder()

Returns:

a CfnThemeMixinProps.Builder of CfnThemeMixinProps