Interface CfnThemeProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnThemeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-06T14:43:25.592Z")
@Stability(Stable)
public interface CfnThemeProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnTheme
.
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.*; CfnThemeProps cfnThemeProps = CfnThemeProps.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") .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:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnThemeProps
static final class
An implementation forCfnThemeProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnThemeProps.Builder
builder()
The ID of the AWS account where you want to store the new theme.The ID of the theme that a custom theme will inherit from.The theme configuration, which contains the theme display properties.getName()
A display name for the theme.default Object
A valid grouping of resource permissions to apply to the new theme.getTags()
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.An ID for the theme that you want to create.default String
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
The ID of the AWS account where you want to store the new theme.- See Also:
-
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.- See Also:
-
getConfiguration
The theme configuration, which contains the theme display properties.- See Also:
-
getName
A display name for the theme.- See Also:
-
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:
-
getPermissions
A valid grouping of resource permissions to apply to the new theme.- See Also:
-
getTags
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.- See Also:
-
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 theVersionDescription
field.- See Also:
-
builder
- Returns:
- a
CfnThemeProps.Builder
ofCfnThemeProps
-