@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:52.461Z") public class CfnTheme extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnTheme(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the theme.
|
java.lang.String |
getAttrCreatedTime()
The time the theme was created.
|
java.lang.String |
getAttrLastUpdatedTime()
The time the theme was last updated.
|
java.lang.String |
getAttrType()
Theme type.
|
java.lang.String |
getAwsAccountId()
The ID of the AWS account where you want to store the new theme.
|
java.lang.String |
getBaseThemeId()
The ID of the theme that a custom theme will inherit from.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getConfiguration()
The theme configuration, which contains the theme display properties.
|
java.lang.String |
getName()
A display name for the theme.
|
java.lang.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.
|
java.lang.String |
getThemeId()
An ID for the theme that you want to create.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAwsAccountId(java.lang.String value)
The ID of the AWS account where you want to store the new theme.
|
void |
setBaseThemeId(java.lang.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(java.lang.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(java.util.List<java.lang.Object> value)
A valid grouping of resource permissions to apply to the new theme.
|
void |
setThemeId(java.lang.String value)
An ID for the theme that you want to create.
|
void |
setVersionDescription(java.lang.String value)
A description of the first version of the theme that you're creating.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnTheme(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnTheme(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnTheme(Construct scope, java.lang.String id, CfnThemeProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrCreatedTime()
public java.lang.String getAttrLastUpdatedTime()
public java.lang.String getAttrType()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getAwsAccountId()
public void setAwsAccountId(java.lang.String value)
public java.lang.String getThemeId()
The theme ID is unique per AWS Region in each AWS account.
public void setThemeId(java.lang.String value)
The theme ID is unique per AWS Region in each AWS account.
public java.lang.String getBaseThemeId()
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.
public void setBaseThemeId(java.lang.String value)
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.
public java.lang.Object getConfiguration()
public void setConfiguration(IResolvable value)
public void setConfiguration(CfnTheme.ThemeConfigurationProperty value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getPermissions()
public void setPermissions(IResolvable value)
public void setPermissions(java.util.List<java.lang.Object> value)
public java.lang.String getVersionDescription()
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.
public void setVersionDescription(java.lang.String value)
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.