CfnTheme

class aws_cdk.aws_quicksight.CfnTheme(scope, id, *, aws_account_id, theme_id, base_theme_id=None, configuration=None, name=None, permissions=None, tags=None, version_description=None)

Bases: CfnResource

A CloudFormation AWS::QuickSight::Theme.

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 .

CloudformationResource

AWS::QuickSight::Theme

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html

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 import aws_quicksight as quicksight

cfn_theme = quicksight.CfnTheme(self, "MyCfnTheme",
    aws_account_id="awsAccountId",
    theme_id="themeId",

    # the properties below are optional
    base_theme_id="baseThemeId",
    configuration=quicksight.CfnTheme.ThemeConfigurationProperty(
        data_color_palette=quicksight.CfnTheme.DataColorPaletteProperty(
            colors=["colors"],
            empty_fill_color="emptyFillColor",
            min_max_gradient=["minMaxGradient"]
        ),
        sheet=quicksight.CfnTheme.SheetStyleProperty(
            tile=quicksight.CfnTheme.TileStyleProperty(
                border=quicksight.CfnTheme.BorderStyleProperty(
                    show=False
                )
            ),
            tile_layout=quicksight.CfnTheme.TileLayoutStyleProperty(
                gutter=quicksight.CfnTheme.GutterStyleProperty(
                    show=False
                ),
                margin=quicksight.CfnTheme.MarginStyleProperty(
                    show=False
                )
            )
        ),
        typography=quicksight.CfnTheme.TypographyProperty(
            font_families=[quicksight.CfnTheme.FontProperty(
                font_family="fontFamily"
            )]
        ),
        ui_color_palette=quicksight.CfnTheme.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.CfnTheme.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    version_description="versionDescription"
)

Create a new AWS::QuickSight::Theme.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • aws_account_id (str) – The ID of the AWS account where you want to store the new theme.

  • theme_id (str) – An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.

  • base_theme_id (Optional[str]) – 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 (Union[ThemeConfigurationProperty, Dict[str, Any], IResolvable, None]) – The theme configuration, which contains the theme display properties.

  • name (Optional[str]) – A display name for the theme.

  • permissions (Union[IResolvable, Sequence[Union[ResourcePermissionProperty, Dict[str, Any], IResolvable]], None]) – A valid grouping of resource permissions to apply to the new theme.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

  • version_description (Optional[str]) – 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters

target (CfnResource) –

Deprecated

use addDependency

Stability

deprecated

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

Return type

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

Return type

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type

List[Union[CfnResource, Stack]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters

target (CfnResource) –

Return type

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters
Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::QuickSight::Theme'
attr_arn

The Amazon Resource Name (ARN) of the theme.

CloudformationAttribute

Arn

attr_created_time

The time the theme was created.

CloudformationAttribute

CreatedTime

attr_last_updated_time

The time the theme was last updated.

CloudformationAttribute

LastUpdatedTime

attr_type

Theme type.

CloudformationAttribute

Type

attr_version_arn

Version.Arn

Type

cloudformationAttribute

attr_version_base_theme_id

Version.BaseThemeId

Type

cloudformationAttribute

attr_version_created_time

Version.CreatedTime

Type

cloudformationAttribute

attr_version_description

Version.Description

Type

cloudformationAttribute

attr_version_errors

Version.Errors

Type

cloudformationAttribute

attr_version_status

Version.Status

Type

cloudformationAttribute

attr_version_version_number

Version.VersionNumber

Type

cloudformationAttribute

aws_account_id

The ID of the AWS account where you want to store the new theme.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-awsaccountid

base_theme_id

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-basethemeid

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

configuration

The theme configuration, which contains the theme display properties.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-configuration

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

A display name for the theme.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-name

node

The tree node.

permissions

A valid grouping of resource permissions to apply to the new theme.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-permissions

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-tags

theme_id

An ID for the theme that you want to create.

The theme ID is unique per AWS Region in each AWS account.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-themeid

version_description

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-versiondescription

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

x (Any) – Any object.

Return type

bool

Returns

true if x is an object created from a class which extends Construct.

BorderStyleProperty

class CfnTheme.BorderStyleProperty(*, show=None)

Bases: object

The display options for tile borders for visuals.

Parameters

show (Union[bool, IResolvable, None]) – The option to enable display of borders for visuals.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-borderstyle.html

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 import aws_quicksight as quicksight

border_style_property = quicksight.CfnTheme.BorderStyleProperty(
    show=False
)

Attributes

show

The option to enable display of borders for visuals.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-borderstyle.html#cfn-quicksight-theme-borderstyle-show

DataColorPaletteProperty

class CfnTheme.DataColorPaletteProperty(*, colors=None, empty_fill_color=None, min_max_gradient=None)

Bases: object

The 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-datacolorpalette.html

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 import aws_quicksight as quicksight

data_color_palette_property = quicksight.CfnTheme.DataColorPaletteProperty(
    colors=["colors"],
    empty_fill_color="emptyFillColor",
    min_max_gradient=["minMaxGradient"]
)

Attributes

colors

The hexadecimal codes for the colors.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-datacolorpalette.html#cfn-quicksight-theme-datacolorpalette-colors

empty_fill_color

The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-datacolorpalette.html#cfn-quicksight-theme-datacolorpalette-emptyfillcolor

min_max_gradient

The minimum and maximum hexadecimal codes that describe a color gradient.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-datacolorpalette.html#cfn-quicksight-theme-datacolorpalette-minmaxgradient

FontProperty

class CfnTheme.FontProperty(*, font_family=None)

Bases: object

Parameters

font_family (Optional[str]) – CfnTheme.FontProperty.FontFamily.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-font.html

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 import aws_quicksight as quicksight

font_property = quicksight.CfnTheme.FontProperty(
    font_family="fontFamily"
)

Attributes

font_family

CfnTheme.FontProperty.FontFamily.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-font.html#cfn-quicksight-theme-font-fontfamily

GutterStyleProperty

class CfnTheme.GutterStyleProperty(*, show=None)

Bases: object

The 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-gutterstyle.html

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 import aws_quicksight as quicksight

gutter_style_property = quicksight.CfnTheme.GutterStyleProperty(
    show=False
)

Attributes

show

This Boolean value controls whether to display a gutter space between sheet tiles.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-gutterstyle.html#cfn-quicksight-theme-gutterstyle-show

MarginStyleProperty

class CfnTheme.MarginStyleProperty(*, show=None)

Bases: object

The 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-marginstyle.html

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 import aws_quicksight as quicksight

margin_style_property = quicksight.CfnTheme.MarginStyleProperty(
    show=False
)

Attributes

show

This Boolean value controls whether to display sheet margins.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-marginstyle.html#cfn-quicksight-theme-marginstyle-show

ResourcePermissionProperty

class CfnTheme.ResourcePermissionProperty(*, actions, principal)

Bases: object

Permission for the resource.

Parameters
  • actions (Sequence[str]) – The IAM action to grant or revoke permissions on.

  • principal (str) – The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon QuickSight 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 Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-resourcepermission.html

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 import aws_quicksight as quicksight

resource_permission_property = quicksight.CfnTheme.ResourcePermissionProperty(
    actions=["actions"],
    principal="principal"
)

Attributes

actions

The IAM action to grant or revoke permissions on.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-resourcepermission.html#cfn-quicksight-theme-resourcepermission-actions

principal

.

  • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

  • The ARN of an Amazon QuickSight 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 Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-resourcepermission.html#cfn-quicksight-theme-resourcepermission-principal

Type

The Amazon Resource Name (ARN) of the principal. This can be one of the following

SheetStyleProperty

class CfnTheme.SheetStyleProperty(*, tile=None, tile_layout=None)

Bases: object

The theme display options for sheets.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-sheetstyle.html

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 import aws_quicksight as quicksight

sheet_style_property = quicksight.CfnTheme.SheetStyleProperty(
    tile=quicksight.CfnTheme.TileStyleProperty(
        border=quicksight.CfnTheme.BorderStyleProperty(
            show=False
        )
    ),
    tile_layout=quicksight.CfnTheme.TileLayoutStyleProperty(
        gutter=quicksight.CfnTheme.GutterStyleProperty(
            show=False
        ),
        margin=quicksight.CfnTheme.MarginStyleProperty(
            show=False
        )
    )
)

Attributes

tile

The display options for tiles.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-sheetstyle.html#cfn-quicksight-theme-sheetstyle-tile

tile_layout

The layout options for tiles.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-sheetstyle.html#cfn-quicksight-theme-sheetstyle-tilelayout

ThemeConfigurationProperty

class CfnTheme.ThemeConfigurationProperty(*, data_color_palette=None, sheet=None, typography=None, ui_color_palette=None)

Bases: object

The theme configuration.

This configuration contains all of the display properties for a theme.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html

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 import aws_quicksight as quicksight

theme_configuration_property = quicksight.CfnTheme.ThemeConfigurationProperty(
    data_color_palette=quicksight.CfnTheme.DataColorPaletteProperty(
        colors=["colors"],
        empty_fill_color="emptyFillColor",
        min_max_gradient=["minMaxGradient"]
    ),
    sheet=quicksight.CfnTheme.SheetStyleProperty(
        tile=quicksight.CfnTheme.TileStyleProperty(
            border=quicksight.CfnTheme.BorderStyleProperty(
                show=False
            )
        ),
        tile_layout=quicksight.CfnTheme.TileLayoutStyleProperty(
            gutter=quicksight.CfnTheme.GutterStyleProperty(
                show=False
            ),
            margin=quicksight.CfnTheme.MarginStyleProperty(
                show=False
            )
        )
    ),
    typography=quicksight.CfnTheme.TypographyProperty(
        font_families=[quicksight.CfnTheme.FontProperty(
            font_family="fontFamily"
        )]
    ),
    ui_color_palette=quicksight.CfnTheme.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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html#cfn-quicksight-theme-themeconfiguration-datacolorpalette

sheet

Display options related to sheets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html#cfn-quicksight-theme-themeconfiguration-sheet

typography

CfnTheme.ThemeConfigurationProperty.Typography.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html#cfn-quicksight-theme-themeconfiguration-typography

ui_color_palette

Color properties that apply to the UI and to charts, excluding the colors that apply to data.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html#cfn-quicksight-theme-themeconfiguration-uicolorpalette

ThemeErrorProperty

class CfnTheme.ThemeErrorProperty(*, message=None, type=None)

Bases: object

Theme error.

Parameters
  • message (Optional[str]) – The error message.

  • type (Optional[str]) – The type of error.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeerror.html

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 import aws_quicksight as quicksight

theme_error_property = quicksight.CfnTheme.ThemeErrorProperty(
    message="message",
    type="type"
)

Attributes

message

The error message.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeerror.html#cfn-quicksight-theme-themeerror-message

type

The type of error.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeerror.html#cfn-quicksight-theme-themeerror-type

ThemeVersionProperty

class CfnTheme.ThemeVersionProperty(*, arn=None, base_theme_id=None, configuration=None, created_time=None, description=None, errors=None, status=None, version_number=None)

Bases: object

A version of a theme.

Parameters
  • arn (Optional[str]) – The Amazon Resource Name (ARN) of the resource.

  • base_theme_id (Optional[str]) – The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

  • configuration (Union[ThemeConfigurationProperty, Dict[str, Any], IResolvable, 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[ThemeErrorProperty, Dict[str, Any], IResolvable]], 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html

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 import aws_quicksight as quicksight

theme_version_property = quicksight.CfnTheme.ThemeVersionProperty(
    arn="arn",
    base_theme_id="baseThemeId",
    configuration=quicksight.CfnTheme.ThemeConfigurationProperty(
        data_color_palette=quicksight.CfnTheme.DataColorPaletteProperty(
            colors=["colors"],
            empty_fill_color="emptyFillColor",
            min_max_gradient=["minMaxGradient"]
        ),
        sheet=quicksight.CfnTheme.SheetStyleProperty(
            tile=quicksight.CfnTheme.TileStyleProperty(
                border=quicksight.CfnTheme.BorderStyleProperty(
                    show=False
                )
            ),
            tile_layout=quicksight.CfnTheme.TileLayoutStyleProperty(
                gutter=quicksight.CfnTheme.GutterStyleProperty(
                    show=False
                ),
                margin=quicksight.CfnTheme.MarginStyleProperty(
                    show=False
                )
            )
        ),
        typography=quicksight.CfnTheme.TypographyProperty(
            font_families=[quicksight.CfnTheme.FontProperty(
                font_family="fontFamily"
            )]
        ),
        ui_color_palette=quicksight.CfnTheme.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.CfnTheme.ThemeErrorProperty(
        message="message",
        type="type"
    )],
    status="status",
    version_number=123
)

Attributes

arn

The Amazon Resource Name (ARN) of the resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-arn

base_theme_id

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from.

All themes initially inherit from a default Amazon QuickSight theme.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-basethemeid

configuration

The theme configuration, which contains all the theme display properties.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-configuration

created_time

The date and time that this theme version was created.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-createdtime

description

The description of the theme.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-description

errors

Errors associated with the theme.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-errors

status

The status of the theme version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-status

version_number

The version number of the theme.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-versionnumber

TileLayoutStyleProperty

class CfnTheme.TileLayoutStyleProperty(*, gutter=None, margin=None)

Bases: object

The display options for the layout of tiles on a sheet.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-tilelayoutstyle.html

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 import aws_quicksight as quicksight

tile_layout_style_property = quicksight.CfnTheme.TileLayoutStyleProperty(
    gutter=quicksight.CfnTheme.GutterStyleProperty(
        show=False
    ),
    margin=quicksight.CfnTheme.MarginStyleProperty(
        show=False
    )
)

Attributes

gutter

The gutter settings that apply between tiles.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-tilelayoutstyle.html#cfn-quicksight-theme-tilelayoutstyle-gutter

margin

The margin settings that apply around the outside edge of sheets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-tilelayoutstyle.html#cfn-quicksight-theme-tilelayoutstyle-margin

TileStyleProperty

class CfnTheme.TileStyleProperty(*, border=None)

Bases: object

Display options related to tiles on a sheet.

Parameters

border (Union[BorderStyleProperty, Dict[str, Any], IResolvable, None]) – The border around a tile.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-tilestyle.html

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 import aws_quicksight as quicksight

tile_style_property = quicksight.CfnTheme.TileStyleProperty(
    border=quicksight.CfnTheme.BorderStyleProperty(
        show=False
    )
)

Attributes

border

The border around a tile.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-tilestyle.html#cfn-quicksight-theme-tilestyle-border

TypographyProperty

class CfnTheme.TypographyProperty(*, font_families=None)

Bases: object

Parameters

font_families (Union[IResolvable, Sequence[Union[FontProperty, Dict[str, Any], IResolvable]], None]) – CfnTheme.TypographyProperty.FontFamilies.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-typography.html

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 import aws_quicksight as quicksight

typography_property = quicksight.CfnTheme.TypographyProperty(
    font_families=[quicksight.CfnTheme.FontProperty(
        font_family="fontFamily"
    )]
)

Attributes

font_families

CfnTheme.TypographyProperty.FontFamilies.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-typography.html#cfn-quicksight-theme-typography-fontfamilies

UIColorPaletteProperty

class CfnTheme.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: object

The 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 QuickSight in the Amazon QuickSight 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html

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 import aws_quicksight as quicksight

u_iColor_palette_property = quicksight.CfnTheme.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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-accent

accent_foreground

The foreground color that applies to any text or other elements that appear over the accent color.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-accentforeground

danger

The color that applies to error messages.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-danger

danger_foreground

The foreground color that applies to any text or other elements that appear over the error color.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-dangerforeground

dimension

The color that applies to the names of fields that are identified as dimensions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-dimension

dimension_foreground

The foreground color that applies to any text or other elements that appear over the dimension color.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-dimensionforeground

measure

The color that applies to the names of fields that are identified as measures.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-measure

measure_foreground

The foreground color that applies to any text or other elements that appear over the measure color.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-measureforeground

primary_background

The background color that applies to visuals and other high emphasis UI.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-primarybackground

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-primaryforeground

secondary_background

The background color that applies to the sheet background and sheet controls.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-secondarybackground

secondary_foreground

The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-secondaryforeground

success

The color that applies to success messages, for example the check mark for a successful download.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-success

success_foreground

The foreground color that applies to any text or other elements that appear over the success color.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-successforeground

warning

This color that applies to warning and informational messages.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-warning

warning_foreground

The foreground color that applies to any text or other elements that appear over the warning color.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html#cfn-quicksight-theme-uicolorpalette-warningforeground