interface CfnThemeProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnThemeProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnThemeProps |
![]() | software.amazon.awscdk.services.quicksight.CfnThemeProps |
![]() | aws_cdk.aws_quicksight.CfnThemeProps |
![]() | aws-cdk-lib » aws_quicksight » CfnThemeProps |
Properties for defining a CfnTheme
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const cfnThemeProps: quicksight.CfnThemeProps = {
awsAccountId: 'awsAccountId',
baseThemeId: 'baseThemeId',
configuration: {
dataColorPalette: {
colors: ['colors'],
emptyFillColor: 'emptyFillColor',
minMaxGradient: ['minMaxGradient'],
},
sheet: {
tile: {
border: {
show: false,
},
},
tileLayout: {
gutter: {
show: false,
},
margin: {
show: false,
},
},
},
typography: {
fontFamilies: [{
fontFamily: 'fontFamily',
}],
},
uiColorPalette: {
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',
},
},
name: 'name',
themeId: 'themeId',
// the properties below are optional
permissions: [{
actions: ['actions'],
principal: 'principal',
// the properties below are optional
resource: 'resource',
}],
tags: [{
key: 'key',
value: 'value',
}],
versionDescription: 'versionDescription',
};
Properties
Name | Type | Description |
---|---|---|
aws | string | The ID of the AWS account where you want to store the new theme. |
base | string | The ID of the theme that a custom theme will inherit from. |
configuration | IResolvable | Theme | The theme configuration, which contains the theme display properties. |
name | string | A display name for the theme. |
theme | string | An ID for the theme that you want to create. |
permissions? | IResolvable | IResolvable | Resource [] | A valid grouping of resource permissions to apply to the new theme. |
tags? | Cfn [] | A map of the key-value pairs for the resource tag or tags that you want to add to the resource. |
version | string | A description of the first version of the theme that you're creating. |
awsAccountId
Type:
string
The ID of the AWS account where you want to store the new theme.
baseThemeId
Type:
string
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.
configuration
Type:
IResolvable
|
Theme
The theme configuration, which contains the theme display properties.
name
Type:
string
A display name for the theme.
themeId
Type:
string
An ID for the theme that you want to create.
The theme ID is unique per AWS Region in each AWS account.
permissions?
Type:
IResolvable
|
IResolvable
|
Resource
[]
(optional)
A valid grouping of resource permissions to apply to the new theme.
tags?
Type:
Cfn
[]
(optional)
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
versionDescription?
Type:
string
(optional)
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.