software.amazon.awscdk.services.quicksight

Class CfnTheme

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.quicksight.CfnTheme

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:11.810Z")
 @Stability(value=Stable)
public class CfnTheme
extends CfnResource
implements IInspectable

A CloudFormation `AWS::QuickSight::Theme`.

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 QuickSight in the Amazon QuickSight 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")
         .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	Class and Description
static interface	CfnTheme.BorderStyleProperty The display options for tile borders for visuals.
static class	CfnTheme.Builder A fluent builder for CfnTheme.
static interface	CfnTheme.DataColorPaletteProperty The theme colors that are used for data colors in charts.
static interface	CfnTheme.FontProperty Example:
static interface	CfnTheme.GutterStyleProperty The display options for gutter spacing between tiles on a sheet.
static interface	CfnTheme.MarginStyleProperty The display options for margins around the outside edge of sheets.
static interface	CfnTheme.ResourcePermissionProperty Permission for the resource.
static interface	CfnTheme.SheetStyleProperty The theme display options for sheets.
static interface	CfnTheme.ThemeConfigurationProperty The theme configuration.
static interface	CfnTheme.TileLayoutStyleProperty The display options for the layout of tiles on a sheet.
static interface	CfnTheme.TileStyleProperty Display options related to tiles on a sheet.
static interface	CfnTheme.TypographyProperty Example:
static interface	CfnTheme.UIColorPaletteProperty The theme colors that apply to UI and to charts, excluding data colors.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTheme(Construct scope, String id, CfnThemeProps props) Create a new `AWS::QuickSight::Theme`.
protected	CfnTheme(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTheme(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the theme.
String	getAttrCreatedTime() The time the theme was created.
String	getAttrLastUpdatedTime() The time the theme was last updated.
String	getAttrType() Theme type.
String	getAwsAccountId() The ID of the AWS account where you want to store the new theme.
String	getBaseThemeId() The ID of the theme that a custom theme will inherit from.
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration() The theme configuration, which contains the theme display properties.
String	getName() A display name for the theme.
Object	getPermissions() A valid grouping of resource permissions to apply to the new theme.
TagManager	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.
String	getVersionDescription() A description of the first version of the theme that you're creating.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAwsAccountId(String value) The ID of the AWS account where you want to store the new theme.
void	setBaseThemeId(String value) The ID of the theme that a custom theme will inherit from.
void	setConfiguration(CfnTheme.ThemeConfigurationProperty value) The theme configuration, which contains the theme display properties.
void	setConfiguration(IResolvable value) The theme configuration, which contains the theme display properties.
void	setName(String value) A display name for the theme.
void	setPermissions(IResolvable value) A valid grouping of resource permissions to apply to the new theme.
void	setPermissions(List<Object> value) A valid grouping of resource permissions to apply to the new theme.
void	setThemeId(String value) An ID for the theme that you want to create.
void	setVersionDescription(String value) A description of the first version of the theme that you're creating.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTheme

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

CfnTheme

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

CfnTheme

@Stability(value=Stable)
public CfnTheme(@NotNull
                                         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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the theme.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTime()

The time the theme was created.

getAttrLastUpdatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrLastUpdatedTime()

The time the theme was last updated.

getAttrType

@Stability(value=Stable)
 @NotNull
public String getAttrType()

Theme type.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getAwsAccountId

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

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

setAwsAccountId

@Stability(value=Stable)
public void setAwsAccountId(@NotNull
                                                     String value)

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

getThemeId

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

An ID for the theme that you want to create.

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

setThemeId

@Stability(value=Stable)
public void setThemeId(@NotNull
                                                String value)

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

setBaseThemeId

@Stability(value=Stable)
public void setBaseThemeId(@Nullable
                                                    String value)

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
public Object getConfiguration()

The theme configuration, which contains the theme display properties.

setConfiguration

@Stability(value=Stable)
public void setConfiguration(@Nullable
                                                      IResolvable value)

The theme configuration, which contains the theme display properties.

setConfiguration

@Stability(value=Stable)
public void setConfiguration(@Nullable
                                                      CfnTheme.ThemeConfigurationProperty value)

The theme configuration, which contains the theme display properties.

getName

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

A display name for the theme.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

A display name for the theme.

getPermissions

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

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

setPermissions

@Stability(value=Stable)
public void setPermissions(@Nullable
                                                    IResolvable value)

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

setPermissions

@Stability(value=Stable)
public void setPermissions(@Nullable
                                                    List<Object> value)

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

getVersionDescription

@Stability(value=Stable)
 @Nullable
public 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.

setVersionDescription

@Stability(value=Stable)
public void setVersionDescription(@Nullable
                                                           String value)

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.