CfnThemePropsMixin
- class aws_cdk.mixins_preview.aws_quicksight.mixins.CfnThemePropsMixin(props, *, strategy=None)
Bases:
MixinCreates 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 Quick Suite in the Amazon Quick Suite User Guide .
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html
- CloudformationResource:
AWS::QuickSight::Theme
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins cfn_theme_props_mixin = quicksight_mixins.CfnThemePropsMixin(quicksight_mixins.CfnThemeMixinProps( aws_account_id="awsAccountId", base_theme_id="baseThemeId", configuration=quicksight_mixins.CfnThemePropsMixin.ThemeConfigurationProperty( data_color_palette=quicksight_mixins.CfnThemePropsMixin.DataColorPaletteProperty( colors=["colors"], empty_fill_color="emptyFillColor", min_max_gradient=["minMaxGradient"] ), sheet=quicksight_mixins.CfnThemePropsMixin.SheetStyleProperty( tile=quicksight_mixins.CfnThemePropsMixin.TileStyleProperty( border=quicksight_mixins.CfnThemePropsMixin.BorderStyleProperty( show=False ) ), tile_layout=quicksight_mixins.CfnThemePropsMixin.TileLayoutStyleProperty( gutter=quicksight_mixins.CfnThemePropsMixin.GutterStyleProperty( show=False ), margin=quicksight_mixins.CfnThemePropsMixin.MarginStyleProperty( show=False ) ) ), typography=quicksight_mixins.CfnThemePropsMixin.TypographyProperty( font_families=[quicksight_mixins.CfnThemePropsMixin.FontProperty( font_family="fontFamily" )] ), ui_color_palette=quicksight_mixins.CfnThemePropsMixin.UIColorPaletteProperty( accent="accent", accent_foreground="accentForeground", danger="danger", danger_foreground="dangerForeground", dimension="dimension", dimension_foreground="dimensionForeground", measure="measure", measure_foreground="measureForeground", primary_background="primaryBackground", primary_foreground="primaryForeground", secondary_background="secondaryBackground", secondary_foreground="secondaryForeground", success="success", success_foreground="successForeground", warning="warning", warning_foreground="warningForeground" ) ), name="name", permissions=[quicksight_mixins.CfnThemePropsMixin.ResourcePermissionProperty( actions=["actions"], principal="principal", resource="resource" )], tags=[CfnTag( key="key", value="value" )], theme_id="themeId", version_description="versionDescription" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::QuickSight::Theme.- Parameters:
props (
Union[CfnThemeMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['awsAccountId', 'baseThemeId', 'configuration', 'name', 'permissions', 'tags', 'themeId', 'versionDescription']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
BorderStyleProperty
- class CfnThemePropsMixin.BorderStyleProperty(*, show=None)
Bases:
objectThe display options for tile borders for visuals.
- Parameters:
show (
Union[bool,IResolvable,None]) – The option to enable display of borders for visuals.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins border_style_property = quicksight_mixins.CfnThemePropsMixin.BorderStyleProperty( show=False )
Attributes
- show
The option to enable display of borders for visuals.
DataColorPaletteProperty
- class CfnThemePropsMixin.DataColorPaletteProperty(*, colors=None, empty_fill_color=None, min_max_gradient=None)
Bases:
objectThe theme colors that are used for data colors in charts.
The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with
#, for example #37BFF5.- Parameters:
colors (
Optional[Sequence[str]]) – The hexadecimal codes for the colors.empty_fill_color (
Optional[str]) – The hexadecimal code of a color that applies to charts where a lack of data is highlighted.min_max_gradient (
Optional[Sequence[str]]) – The minimum and maximum hexadecimal codes that describe a color gradient.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins data_color_palette_property = quicksight_mixins.CfnThemePropsMixin.DataColorPaletteProperty( colors=["colors"], empty_fill_color="emptyFillColor", min_max_gradient=["minMaxGradient"] )
Attributes
- colors
The hexadecimal codes for the colors.
- empty_fill_color
The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
- min_max_gradient
The minimum and maximum hexadecimal codes that describe a color gradient.
FontProperty
- class CfnThemePropsMixin.FontProperty(*, font_family=None)
Bases:
objectDetermines the font settings.
- Parameters:
font_family (
Optional[str]) – Determines the font family settings.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins font_property = quicksight_mixins.CfnThemePropsMixin.FontProperty( font_family="fontFamily" )
Attributes
- font_family
Determines the font family settings.
GutterStyleProperty
- class CfnThemePropsMixin.GutterStyleProperty(*, show=None)
Bases:
objectThe display options for gutter spacing between tiles on a sheet.
- Parameters:
show (
Union[bool,IResolvable,None]) – This Boolean value controls whether to display a gutter space between sheet tiles.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins gutter_style_property = quicksight_mixins.CfnThemePropsMixin.GutterStyleProperty( show=False )
Attributes
- show
This Boolean value controls whether to display a gutter space between sheet tiles.
MarginStyleProperty
- class CfnThemePropsMixin.MarginStyleProperty(*, show=None)
Bases:
objectThe display options for margins around the outside edge of sheets.
- Parameters:
show (
Union[bool,IResolvable,None]) – This Boolean value controls whether to display sheet margins.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins margin_style_property = quicksight_mixins.CfnThemePropsMixin.MarginStyleProperty( show=False )
Attributes
- show
This Boolean value controls whether to display sheet margins.
ResourcePermissionProperty
- class CfnThemePropsMixin.ResourcePermissionProperty(*, actions=None, principal=None, resource=None)
Bases:
objectPermission for the resource.
- Parameters:
actions (
Optional[Sequence[str]]) – The IAM action to grant or revoke permissions on.principal (
Optional[str]) – The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)resource (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins resource_permission_property = quicksight_mixins.CfnThemePropsMixin.ResourcePermissionProperty( actions=["actions"], principal="principal", resource="resource" )
Attributes
- actions
The IAM action to grant or revoke permissions on.
- principal
.
The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
- See:
- Type:
The Amazon Resource Name (ARN) of the principal. This can be one of the following
SheetStyleProperty
- class CfnThemePropsMixin.SheetStyleProperty(*, tile=None, tile_layout=None)
Bases:
objectThe theme display options for sheets.
- Parameters:
tile (
Union[IResolvable,TileStyleProperty,Dict[str,Any],None]) – The display options for tiles.tile_layout (
Union[IResolvable,TileLayoutStyleProperty,Dict[str,Any],None]) – The layout options for tiles.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins sheet_style_property = quicksight_mixins.CfnThemePropsMixin.SheetStyleProperty( tile=quicksight_mixins.CfnThemePropsMixin.TileStyleProperty( border=quicksight_mixins.CfnThemePropsMixin.BorderStyleProperty( show=False ) ), tile_layout=quicksight_mixins.CfnThemePropsMixin.TileLayoutStyleProperty( gutter=quicksight_mixins.CfnThemePropsMixin.GutterStyleProperty( show=False ), margin=quicksight_mixins.CfnThemePropsMixin.MarginStyleProperty( show=False ) ) )
Attributes
- tile
The display options for tiles.
- tile_layout
The layout options for tiles.
ThemeConfigurationProperty
- class CfnThemePropsMixin.ThemeConfigurationProperty(*, data_color_palette=None, sheet=None, typography=None, ui_color_palette=None)
Bases:
objectThe theme configuration.
This configuration contains all of the display properties for a theme.
- Parameters:
data_color_palette (
Union[IResolvable,DataColorPaletteProperty,Dict[str,Any],None]) – Color properties that apply to chart data colors.sheet (
Union[IResolvable,SheetStyleProperty,Dict[str,Any],None]) – Display options related to sheets.typography (
Union[IResolvable,TypographyProperty,Dict[str,Any],None]) – Determines the typography options.ui_color_palette (
Union[IResolvable,UIColorPaletteProperty,Dict[str,Any],None]) – Color properties that apply to the UI and to charts, excluding the colors that apply to data.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins theme_configuration_property = quicksight_mixins.CfnThemePropsMixin.ThemeConfigurationProperty( data_color_palette=quicksight_mixins.CfnThemePropsMixin.DataColorPaletteProperty( colors=["colors"], empty_fill_color="emptyFillColor", min_max_gradient=["minMaxGradient"] ), sheet=quicksight_mixins.CfnThemePropsMixin.SheetStyleProperty( tile=quicksight_mixins.CfnThemePropsMixin.TileStyleProperty( border=quicksight_mixins.CfnThemePropsMixin.BorderStyleProperty( show=False ) ), tile_layout=quicksight_mixins.CfnThemePropsMixin.TileLayoutStyleProperty( gutter=quicksight_mixins.CfnThemePropsMixin.GutterStyleProperty( show=False ), margin=quicksight_mixins.CfnThemePropsMixin.MarginStyleProperty( show=False ) ) ), typography=quicksight_mixins.CfnThemePropsMixin.TypographyProperty( font_families=[quicksight_mixins.CfnThemePropsMixin.FontProperty( font_family="fontFamily" )] ), ui_color_palette=quicksight_mixins.CfnThemePropsMixin.UIColorPaletteProperty( accent="accent", accent_foreground="accentForeground", danger="danger", danger_foreground="dangerForeground", dimension="dimension", dimension_foreground="dimensionForeground", measure="measure", measure_foreground="measureForeground", primary_background="primaryBackground", primary_foreground="primaryForeground", secondary_background="secondaryBackground", secondary_foreground="secondaryForeground", success="success", success_foreground="successForeground", warning="warning", warning_foreground="warningForeground" ) )
Attributes
- data_color_palette
Color properties that apply to chart data colors.
- sheet
Display options related to sheets.
- typography
Determines the typography options.
- ui_color_palette
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
ThemeErrorProperty
- class CfnThemePropsMixin.ThemeErrorProperty(*, message=None, type=None)
Bases:
objectTheme error.
- Parameters:
message (
Optional[str]) – The error message.type (
Optional[str]) – The type of error.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins theme_error_property = quicksight_mixins.CfnThemePropsMixin.ThemeErrorProperty( message="message", type="type" )
Attributes
- message
The error message.
ThemeVersionProperty
- class CfnThemePropsMixin.ThemeVersionProperty(*, arn=None, base_theme_id=None, configuration=None, created_time=None, description=None, errors=None, status=None, version_number=None)
Bases:
objectA version of a theme.
- Parameters:
arn (
Optional[str]) – The Amazon Resource Name (ARN) of the resource.base_theme_id (
Optional[str]) – The Quick Sight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Quick Sight theme.configuration (
Union[IResolvable,ThemeConfigurationProperty,Dict[str,Any],None]) – The theme configuration, which contains all the theme display properties.created_time (
Optional[str]) – The date and time that this theme version was created.description (
Optional[str]) – The description of the theme.errors (
Union[IResolvable,Sequence[Union[IResolvable,ThemeErrorProperty,Dict[str,Any]]],None]) – Errors associated with the theme.status (
Optional[str]) – The status of the theme version.version_number (
Union[int,float,None]) – The version number of the theme.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins theme_version_property = quicksight_mixins.CfnThemePropsMixin.ThemeVersionProperty( arn="arn", base_theme_id="baseThemeId", configuration=quicksight_mixins.CfnThemePropsMixin.ThemeConfigurationProperty( data_color_palette=quicksight_mixins.CfnThemePropsMixin.DataColorPaletteProperty( colors=["colors"], empty_fill_color="emptyFillColor", min_max_gradient=["minMaxGradient"] ), sheet=quicksight_mixins.CfnThemePropsMixin.SheetStyleProperty( tile=quicksight_mixins.CfnThemePropsMixin.TileStyleProperty( border=quicksight_mixins.CfnThemePropsMixin.BorderStyleProperty( show=False ) ), tile_layout=quicksight_mixins.CfnThemePropsMixin.TileLayoutStyleProperty( gutter=quicksight_mixins.CfnThemePropsMixin.GutterStyleProperty( show=False ), margin=quicksight_mixins.CfnThemePropsMixin.MarginStyleProperty( show=False ) ) ), typography=quicksight_mixins.CfnThemePropsMixin.TypographyProperty( font_families=[quicksight_mixins.CfnThemePropsMixin.FontProperty( font_family="fontFamily" )] ), ui_color_palette=quicksight_mixins.CfnThemePropsMixin.UIColorPaletteProperty( accent="accent", accent_foreground="accentForeground", danger="danger", danger_foreground="dangerForeground", dimension="dimension", dimension_foreground="dimensionForeground", measure="measure", measure_foreground="measureForeground", primary_background="primaryBackground", primary_foreground="primaryForeground", secondary_background="secondaryBackground", secondary_foreground="secondaryForeground", success="success", success_foreground="successForeground", warning="warning", warning_foreground="warningForeground" ) ), created_time="createdTime", description="description", errors=[quicksight_mixins.CfnThemePropsMixin.ThemeErrorProperty( message="message", type="type" )], status="status", version_number=123 )
Attributes
- arn
The Amazon Resource Name (ARN) of the resource.
- base_theme_id
The Quick Sight-defined ID of the theme that a custom theme inherits from.
All themes initially inherit from a default Quick Sight theme.
- configuration
The theme configuration, which contains all the theme display properties.
- created_time
The date and time that this theme version was created.
- description
The description of the theme.
- errors
Errors associated with the theme.
- status
The status of the theme version.
- version_number
The version number of the theme.
TileLayoutStyleProperty
- class CfnThemePropsMixin.TileLayoutStyleProperty(*, gutter=None, margin=None)
Bases:
objectThe display options for the layout of tiles on a sheet.
- Parameters:
gutter (
Union[IResolvable,GutterStyleProperty,Dict[str,Any],None]) – The gutter settings that apply between tiles.margin (
Union[IResolvable,MarginStyleProperty,Dict[str,Any],None]) – The margin settings that apply around the outside edge of sheets.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins tile_layout_style_property = quicksight_mixins.CfnThemePropsMixin.TileLayoutStyleProperty( gutter=quicksight_mixins.CfnThemePropsMixin.GutterStyleProperty( show=False ), margin=quicksight_mixins.CfnThemePropsMixin.MarginStyleProperty( show=False ) )
Attributes
- gutter
The gutter settings that apply between tiles.
- margin
The margin settings that apply around the outside edge of sheets.
TileStyleProperty
- class CfnThemePropsMixin.TileStyleProperty(*, border=None)
Bases:
objectDisplay options related to tiles on a sheet.
- Parameters:
border (
Union[IResolvable,BorderStyleProperty,Dict[str,Any],None]) – The border around a tile.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins tile_style_property = quicksight_mixins.CfnThemePropsMixin.TileStyleProperty( border=quicksight_mixins.CfnThemePropsMixin.BorderStyleProperty( show=False ) )
Attributes
- border
The border around a tile.
TypographyProperty
- class CfnThemePropsMixin.TypographyProperty(*, font_families=None)
Bases:
objectDetermines the typography options.
- Parameters:
font_families (
Union[IResolvable,Sequence[Union[IResolvable,FontProperty,Dict[str,Any]]],None]) – Determines the list of font families.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins typography_property = quicksight_mixins.CfnThemePropsMixin.TypographyProperty( font_families=[quicksight_mixins.CfnThemePropsMixin.FontProperty( font_family="fontFamily" )] )
Attributes
- font_families
Determines the list of font families.
UIColorPaletteProperty
- class CfnThemePropsMixin.UIColorPaletteProperty(*, accent=None, accent_foreground=None, danger=None, danger_foreground=None, dimension=None, dimension_foreground=None, measure=None, measure_foreground=None, primary_background=None, primary_foreground=None, secondary_background=None, secondary_foreground=None, success=None, success_foreground=None, warning=None, warning_foreground=None)
Bases:
objectThe theme colors that apply to UI and to charts, excluding data colors.
The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with
#, for example #37BFF5. For more information, see Using Themes in Amazon Quick Suite in the Amazon Quick Suite User Guide.- Parameters:
accent (
Optional[str]) – This color is that applies to selected states and buttons.accent_foreground (
Optional[str]) – The foreground color that applies to any text or other elements that appear over the accent color.danger (
Optional[str]) – The color that applies to error messages.danger_foreground (
Optional[str]) – The foreground color that applies to any text or other elements that appear over the error color.dimension (
Optional[str]) – The color that applies to the names of fields that are identified as dimensions.dimension_foreground (
Optional[str]) – The foreground color that applies to any text or other elements that appear over the dimension color.measure (
Optional[str]) – The color that applies to the names of fields that are identified as measures.measure_foreground (
Optional[str]) – The foreground color that applies to any text or other elements that appear over the measure color.primary_background (
Optional[str]) – The background color that applies to visuals and other high emphasis UI.primary_foreground (
Optional[str]) – The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.secondary_background (
Optional[str]) – The background color that applies to the sheet background and sheet controls.secondary_foreground (
Optional[str]) – The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.success (
Optional[str]) – The color that applies to success messages, for example the check mark for a successful download.success_foreground (
Optional[str]) – The foreground color that applies to any text or other elements that appear over the success color.warning (
Optional[str]) – This color that applies to warning and informational messages.warning_foreground (
Optional[str]) – The foreground color that applies to any text or other elements that appear over the warning color.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins u_iColor_palette_property = quicksight_mixins.CfnThemePropsMixin.UIColorPaletteProperty( accent="accent", accent_foreground="accentForeground", danger="danger", danger_foreground="dangerForeground", dimension="dimension", dimension_foreground="dimensionForeground", measure="measure", measure_foreground="measureForeground", primary_background="primaryBackground", primary_foreground="primaryForeground", secondary_background="secondaryBackground", secondary_foreground="secondaryForeground", success="success", success_foreground="successForeground", warning="warning", warning_foreground="warningForeground" )
Attributes
- accent
This color is that applies to selected states and buttons.
- accent_foreground
The foreground color that applies to any text or other elements that appear over the accent color.
- danger
The color that applies to error messages.
- danger_foreground
The foreground color that applies to any text or other elements that appear over the error color.
- dimension
The color that applies to the names of fields that are identified as dimensions.
- dimension_foreground
The foreground color that applies to any text or other elements that appear over the dimension color.
- measure
The color that applies to the names of fields that are identified as measures.
- measure_foreground
The foreground color that applies to any text or other elements that appear over the measure color.
- primary_background
The background color that applies to visuals and other high emphasis UI.
- primary_foreground
The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.
- secondary_background
The background color that applies to the sheet background and sheet controls.
- secondary_foreground
The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
- success
The color that applies to success messages, for example the check mark for a successful download.
- success_foreground
The foreground color that applies to any text or other elements that appear over the success color.
- warning
This color that applies to warning and informational messages.
- warning_foreground
The foreground color that applies to any text or other elements that appear over the warning color.