CfnThemeProps

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

Bases: object

Properties for defining a CfnTheme.

Parameters
  • 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.

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_props = quicksight.CfnThemeProps(
    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"
)

Attributes

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

Return type

str

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

Return type

Optional[str]

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

Return type

Union[ThemeConfigurationProperty, IResolvable, None]

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

Return type

Optional[str]

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

Return type

Union[IResolvable, List[Union[ResourcePermissionProperty, IResolvable]], None]

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

Return type

Optional[List[CfnTag]]

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

Return type

str

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

Return type

Optional[str]