Package software.amazon.awscdk.services.quicksight

Class CfnTheme

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnTheme
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IThemeRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:28.304Z") @Stability(Stable) public class CfnTheme extends CfnResource implements IInspectable, IThemeRef, ITaggable
Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Suite in the Amazon Quick Suite User Guide .

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.*;
 CfnTheme cfnTheme = CfnTheme.Builder.create(this, "MyCfnTheme")
         .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")
         .themeId("themeId")
         // the properties below are optional
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 // the properties below are optional
                 .resource("resource")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .versionDescription("versionDescription")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTheme

      protected CfnTheme(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTheme

      protected CfnTheme(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTheme

      @Stability(Stable) public CfnTheme(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnThemeProps props)
      Create a new AWS::QuickSight::Theme.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForTheme

      @Stability(Stable) @NotNull public static String arnForTheme(@NotNull IThemeRef resource)
      Parameters:
      resource - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the theme.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The time the theme was created.

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      The time the theme was last updated.

    • getAttrType

      @Stability(Stable) @NotNull public String getAttrType()
      Theme type.

    • getAttrVersion

      @Stability(Stable) @NotNull public IResolvable getAttrVersion()

      A version of a theme.

      .

    • getAttrVersionArn

      @Stability(Stable) @NotNull public String getAttrVersionArn()

    • getAttrVersionBaseThemeId

      @Stability(Stable) @NotNull public String getAttrVersionBaseThemeId()

    • getAttrVersionConfiguration

      @Stability(Stable) @NotNull public IResolvable getAttrVersionConfiguration()

    • getAttrVersionConfigurationDataColorPalette

      @Stability(Stable) @NotNull public IResolvable getAttrVersionConfigurationDataColorPalette()

    • getAttrVersionConfigurationSheet

      @Stability(Stable) @NotNull public IResolvable getAttrVersionConfigurationSheet()

    • getAttrVersionConfigurationTypography

      @Stability(Stable) @NotNull public IResolvable getAttrVersionConfigurationTypography()

    • getAttrVersionConfigurationUiColorPalette

      @Stability(Stable) @NotNull public IResolvable getAttrVersionConfigurationUiColorPalette()

    • getAttrVersionCreatedTime

      @Stability(Stable) @NotNull public String getAttrVersionCreatedTime()

    • getAttrVersionDescription

      @Stability(Stable) @NotNull public String getAttrVersionDescription()

    • getAttrVersionErrors

      @Stability(Stable) @NotNull public IResolvable getAttrVersionErrors()

    • getAttrVersionStatus

      @Stability(Stable) @NotNull public String getAttrVersionStatus()

    • getAttrVersionVersionNumber

      @Stability(Stable) @NotNull public IResolvable getAttrVersionVersionNumber()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getThemeRef

      @Stability(Stable) @NotNull public ThemeReference getThemeRef()
      A reference to a Theme resource.
      Specified by:
      getThemeRef in interface IThemeRef

    • getAwsAccountId

      @Stability(Stable) @NotNull public String getAwsAccountId()
      The ID of the AWS account where you want to store the new theme.

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@NotNull String value)
      The ID of the AWS account where you want to store the new theme.

    • getBaseThemeId

      @Stability(Stable) @NotNull public String getBaseThemeId()
      The ID of the theme that a custom theme will inherit from.

    • setBaseThemeId

      @Stability(Stable) public void setBaseThemeId(@NotNull String value)
      The ID of the theme that a custom theme will inherit from.

    • getConfiguration

      @Stability(Stable) @NotNull public Object getConfiguration()
      The theme configuration, which contains the theme display properties.

      Returns union: either IResolvable or CfnTheme.ThemeConfigurationProperty

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull IResolvable value)
      The theme configuration, which contains the theme display properties.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull CfnTheme.ThemeConfigurationProperty value)
      The theme configuration, which contains the theme display properties.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A display name for the theme.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A display name for the theme.

    • getThemeId

      @Stability(Stable) @NotNull public String getThemeId()
      An ID for the theme that you want to create.

    • setThemeId

      @Stability(Stable) public void setThemeId(@NotNull String value)
      An ID for the theme that you want to create.

    • getPermissions

      @Stability(Stable) @Nullable public Object getPermissions()
      A valid grouping of resource permissions to apply to the new theme.

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

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable IResolvable value)
      A valid grouping of resource permissions to apply to the new theme.

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<Object> value)
      A valid grouping of resource permissions to apply to the new theme.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

    • getVersionDescription

      @Stability(Stable) @Nullable public String getVersionDescription()
      A description of the first version of the theme that you're creating.

    • setVersionDescription

      @Stability(Stable) public void setVersionDescription(@Nullable String value)
      A description of the first version of the theme that you're creating.