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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.533Z")
 @Stability(value=Stable)
public class CfnTheme
extends CfnResource
implements IInspectable

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

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 Example:
static class	CfnTheme.Builder A fluent builder for CfnTheme.
static interface	CfnTheme.DataColorPaletteProperty Example:
static interface	CfnTheme.FontProperty Example:
static interface	CfnTheme.GutterStyleProperty Example:
static interface	CfnTheme.MarginStyleProperty Example:
static interface	CfnTheme.ResourcePermissionProperty Example:
static interface	CfnTheme.SheetStyleProperty Example:
static interface	CfnTheme.ThemeConfigurationProperty Example:
static interface	CfnTheme.TileLayoutStyleProperty Example:
static interface	CfnTheme.TileStyleProperty Example:
static interface	CfnTheme.TypographyProperty Example:
static interface	CfnTheme.UIColorPaletteProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.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(software.constructs.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()
String	getAttrCreatedTime()
String	getAttrLastUpdatedTime()
String	getAttrType()
String	getAwsAccountId() `AWS::QuickSight::Theme.AwsAccountId`.
String	getBaseThemeId() `AWS::QuickSight::Theme.BaseThemeId`.
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration() `AWS::QuickSight::Theme.Configuration`.
String	getName() `AWS::QuickSight::Theme.Name`.
Object	getPermissions() `AWS::QuickSight::Theme.Permissions`.
TagManager	getTags() `AWS::QuickSight::Theme.Tags`.
String	getThemeId() `AWS::QuickSight::Theme.ThemeId`.
String	getVersionDescription() `AWS::QuickSight::Theme.VersionDescription`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAwsAccountId(String value) `AWS::QuickSight::Theme.AwsAccountId`.
void	setBaseThemeId(String value) `AWS::QuickSight::Theme.BaseThemeId`.
void	setConfiguration(CfnTheme.ThemeConfigurationProperty value) `AWS::QuickSight::Theme.Configuration`.
void	setConfiguration(IResolvable value) `AWS::QuickSight::Theme.Configuration`.
void	setName(String value) `AWS::QuickSight::Theme.Name`.
void	setPermissions(IResolvable value) `AWS::QuickSight::Theme.Permissions`.
void	setPermissions(List<Object> value) `AWS::QuickSight::Theme.Permissions`.
void	setThemeId(String value) `AWS::QuickSight::Theme.ThemeId`.
void	setVersionDescription(String value) `AWS::QuickSight::Theme.VersionDescription`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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
                                         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 - - 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()

getAttrCreatedTime

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

getAttrLastUpdatedTime

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

getAttrType

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

getAwsAccountId

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

`AWS::QuickSight::Theme.AwsAccountId`.

setAwsAccountId

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

`AWS::QuickSight::Theme.AwsAccountId`.

getBaseThemeId

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

`AWS::QuickSight::Theme.BaseThemeId`.

setBaseThemeId

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

`AWS::QuickSight::Theme.BaseThemeId`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getConfiguration

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

`AWS::QuickSight::Theme.Configuration`.

setConfiguration

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

`AWS::QuickSight::Theme.Configuration`.

setConfiguration

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

`AWS::QuickSight::Theme.Configuration`.

getName

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

`AWS::QuickSight::Theme.Name`.

setName

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

`AWS::QuickSight::Theme.Name`.

getPermissions

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

`AWS::QuickSight::Theme.Permissions`.

setPermissions

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

`AWS::QuickSight::Theme.Permissions`.

setPermissions

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

`AWS::QuickSight::Theme.Permissions`.

getTags

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

`AWS::QuickSight::Theme.Tags`.

getThemeId

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

`AWS::QuickSight::Theme.ThemeId`.

setThemeId

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

`AWS::QuickSight::Theme.ThemeId`.

getVersionDescription

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

`AWS::QuickSight::Theme.VersionDescription`.

setVersionDescription

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

`AWS::QuickSight::Theme.VersionDescription`.