CfnTemplatePropsMixin

class aws_cdk.mixins_preview.aws_quicksight.mixins.CfnTemplatePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a template from an existing Quick Suite analysis or template.

You can use the resulting template to create a dashboard.

A template is an entity in Quick Suite that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

See:

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

CloudformationResource:

AWS::QuickSight::Template

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

Create a mixin to apply properties to AWS::QuickSight::Template.

Parameters:

  • props (Union[CfnTemplateMixinProps, 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:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['awsAccountId', 'definition', 'name', 'permissions', 'sourceEntity', 'tags', 'templateId', 'validationStrategy', 'versionDescription']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

Stability:

experimental

AggregationFunctionProperty

class CfnTemplatePropsMixin.AggregationFunctionProperty(*, attribute_aggregation_function=None, categorical_aggregation_function=None, date_aggregation_function=None, numerical_aggregation_function=None)

Bases: object

An aggregation function aggregates values from a dimension or measure.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • attribute_aggregation_function (Union[IResolvable, AttributeAggregationFunctionProperty, Dict[str, Any], None]) – Aggregation for attributes.

  • categorical_aggregation_function (Optional[str]) – Aggregation for categorical values. - COUNT : Aggregate by the total number of values, including duplicates. - DISTINCT_COUNT : Aggregate by the total number of distinct values.

  • date_aggregation_function (Optional[str]) – Aggregation for date values. - COUNT : Aggregate by the total number of values, including duplicates. - DISTINCT_COUNT : Aggregate by the total number of distinct values. - MIN : Select the smallest date value. - MAX : Select the largest date value.

  • numerical_aggregation_function (Union[IResolvable, NumericalAggregationFunctionProperty, Dict[str, Any], None]) – Aggregation for numerical values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationfunction.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

aggregation_function_property = quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
    attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
        simple_attribute_aggregation="simpleAttributeAggregation",
        value_for_multiple_values="valueForMultipleValues"
    ),
    categorical_aggregation_function="categoricalAggregationFunction",
    date_aggregation_function="dateAggregationFunction",
    numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
        percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
            percentile_value=123
        ),
        simple_numerical_aggregation="simpleNumericalAggregation"
    )
)

Attributes

attribute_aggregation_function

Aggregation for attributes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationfunction.html#cfn-quicksight-template-aggregationfunction-attributeaggregationfunction

categorical_aggregation_function

Aggregation for categorical values.

  • COUNT : Aggregate by the total number of values, including duplicates.

  • DISTINCT_COUNT : Aggregate by the total number of distinct values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationfunction.html#cfn-quicksight-template-aggregationfunction-categoricalaggregationfunction

date_aggregation_function

Aggregation for date values.

  • COUNT : Aggregate by the total number of values, including duplicates.

  • DISTINCT_COUNT : Aggregate by the total number of distinct values.

  • MIN : Select the smallest date value.

  • MAX : Select the largest date value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationfunction.html#cfn-quicksight-template-aggregationfunction-dateaggregationfunction

numerical_aggregation_function

Aggregation for numerical values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationfunction.html#cfn-quicksight-template-aggregationfunction-numericalaggregationfunction

AggregationSortConfigurationProperty

class CfnTemplatePropsMixin.AggregationSortConfigurationProperty(*, aggregation_function=None, column=None, sort_direction=None)

Bases: object

The configuration options to sort aggregated values.

Parameters:

  • aggregation_function (Union[IResolvable, AggregationFunctionProperty, Dict[str, Any], None]) – The function that aggregates the values in Column .

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that determines the sort order of aggregated values.

  • sort_direction (Optional[str]) – The sort direction of values. - ASC : Sort in ascending order. - DESC : Sort in descending order.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

aggregation_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.AggregationSortConfigurationProperty(
    aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    ),
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    sort_direction="sortDirection"
)

Attributes

aggregation_function

The function that aggregates the values in Column .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationsortconfiguration.html#cfn-quicksight-template-aggregationsortconfiguration-aggregationfunction

column

The column that determines the sort order of aggregated values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationsortconfiguration.html#cfn-quicksight-template-aggregationsortconfiguration-column

sort_direction

The sort direction of values.

  • ASC : Sort in ascending order.

  • DESC : Sort in descending order.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-aggregationsortconfiguration.html#cfn-quicksight-template-aggregationsortconfiguration-sortdirection

AnalysisDefaultsProperty

class CfnTemplatePropsMixin.AnalysisDefaultsProperty(*, default_new_sheet_configuration=None)

Bases: object

The configuration for default analysis settings.

Parameters:

default_new_sheet_configuration (Union[IResolvable, DefaultNewSheetConfigurationProperty, Dict[str, Any], None]) – The configuration for default new sheet settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-analysisdefaults.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

analysis_defaults_property = quicksight_mixins.CfnTemplatePropsMixin.AnalysisDefaultsProperty(
    default_new_sheet_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultNewSheetConfigurationProperty(
        interactive_layout_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultInteractiveLayoutConfigurationProperty(
            free_form=quicksight_mixins.CfnTemplatePropsMixin.DefaultFreeFormLayoutConfigurationProperty(
                canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutCanvasSizeOptionsProperty(
                    screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutScreenCanvasSizeOptionsProperty(
                        optimized_view_port_width="optimizedViewPortWidth"
                    )
                )
            ),
            grid=quicksight_mixins.CfnTemplatePropsMixin.DefaultGridLayoutConfigurationProperty(
                canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(
                    screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
                        optimized_view_port_width="optimizedViewPortWidth",
                        resize_option="resizeOption"
                    )
                )
            )
        ),
        paginated_layout_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultPaginatedLayoutConfigurationProperty(
            section_based=quicksight_mixins.CfnTemplatePropsMixin.DefaultSectionBasedLayoutConfigurationProperty(
                canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutCanvasSizeOptionsProperty(
                    paper_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
                        paper_margin=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                            bottom="bottom",
                            left="left",
                            right="right",
                            top="top"
                        ),
                        paper_orientation="paperOrientation",
                        paper_size="paperSize"
                    )
                )
            )
        ),
        sheet_content_type="sheetContentType"
    )
)

Attributes

default_new_sheet_configuration

The configuration for default new sheet settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-analysisdefaults.html#cfn-quicksight-template-analysisdefaults-defaultnewsheetconfiguration

AnchorDateConfigurationProperty

class CfnTemplatePropsMixin.AnchorDateConfigurationProperty(*, anchor_option=None, parameter_name=None)

Bases: object

The date configuration of the filter.

Parameters:

  • anchor_option (Optional[str]) – The options for the date configuration. Choose one of the options below:. - NOW

  • parameter_name (Optional[str]) – The name of the parameter that is used for the anchor date configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-anchordateconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

anchor_date_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.AnchorDateConfigurationProperty(
    anchor_option="anchorOption",
    parameter_name="parameterName"
)

Attributes

anchor_option

.

  • NOW

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-anchordateconfiguration.html#cfn-quicksight-template-anchordateconfiguration-anchoroption

Type:

The options for the date configuration. Choose one of the options below

parameter_name

The name of the parameter that is used for the anchor date configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-anchordateconfiguration.html#cfn-quicksight-template-anchordateconfiguration-parametername

ArcAxisConfigurationProperty

class CfnTemplatePropsMixin.ArcAxisConfigurationProperty(*, range=None, reserve_range=None)

Bases: object

The arc axis configuration of a GaugeChartVisual .

Parameters:

  • range (Union[IResolvable, ArcAxisDisplayRangeProperty, Dict[str, Any], None]) – The arc axis range of a GaugeChartVisual .

  • reserve_range (Union[int, float, None]) – The reserved range of the arc axis. Default: - 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

arc_axis_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ArcAxisConfigurationProperty(
    range=quicksight_mixins.CfnTemplatePropsMixin.ArcAxisDisplayRangeProperty(
        max=123,
        min=123
    ),
    reserve_range=123
)

Attributes

range

The arc axis range of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisconfiguration.html#cfn-quicksight-template-arcaxisconfiguration-range

reserve_range

The reserved range of the arc axis.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisconfiguration.html#cfn-quicksight-template-arcaxisconfiguration-reserverange

ArcAxisDisplayRangeProperty

class CfnTemplatePropsMixin.ArcAxisDisplayRangeProperty(*, max=None, min=None)

Bases: object

The arc axis range of a GaugeChartVisual .

Parameters:

  • max (Union[int, float, None]) – The maximum value of the arc axis range.

  • min (Union[int, float, None]) – The minimum value of the arc axis range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisdisplayrange.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

arc_axis_display_range_property = quicksight_mixins.CfnTemplatePropsMixin.ArcAxisDisplayRangeProperty(
    max=123,
    min=123
)

Attributes

max

The maximum value of the arc axis range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisdisplayrange.html#cfn-quicksight-template-arcaxisdisplayrange-max

min

The minimum value of the arc axis range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcaxisdisplayrange.html#cfn-quicksight-template-arcaxisdisplayrange-min

ArcConfigurationProperty

class CfnTemplatePropsMixin.ArcConfigurationProperty(*, arc_angle=None, arc_thickness=None)

Bases: object

The arc configuration of a GaugeChartVisual .

Parameters:

  • arc_angle (Union[int, float, None]) – The option that determines the arc angle of a GaugeChartVisual .

  • arc_thickness (Optional[str]) – The options that determine the arc thickness of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

arc_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ArcConfigurationProperty(
    arc_angle=123,
    arc_thickness="arcThickness"
)

Attributes

arc_angle

The option that determines the arc angle of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcconfiguration.html#cfn-quicksight-template-arcconfiguration-arcangle

arc_thickness

The options that determine the arc thickness of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcconfiguration.html#cfn-quicksight-template-arcconfiguration-arcthickness

ArcOptionsProperty

class CfnTemplatePropsMixin.ArcOptionsProperty(*, arc_thickness=None)

Bases: object

The options that determine the arc thickness of a GaugeChartVisual .

Parameters:

arc_thickness (Optional[str]) – The arc thickness of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

arc_options_property = quicksight_mixins.CfnTemplatePropsMixin.ArcOptionsProperty(
    arc_thickness="arcThickness"
)

Attributes

arc_thickness

The arc thickness of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-arcoptions.html#cfn-quicksight-template-arcoptions-arcthickness

AssetOptionsProperty

class CfnTemplatePropsMixin.AssetOptionsProperty(*, timezone=None, week_start=None)

Bases: object

An array of analysis level configurations.

Parameters:

  • timezone (Optional[str]) – Determines the timezone for the analysis.

  • week_start (Optional[str]) – Determines the week start day for an analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-assetoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

asset_options_property = quicksight_mixins.CfnTemplatePropsMixin.AssetOptionsProperty(
    timezone="timezone",
    week_start="weekStart"
)

Attributes

timezone

Determines the timezone for the analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-assetoptions.html#cfn-quicksight-template-assetoptions-timezone

week_start

Determines the week start day for an analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-assetoptions.html#cfn-quicksight-template-assetoptions-weekstart

AttributeAggregationFunctionProperty

class CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(*, simple_attribute_aggregation=None, value_for_multiple_values=None)

Bases: object

Aggregation for attributes.

Parameters:

  • simple_attribute_aggregation (Optional[str]) – The built-in aggregation functions for attributes. - UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

  • value_for_multiple_values (Optional[str]) – Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-attributeaggregationfunction.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

attribute_aggregation_function_property = quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
    simple_attribute_aggregation="simpleAttributeAggregation",
    value_for_multiple_values="valueForMultipleValues"
)

Attributes

simple_attribute_aggregation

The built-in aggregation functions for attributes.

  • UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-attributeaggregationfunction.html#cfn-quicksight-template-attributeaggregationfunction-simpleattributeaggregation

value_for_multiple_values

Used by the UNIQUE_VALUE aggregation function.

If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-attributeaggregationfunction.html#cfn-quicksight-template-attributeaggregationfunction-valueformultiplevalues

AxisDataOptionsProperty

class CfnTemplatePropsMixin.AxisDataOptionsProperty(*, date_axis_options=None, numeric_axis_options=None)

Bases: object

The data options for an axis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdataoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# data_driven: Any

axis_data_options_property = quicksight_mixins.CfnTemplatePropsMixin.AxisDataOptionsProperty(
    date_axis_options=quicksight_mixins.CfnTemplatePropsMixin.DateAxisOptionsProperty(
        missing_date_visibility="missingDateVisibility"
    ),
    numeric_axis_options=quicksight_mixins.CfnTemplatePropsMixin.NumericAxisOptionsProperty(
        range=quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayRangeProperty(
            data_driven=data_driven,
            min_max=quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayMinMaxRangeProperty(
                maximum=123,
                minimum=123
            )
        ),
        scale=quicksight_mixins.CfnTemplatePropsMixin.AxisScaleProperty(
            linear=quicksight_mixins.CfnTemplatePropsMixin.AxisLinearScaleProperty(
                step_count=123,
                step_size=123
            ),
            logarithmic=quicksight_mixins.CfnTemplatePropsMixin.AxisLogarithmicScaleProperty(
                base=123
            )
        )
    )
)

Attributes

date_axis_options

The options for an axis with a date field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdataoptions.html#cfn-quicksight-template-axisdataoptions-dateaxisoptions

numeric_axis_options

The options for an axis with a numeric field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdataoptions.html#cfn-quicksight-template-axisdataoptions-numericaxisoptions

AxisDisplayMinMaxRangeProperty

class CfnTemplatePropsMixin.AxisDisplayMinMaxRangeProperty(*, maximum=None, minimum=None)

Bases: object

The minimum and maximum setup for an axis display range.

Parameters:

  • maximum (Union[int, float, None]) – The maximum setup for an axis display range.

  • minimum (Union[int, float, None]) – The minimum setup for an axis display range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayminmaxrange.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

axis_display_min_max_range_property = quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayMinMaxRangeProperty(
    maximum=123,
    minimum=123
)

Attributes

maximum

The maximum setup for an axis display range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayminmaxrange.html#cfn-quicksight-template-axisdisplayminmaxrange-maximum

minimum

The minimum setup for an axis display range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayminmaxrange.html#cfn-quicksight-template-axisdisplayminmaxrange-minimum

AxisDisplayOptionsProperty

class CfnTemplatePropsMixin.AxisDisplayOptionsProperty(*, axis_line_visibility=None, axis_offset=None, data_options=None, grid_line_visibility=None, scrollbar_options=None, tick_label_options=None)

Bases: object

The display options for the axis label.

Parameters:

  • axis_line_visibility (Optional[str]) – Determines whether or not the axis line is visible.

  • axis_offset (Optional[str]) – The offset value that determines the starting placement of the axis within a visual’s bounds.

  • data_options (Union[IResolvable, AxisDataOptionsProperty, Dict[str, Any], None]) – The data options for an axis.

  • grid_line_visibility (Optional[str]) – Determines whether or not the grid line is visible.

  • scrollbar_options (Union[IResolvable, ScrollBarOptionsProperty, Dict[str, Any], None]) – The scroll bar options for an axis.

  • tick_label_options (Union[IResolvable, AxisTickLabelOptionsProperty, Dict[str, Any], None]) – The tick label options of an axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# data_driven: Any

axis_display_options_property = quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayOptionsProperty(
    axis_line_visibility="axisLineVisibility",
    axis_offset="axisOffset",
    data_options=quicksight_mixins.CfnTemplatePropsMixin.AxisDataOptionsProperty(
        date_axis_options=quicksight_mixins.CfnTemplatePropsMixin.DateAxisOptionsProperty(
            missing_date_visibility="missingDateVisibility"
        ),
        numeric_axis_options=quicksight_mixins.CfnTemplatePropsMixin.NumericAxisOptionsProperty(
            range=quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayRangeProperty(
                data_driven=data_driven,
                min_max=quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayMinMaxRangeProperty(
                    maximum=123,
                    minimum=123
                )
            ),
            scale=quicksight_mixins.CfnTemplatePropsMixin.AxisScaleProperty(
                linear=quicksight_mixins.CfnTemplatePropsMixin.AxisLinearScaleProperty(
                    step_count=123,
                    step_size=123
                ),
                logarithmic=quicksight_mixins.CfnTemplatePropsMixin.AxisLogarithmicScaleProperty(
                    base=123
                )
            )
        )
    ),
    grid_line_visibility="gridLineVisibility",
    scrollbar_options=quicksight_mixins.CfnTemplatePropsMixin.ScrollBarOptionsProperty(
        visibility="visibility",
        visible_range=quicksight_mixins.CfnTemplatePropsMixin.VisibleRangeOptionsProperty(
            percent_range=quicksight_mixins.CfnTemplatePropsMixin.PercentVisibleRangeProperty(
                from=123,
                to=123
            )
        )
    ),
    tick_label_options=quicksight_mixins.CfnTemplatePropsMixin.AxisTickLabelOptionsProperty(
        label_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        ),
        rotation_angle=123
    )
)

Attributes

axis_line_visibility

Determines whether or not the axis line is visible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-axislinevisibility

axis_offset

The offset value that determines the starting placement of the axis within a visual’s bounds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-axisoffset

data_options

The data options for an axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-dataoptions

grid_line_visibility

Determines whether or not the grid line is visible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-gridlinevisibility

scrollbar_options

The scroll bar options for an axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-scrollbaroptions

tick_label_options

The tick label options of an axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayoptions.html#cfn-quicksight-template-axisdisplayoptions-ticklabeloptions

AxisDisplayRangeProperty

class CfnTemplatePropsMixin.AxisDisplayRangeProperty(*, data_driven=None, min_max=None)

Bases: object

The range setup of a numeric axis display range.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • data_driven (Any) – The data-driven setup of an axis display range.

  • min_max (Union[IResolvable, AxisDisplayMinMaxRangeProperty, Dict[str, Any], None]) – The minimum and maximum setup of an axis display range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayrange.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# data_driven: Any

axis_display_range_property = quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayRangeProperty(
    data_driven=data_driven,
    min_max=quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayMinMaxRangeProperty(
        maximum=123,
        minimum=123
    )
)

Attributes

data_driven

The data-driven setup of an axis display range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayrange.html#cfn-quicksight-template-axisdisplayrange-datadriven

min_max

The minimum and maximum setup of an axis display range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisdisplayrange.html#cfn-quicksight-template-axisdisplayrange-minmax

AxisLabelOptionsProperty

class CfnTemplatePropsMixin.AxisLabelOptionsProperty(*, apply_to=None, custom_label=None, font_configuration=None)

Bases: object

The label options for a chart axis.

You must specify the field that the label is targeted to.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

axis_label_options_property = quicksight_mixins.CfnTemplatePropsMixin.AxisLabelOptionsProperty(
    apply_to=quicksight_mixins.CfnTemplatePropsMixin.AxisLabelReferenceOptionsProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId"
    ),
    custom_label="customLabel",
    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    )
)

Attributes

apply_to

The options that indicate which field the label belongs to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.html#cfn-quicksight-template-axislabeloptions-applyto

custom_label

The text for the axis label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.html#cfn-quicksight-template-axislabeloptions-customlabel

font_configuration

The font configuration of the axis label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabeloptions.html#cfn-quicksight-template-axislabeloptions-fontconfiguration

AxisLabelReferenceOptionsProperty

class CfnTemplatePropsMixin.AxisLabelReferenceOptionsProperty(*, column=None, field_id=None)

Bases: object

The reference that specifies where the axis label is applied to.

Parameters:

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the axis label is targeted to.

  • field_id (Optional[str]) – The field that the axis label is targeted to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabelreferenceoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

axis_label_reference_options_property = quicksight_mixins.CfnTemplatePropsMixin.AxisLabelReferenceOptionsProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId"
)

Attributes

column

The column that the axis label is targeted to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabelreferenceoptions.html#cfn-quicksight-template-axislabelreferenceoptions-column

field_id

The field that the axis label is targeted to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislabelreferenceoptions.html#cfn-quicksight-template-axislabelreferenceoptions-fieldid

AxisLinearScaleProperty

class CfnTemplatePropsMixin.AxisLinearScaleProperty(*, step_count=None, step_size=None)

Bases: object

The liner axis scale setup.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • step_count (Union[int, float, None]) – The step count setup of a linear axis.

  • step_size (Union[int, float, None]) – The step size setup of a linear axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislinearscale.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

axis_linear_scale_property = quicksight_mixins.CfnTemplatePropsMixin.AxisLinearScaleProperty(
    step_count=123,
    step_size=123
)

Attributes

step_count

The step count setup of a linear axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislinearscale.html#cfn-quicksight-template-axislinearscale-stepcount

step_size

The step size setup of a linear axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislinearscale.html#cfn-quicksight-template-axislinearscale-stepsize

AxisLogarithmicScaleProperty

class CfnTemplatePropsMixin.AxisLogarithmicScaleProperty(*, base=None)

Bases: object

The logarithmic axis scale setup.

Parameters:

base (Union[int, float, None]) – The base setup of a logarithmic axis scale.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislogarithmicscale.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

axis_logarithmic_scale_property = quicksight_mixins.CfnTemplatePropsMixin.AxisLogarithmicScaleProperty(
    base=123
)

Attributes

base

The base setup of a logarithmic axis scale.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axislogarithmicscale.html#cfn-quicksight-template-axislogarithmicscale-base

AxisScaleProperty

class CfnTemplatePropsMixin.AxisScaleProperty(*, linear=None, logarithmic=None)

Bases: object

The scale setup options for a numeric axis display.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisscale.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

axis_scale_property = quicksight_mixins.CfnTemplatePropsMixin.AxisScaleProperty(
    linear=quicksight_mixins.CfnTemplatePropsMixin.AxisLinearScaleProperty(
        step_count=123,
        step_size=123
    ),
    logarithmic=quicksight_mixins.CfnTemplatePropsMixin.AxisLogarithmicScaleProperty(
        base=123
    )
)

Attributes

linear

The linear axis scale setup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisscale.html#cfn-quicksight-template-axisscale-linear

logarithmic

The logarithmic axis scale setup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisscale.html#cfn-quicksight-template-axisscale-logarithmic

AxisTickLabelOptionsProperty

class CfnTemplatePropsMixin.AxisTickLabelOptionsProperty(*, label_options=None, rotation_angle=None)

Bases: object

The tick label options of an axis.

Parameters:

  • label_options (Union[IResolvable, LabelOptionsProperty, Dict[str, Any], None]) – Determines whether or not the axis ticks are visible.

  • rotation_angle (Union[int, float, None]) – The rotation angle of the axis tick labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisticklabeloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

axis_tick_label_options_property = quicksight_mixins.CfnTemplatePropsMixin.AxisTickLabelOptionsProperty(
    label_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        visibility="visibility"
    ),
    rotation_angle=123
)

Attributes

label_options

Determines whether or not the axis ticks are visible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisticklabeloptions.html#cfn-quicksight-template-axisticklabeloptions-labeloptions

rotation_angle

The rotation angle of the axis tick labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-axisticklabeloptions.html#cfn-quicksight-template-axisticklabeloptions-rotationangle

BarChartAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.BarChartAggregatedFieldWellsProperty(*, category=None, colors=None, small_multiples=None, values=None)

Bases: object

The aggregated field wells of a bar chart.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category

The category (y-axis) field well of a bar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartaggregatedfieldwells.html#cfn-quicksight-template-barchartaggregatedfieldwells-category

colors

The color (group/color) field well of a bar chart.

See:

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

small_multiples

The small multiples field well of a bar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartaggregatedfieldwells.html#cfn-quicksight-template-barchartaggregatedfieldwells-smallmultiples

values

The value field wells of a bar chart.

Values are aggregated by category.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartaggregatedfieldwells.html#cfn-quicksight-template-barchartaggregatedfieldwells-values

BarChartConfigurationProperty

class CfnTemplatePropsMixin.BarChartConfigurationProperty(*, bars_arrangement=None, category_axis=None, category_label_options=None, color_label_options=None, contribution_analysis_defaults=None, data_labels=None, field_wells=None, interactions=None, legend=None, orientation=None, reference_lines=None, small_multiples_options=None, sort_configuration=None, tooltip=None, value_axis=None, value_label_options=None, visual_palette=None)

Bases: object

The configuration of a BarChartVisual .

Parameters:

  • bars_arrangement (Optional[str]) – Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

  • category_axis (Union[IResolvable, AxisDisplayOptionsProperty, Dict[str, Any], None]) – The label display options (grid line, range, scale, axis step) for bar chart category.

  • category_label_options (Union[IResolvable, ChartAxisLabelOptionsProperty, Dict[str, Any], None]) – The label options (label text, label visibility and sort icon visibility) for a bar chart.

  • color_label_options (Union[IResolvable, ChartAxisLabelOptionsProperty, Dict[str, Any], None]) – The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

  • contribution_analysis_defaults (Union[IResolvable, Sequence[Union[IResolvable, ContributionAnalysisDefaultProperty, Dict[str, Any]]], None]) – The contribution analysis (anomaly configuration) setup of the visual.

  • data_labels (Union[IResolvable, DataLabelOptionsProperty, Dict[str, Any], None]) – The options that determine if visual data labels are displayed.

  • field_wells (Union[IResolvable, BarChartFieldWellsProperty, Dict[str, Any], None]) – The field wells of the visual.

  • interactions (Union[IResolvable, VisualInteractionOptionsProperty, Dict[str, Any], None]) – The general visual interactions setup for a visual.

  • legend (Union[IResolvable, LegendOptionsProperty, Dict[str, Any], None]) – The legend display setup of the visual.

  • orientation (Optional[str]) – The orientation of the bars in a bar chart visual. There are two valid values in this structure:. - HORIZONTAL : Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts. - VERTICAL : Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

  • reference_lines (Union[IResolvable, Sequence[Union[IResolvable, ReferenceLineProperty, Dict[str, Any]]], None]) – The reference line setup of the visual.

  • small_multiples_options (Union[IResolvable, SmallMultiplesOptionsProperty, Dict[str, Any], None]) – The small multiples setup for the visual.

  • sort_configuration (Union[IResolvable, BarChartSortConfigurationProperty, Dict[str, Any], None]) – The sort configuration of a BarChartVisual .

  • tooltip (Union[IResolvable, TooltipOptionsProperty, Dict[str, Any], None]) – The tooltip display setup of the visual.

  • value_axis (Union[IResolvable, AxisDisplayOptionsProperty, Dict[str, Any], None]) – The label display options (grid line, range, scale, axis step) for a bar chart value.

  • value_label_options (Union[IResolvable, ChartAxisLabelOptionsProperty, Dict[str, Any], None]) – The label options (label text, label visibility and sort icon visibility) for a bar chart value.

  • visual_palette (Union[IResolvable, VisualPaletteProperty, Dict[str, Any], None]) – The palette (chart color) display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
bars_arrangement

Determines the arrangement of the bars.

The orientation and arrangement of bars determine the type of bar that is used in the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-barsarrangement

category_axis

The label display options (grid line, range, scale, axis step) for bar chart category.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-categoryaxis

category_label_options

The label options (label text, label visibility and sort icon visibility) for a bar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-categorylabeloptions

color_label_options

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-colorlabeloptions

contribution_analysis_defaults

The contribution analysis (anomaly configuration) setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-contributionanalysisdefaults

data_labels

The options that determine if visual data labels are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-datalabels

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-interactions

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-legend

orientation

.

  • HORIZONTAL : Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.

  • VERTICAL : Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-orientation

Type:

The orientation of the bars in a bar chart visual. There are two valid values in this structure

reference_lines

The reference line setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-referencelines

small_multiples_options

The small multiples setup for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-smallmultiplesoptions

sort_configuration

The sort configuration of a BarChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-sortconfiguration

tooltip

The tooltip display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-tooltip

value_axis

The label display options (grid line, range, scale, axis step) for a bar chart value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-valueaxis

value_label_options

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-valuelabeloptions

visual_palette

The palette (chart color) display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartconfiguration.html#cfn-quicksight-template-barchartconfiguration-visualpalette

BarChartFieldWellsProperty

class CfnTemplatePropsMixin.BarChartFieldWellsProperty(*, bar_chart_aggregated_field_wells=None)

Bases: object

The field wells of a BarChartVisual .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

bar_chart_aggregated_field_wells (Union[IResolvable, BarChartAggregatedFieldWellsProperty, Dict[str, Any], None]) – The aggregated field wells of a bar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
bar_chart_aggregated_field_wells

The aggregated field wells of a bar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartfieldwells.html#cfn-quicksight-template-barchartfieldwells-barchartaggregatedfieldwells

BarChartSortConfigurationProperty

class CfnTemplatePropsMixin.BarChartSortConfigurationProperty(*, category_items_limit=None, category_sort=None, color_items_limit=None, color_sort=None, small_multiples_limit_configuration=None, small_multiples_sort=None)

Bases: object

sort-configuration-description.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

bar_chart_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.BarChartSortConfigurationProperty(
    category_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    color_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    color_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    small_multiples_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    small_multiples_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

category_items_limit

The limit on the number of categories displayed in a bar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-categoryitemslimit

category_sort

The sort configuration of category fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-categorysort

color_items_limit

The limit on the number of values displayed in a bar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-coloritemslimit

color_sort

The sort configuration of color fields in a bar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-colorsort

small_multiples_limit_configuration

The limit on the number of small multiples panels that are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-smallmultipleslimitconfiguration

small_multiples_sort

The sort configuration of the small multiples field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartsortconfiguration.html#cfn-quicksight-template-barchartsortconfiguration-smallmultiplessort

BarChartVisualProperty

class CfnTemplatePropsMixin.BarChartVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A bar chart.

The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

  • Horizontal bar chart

  • Vertical bar chart

  • Horizontal stacked bar chart

  • Vertical stacked bar chart

  • Horizontal stacked 100% bar chart

  • Vertical stacked 100% bar chart

For more information, see Using bar charts in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-barchartvisual.html#cfn-quicksight-template-barchartvisual-visualid

BinCountOptionsProperty

class CfnTemplatePropsMixin.BinCountOptionsProperty(*, value=None)

Bases: object

The options that determine the bin count of a histogram.

Parameters:

value (Union[int, float, None]) – The options that determine the bin count value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bincountoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

bin_count_options_property = quicksight_mixins.CfnTemplatePropsMixin.BinCountOptionsProperty(
    value=123
)

Attributes

value

The options that determine the bin count value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bincountoptions.html#cfn-quicksight-template-bincountoptions-value

BinWidthOptionsProperty

class CfnTemplatePropsMixin.BinWidthOptionsProperty(*, bin_count_limit=None, value=None)

Bases: object

The options that determine the bin width of a histogram.

Parameters:

  • bin_count_limit (Union[int, float, None]) – The options that determine the bin count limit.

  • value (Union[int, float, None]) – The options that determine the bin width value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-binwidthoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

bin_width_options_property = quicksight_mixins.CfnTemplatePropsMixin.BinWidthOptionsProperty(
    bin_count_limit=123,
    value=123
)

Attributes

bin_count_limit

The options that determine the bin count limit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-binwidthoptions.html#cfn-quicksight-template-binwidthoptions-bincountlimit

value

The options that determine the bin width value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-binwidthoptions.html#cfn-quicksight-template-binwidthoptions-value

BodySectionConfigurationProperty

class CfnTemplatePropsMixin.BodySectionConfigurationProperty(*, content=None, page_break_configuration=None, repeat_configuration=None, section_id=None, style=None)

Bases: object

The configuration of a body section.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

body_section_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.BodySectionConfigurationProperty(
    content=quicksight_mixins.CfnTemplatePropsMixin.BodySectionContentProperty(
        layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
            free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
                elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                    background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    element_id="elementId",
                    element_type="elementType",
                    height="height",
                    loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                        visibility="visibility"
                    ),
                    rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                        configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                            visibility="visibility"
                        ),
                        expression="expression"
                    )],
                    selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    visibility="visibility",
                    width="width",
                    x_axis_location="xAxisLocation",
                    y_axis_location="yAxisLocation"
                )]
            )
        )
    ),
    page_break_configuration=quicksight_mixins.CfnTemplatePropsMixin.SectionPageBreakConfigurationProperty(
        after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
            status="status"
        )
    ),
    repeat_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatConfigurationProperty(
        dimension_configurations=[quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatDimensionConfigurationProperty(
            dynamic_category_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicCategoryDimensionConfigurationProperty(
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                limit=123,
                sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                    aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                        attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                            simple_attribute_aggregation="simpleAttributeAggregation",
                            value_for_multiple_values="valueForMultipleValues"
                        ),
                        categorical_aggregation_function="categoricalAggregationFunction",
                        date_aggregation_function="dateAggregationFunction",
                        numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                            percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                                percentile_value=123
                            ),
                            simple_numerical_aggregation="simpleNumericalAggregation"
                        )
                    ),
                    direction="direction",
                    sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    )
                )]
            ),
            dynamic_numeric_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicNumericDimensionConfigurationProperty(
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                limit=123,
                sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                    aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                        attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                            simple_attribute_aggregation="simpleAttributeAggregation",
                            value_for_multiple_values="valueForMultipleValues"
                        ),
                        categorical_aggregation_function="categoricalAggregationFunction",
                        date_aggregation_function="dateAggregationFunction",
                        numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                            percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                                percentile_value=123
                            ),
                            simple_numerical_aggregation="simpleNumericalAggregation"
                        )
                    ),
                    direction="direction",
                    sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    )
                )]
            )
        )],
        non_repeating_visuals=["nonRepeatingVisuals"],
        page_break_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatPageBreakConfigurationProperty(
            after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
                status="status"
            )
        )
    ),
    section_id="sectionId",
    style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
        height="height",
        padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
            bottom="bottom",
            left="left",
            right="right",
            top="top"
        )
    )
)

Attributes

content

The configuration of content in a body section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html#cfn-quicksight-template-bodysectionconfiguration-content

page_break_configuration

The configuration of a page break for a section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html#cfn-quicksight-template-bodysectionconfiguration-pagebreakconfiguration

repeat_configuration

Describes the configurations that are required to declare a section as repeating.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html#cfn-quicksight-template-bodysectionconfiguration-repeatconfiguration

section_id

The unique identifier of a body section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html#cfn-quicksight-template-bodysectionconfiguration-sectionid

style

The style options of a body section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionconfiguration.html#cfn-quicksight-template-bodysectionconfiguration-style

BodySectionContentProperty

class CfnTemplatePropsMixin.BodySectionContentProperty(*, layout=None)

Bases: object

The configuration of content in a body section.

Parameters:

layout (Union[IResolvable, SectionLayoutConfigurationProperty, Dict[str, Any], None]) – The layout configuration of a body section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectioncontent.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

body_section_content_property = quicksight_mixins.CfnTemplatePropsMixin.BodySectionContentProperty(
    layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
        free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
            elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                element_id="elementId",
                element_type="elementType",
                height="height",
                loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                    visibility="visibility"
                ),
                rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                    configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                        visibility="visibility"
                    ),
                    expression="expression"
                )],
                selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                visibility="visibility",
                width="width",
                x_axis_location="xAxisLocation",
                y_axis_location="yAxisLocation"
            )]
        )
    )
)

Attributes

layout

The layout configuration of a body section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectioncontent.html#cfn-quicksight-template-bodysectioncontent-layout

BodySectionDynamicCategoryDimensionConfigurationProperty

class CfnTemplatePropsMixin.BodySectionDynamicCategoryDimensionConfigurationProperty(*, column=None, limit=None, sort_by_metrics=None)

Bases: object

Describes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamiccategorydimensionconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

body_section_dynamic_category_dimension_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicCategoryDimensionConfigurationProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    limit=123,
    sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
        aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        ),
        direction="direction",
        sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    )]
)

Attributes

column

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamiccategorydimensionconfiguration-column

Type:

see

limit

Number of values to use from the column for repetition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamiccategorydimensionconfiguration-limit

sort_by_metrics

Sort criteria on the column values that you use for repetition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamiccategorydimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamiccategorydimensionconfiguration-sortbymetrics

BodySectionDynamicNumericDimensionConfigurationProperty

class CfnTemplatePropsMixin.BodySectionDynamicNumericDimensionConfigurationProperty(*, column=None, limit=None, sort_by_metrics=None)

Bases: object

Describes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamicnumericdimensionconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

body_section_dynamic_numeric_dimension_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicNumericDimensionConfigurationProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    limit=123,
    sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
        aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        ),
        direction="direction",
        sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    )]
)

Attributes

column

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamicnumericdimensionconfiguration-column

Type:

see

limit

Number of values to use from the column for repetition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamicnumericdimensionconfiguration-limit

sort_by_metrics

Sort criteria on the column values that you use for repetition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectiondynamicnumericdimensionconfiguration.html#cfn-quicksight-template-bodysectiondynamicnumericdimensionconfiguration-sortbymetrics

BodySectionRepeatConfigurationProperty

class CfnTemplatePropsMixin.BodySectionRepeatConfigurationProperty(*, dimension_configurations=None, non_repeating_visuals=None, page_break_configuration=None)

Bases: object

Describes the configurations that are required to declare a section as repeating.

Parameters:

  • dimension_configurations (Union[IResolvable, Sequence[Union[IResolvable, BodySectionRepeatDimensionConfigurationProperty, Dict[str, Any]]], None]) – List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.

  • non_repeating_visuals (Optional[Sequence[str]]) – List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.

  • page_break_configuration (Union[IResolvable, BodySectionRepeatPageBreakConfigurationProperty, Dict[str, Any], None]) – Page break configuration to apply for each repeating instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

body_section_repeat_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatConfigurationProperty(
    dimension_configurations=[quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatDimensionConfigurationProperty(
        dynamic_category_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicCategoryDimensionConfigurationProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            limit=123,
            sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                    attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                        simple_attribute_aggregation="simpleAttributeAggregation",
                        value_for_multiple_values="valueForMultipleValues"
                    ),
                    categorical_aggregation_function="categoricalAggregationFunction",
                    date_aggregation_function="dateAggregationFunction",
                    numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                        percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                            percentile_value=123
                        ),
                        simple_numerical_aggregation="simpleNumericalAggregation"
                    )
                ),
                direction="direction",
                sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            )]
        ),
        dynamic_numeric_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicNumericDimensionConfigurationProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            limit=123,
            sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                    attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                        simple_attribute_aggregation="simpleAttributeAggregation",
                        value_for_multiple_values="valueForMultipleValues"
                    ),
                    categorical_aggregation_function="categoricalAggregationFunction",
                    date_aggregation_function="dateAggregationFunction",
                    numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                        percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                            percentile_value=123
                        ),
                        simple_numerical_aggregation="simpleNumericalAggregation"
                    )
                ),
                direction="direction",
                sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            )]
        )
    )],
    non_repeating_visuals=["nonRepeatingVisuals"],
    page_break_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatPageBreakConfigurationProperty(
        after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
            status="status"
        )
    )
)

Attributes

dimension_configurations

List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatconfiguration.html#cfn-quicksight-template-bodysectionrepeatconfiguration-dimensionconfigurations

non_repeating_visuals

List of visuals to exclude from repetition in repeating sections.

The visuals will render identically, and ignore the repeating configurations in all repeating instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatconfiguration.html#cfn-quicksight-template-bodysectionrepeatconfiguration-nonrepeatingvisuals

page_break_configuration

Page break configuration to apply for each repeating instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatconfiguration.html#cfn-quicksight-template-bodysectionrepeatconfiguration-pagebreakconfiguration

BodySectionRepeatDimensionConfigurationProperty

class CfnTemplatePropsMixin.BodySectionRepeatDimensionConfigurationProperty(*, dynamic_category_dimension_configuration=None, dynamic_numeric_dimension_configuration=None)

Bases: object

Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section.

The dataset column is either Category or Numeric column configuration

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatdimensionconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

body_section_repeat_dimension_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatDimensionConfigurationProperty(
    dynamic_category_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicCategoryDimensionConfigurationProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        limit=123,
        sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        )]
    ),
    dynamic_numeric_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicNumericDimensionConfigurationProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        limit=123,
        sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        )]
    )
)

Attributes

dynamic_category_dimension_configuration

Describes the Category dataset column and constraints around the dynamic values that will be used in repeating the section contents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatdimensionconfiguration.html#cfn-quicksight-template-bodysectionrepeatdimensionconfiguration-dynamiccategorydimensionconfiguration

dynamic_numeric_dimension_configuration

Describes the Numeric dataset column and constraints around the dynamic values used to repeat the contents of a section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatdimensionconfiguration.html#cfn-quicksight-template-bodysectionrepeatdimensionconfiguration-dynamicnumericdimensionconfiguration

BodySectionRepeatPageBreakConfigurationProperty

class CfnTemplatePropsMixin.BodySectionRepeatPageBreakConfigurationProperty(*, after=None)

Bases: object

The page break configuration to apply for each repeating instance.

Parameters:

after (Union[IResolvable, SectionAfterPageBreakProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatpagebreakconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

body_section_repeat_page_break_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatPageBreakConfigurationProperty(
    after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
        status="status"
    )
)

Attributes

after

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-bodysectionrepeatpagebreakconfiguration.html#cfn-quicksight-template-bodysectionrepeatpagebreakconfiguration-after

Type:

see

BoxPlotAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.BoxPlotAggregatedFieldWellsProperty(*, group_by=None, values=None)

Bases: object

The aggregated field well for a box plot.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
group_by

The group by field well of a box plot chart.

Values are grouped based on group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotaggregatedfieldwells.html#cfn-quicksight-template-boxplotaggregatedfieldwells-groupby

values

The value field well of a box plot chart.

Values are aggregated based on group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotaggregatedfieldwells.html#cfn-quicksight-template-boxplotaggregatedfieldwells-values

BoxPlotChartConfigurationProperty

class CfnTemplatePropsMixin.BoxPlotChartConfigurationProperty(*, box_plot_options=None, category_axis=None, category_label_options=None, field_wells=None, interactions=None, legend=None, primary_y_axis_display_options=None, primary_y_axis_label_options=None, reference_lines=None, sort_configuration=None, tooltip=None, visual_palette=None)

Bases: object

The configuration of a BoxPlotVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
box_plot_options

The box plot chart options for a box plot visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-boxplotoptions

category_axis

The label display options (grid line, range, scale, axis step) of a box plot category.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-categoryaxis

category_label_options

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-categorylabeloptions

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-interactions

legend

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-legend

Type:

see

primary_y_axis_display_options

The label display options (grid line, range, scale, axis step) of a box plot category.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-primaryyaxisdisplayoptions

primary_y_axis_label_options

The label options (label text, label visibility and sort icon visibility) of a box plot value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-primaryyaxislabeloptions

reference_lines

The reference line setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-referencelines

sort_configuration

The sort configuration of a BoxPlotVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-sortconfiguration

tooltip

The tooltip display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-tooltip

visual_palette

The palette (chart color) display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotchartconfiguration.html#cfn-quicksight-template-boxplotchartconfiguration-visualpalette

BoxPlotFieldWellsProperty

class CfnTemplatePropsMixin.BoxPlotFieldWellsProperty(*, box_plot_aggregated_field_wells=None)

Bases: object

The field wells of a BoxPlotVisual .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

box_plot_aggregated_field_wells (Union[IResolvable, BoxPlotAggregatedFieldWellsProperty, Dict[str, Any], None]) – The aggregated field wells of a box plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
box_plot_aggregated_field_wells

The aggregated field wells of a box plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotfieldwells.html#cfn-quicksight-template-boxplotfieldwells-boxplotaggregatedfieldwells

BoxPlotOptionsProperty

class CfnTemplatePropsMixin.BoxPlotOptionsProperty(*, all_data_points_visibility=None, outlier_visibility=None, style_options=None)

Bases: object

The options of a box plot visual.

Parameters:

  • all_data_points_visibility (Optional[str]) – Determines the visibility of all data points of the box plot.

  • outlier_visibility (Optional[str]) – Determines the visibility of the outlier in a box plot.

  • style_options (Union[IResolvable, BoxPlotStyleOptionsProperty, Dict[str, Any], None]) – The style options of the box plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

box_plot_options_property = quicksight_mixins.CfnTemplatePropsMixin.BoxPlotOptionsProperty(
    all_data_points_visibility="allDataPointsVisibility",
    outlier_visibility="outlierVisibility",
    style_options=quicksight_mixins.CfnTemplatePropsMixin.BoxPlotStyleOptionsProperty(
        fill_style="fillStyle"
    )
)

Attributes

all_data_points_visibility

Determines the visibility of all data points of the box plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotoptions.html#cfn-quicksight-template-boxplotoptions-alldatapointsvisibility

outlier_visibility

Determines the visibility of the outlier in a box plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotoptions.html#cfn-quicksight-template-boxplotoptions-outliervisibility

style_options

The style options of the box plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotoptions.html#cfn-quicksight-template-boxplotoptions-styleoptions

BoxPlotSortConfigurationProperty

class CfnTemplatePropsMixin.BoxPlotSortConfigurationProperty(*, category_sort=None, pagination_configuration=None)

Bases: object

The sort configuration of a BoxPlotVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

box_plot_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.BoxPlotSortConfigurationProperty(
    category_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    pagination_configuration=quicksight_mixins.CfnTemplatePropsMixin.PaginationConfigurationProperty(
        page_number=123,
        page_size=123
    )
)

Attributes

category_sort

The sort configuration of a group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotsortconfiguration.html#cfn-quicksight-template-boxplotsortconfiguration-categorysort

pagination_configuration

The pagination configuration of a table visual or box plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotsortconfiguration.html#cfn-quicksight-template-boxplotsortconfiguration-paginationconfiguration

BoxPlotStyleOptionsProperty

class CfnTemplatePropsMixin.BoxPlotStyleOptionsProperty(*, fill_style=None)

Bases: object

The style options of the box plot.

Parameters:

fill_style (Optional[str]) – The fill styles (solid, transparent) of the box plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotstyleoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

box_plot_style_options_property = quicksight_mixins.CfnTemplatePropsMixin.BoxPlotStyleOptionsProperty(
    fill_style="fillStyle"
)

Attributes

fill_style

The fill styles (solid, transparent) of the box plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotstyleoptions.html#cfn-quicksight-template-boxplotstyleoptions-fillstyle

BoxPlotVisualProperty

class CfnTemplatePropsMixin.BoxPlotVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A box plot.

For more information, see Using box plots in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-boxplotvisual.html#cfn-quicksight-template-boxplotvisual-visualid

CalculatedFieldProperty

class CfnTemplatePropsMixin.CalculatedFieldProperty(*, data_set_identifier=None, expression=None, name=None)

Bases: object

The calculated field of an analysis.

Parameters:

  • data_set_identifier (Optional[str]) – The data set that is used in this calculated field.

  • expression (Optional[str]) – The expression of the calculated field.

  • name (Optional[str]) – The name of the calculated field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedfield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

calculated_field_property = quicksight_mixins.CfnTemplatePropsMixin.CalculatedFieldProperty(
    data_set_identifier="dataSetIdentifier",
    expression="expression",
    name="name"
)

Attributes

data_set_identifier

The data set that is used in this calculated field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedfield.html#cfn-quicksight-template-calculatedfield-datasetidentifier

expression

The expression of the calculated field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedfield.html#cfn-quicksight-template-calculatedfield-expression

name

The name of the calculated field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedfield.html#cfn-quicksight-template-calculatedfield-name

CalculatedMeasureFieldProperty

class CfnTemplatePropsMixin.CalculatedMeasureFieldProperty(*, expression=None, field_id=None)

Bases: object

The table calculation measure field for pivot tables.

Parameters:

  • expression (Optional[str]) – The expression in the table calculation.

  • field_id (Optional[str]) – The custom field ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedmeasurefield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

calculated_measure_field_property = quicksight_mixins.CfnTemplatePropsMixin.CalculatedMeasureFieldProperty(
    expression="expression",
    field_id="fieldId"
)

Attributes

expression

The expression in the table calculation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedmeasurefield.html#cfn-quicksight-template-calculatedmeasurefield-expression

field_id

The custom field ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-calculatedmeasurefield.html#cfn-quicksight-template-calculatedmeasurefield-fieldid

CascadingControlConfigurationProperty

class CfnTemplatePropsMixin.CascadingControlConfigurationProperty(*, source_controls=None)

Bases: object

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

Parameters:

source_controls (Union[IResolvable, Sequence[Union[IResolvable, CascadingControlSourceProperty, Dict[str, Any]]], None]) – A list of source controls that determine the values that are used in the current control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-cascadingcontrolconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

cascading_control_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
    source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
        column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        source_sheet_control_id="sourceSheetControlId"
    )]
)

Attributes

source_controls

A list of source controls that determine the values that are used in the current control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-cascadingcontrolconfiguration.html#cfn-quicksight-template-cascadingcontrolconfiguration-sourcecontrols

CascadingControlSourceProperty

class CfnTemplatePropsMixin.CascadingControlSourceProperty(*, column_to_match=None, source_sheet_control_id=None)

Bases: object

The source controls that are used in a CascadingControlConfiguration .

Parameters:

  • column_to_match (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column identifier that determines which column to look up for the source sheet control.

  • source_sheet_control_id (Optional[str]) – The source sheet control ID of a CascadingControlSource .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-cascadingcontrolsource.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

cascading_control_source_property = quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
    column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    source_sheet_control_id="sourceSheetControlId"
)

Attributes

column_to_match

The column identifier that determines which column to look up for the source sheet control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-cascadingcontrolsource.html#cfn-quicksight-template-cascadingcontrolsource-columntomatch

source_sheet_control_id

The source sheet control ID of a CascadingControlSource .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-cascadingcontrolsource.html#cfn-quicksight-template-cascadingcontrolsource-sourcesheetcontrolid

CategoricalDimensionFieldProperty

class CfnTemplatePropsMixin.CategoricalDimensionFieldProperty(*, column=None, field_id=None, format_configuration=None, hierarchy_id=None)

Bases: object

The dimension type field with categorical type columns..

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricaldimensionfield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

categorical_dimension_field_property = quicksight_mixins.CfnTemplatePropsMixin.CategoricalDimensionFieldProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",
    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    ),
    hierarchy_id="hierarchyId"
)

Attributes

column

The column that is used in the CategoricalDimensionField .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricaldimensionfield.html#cfn-quicksight-template-categoricaldimensionfield-column

field_id

The custom field ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricaldimensionfield.html#cfn-quicksight-template-categoricaldimensionfield-fieldid

format_configuration

The format configuration of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricaldimensionfield.html#cfn-quicksight-template-categoricaldimensionfield-formatconfiguration

hierarchy_id

The custom hierarchy ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricaldimensionfield.html#cfn-quicksight-template-categoricaldimensionfield-hierarchyid

CategoricalMeasureFieldProperty

class CfnTemplatePropsMixin.CategoricalMeasureFieldProperty(*, aggregation_function=None, column=None, field_id=None, format_configuration=None)

Bases: object

The measure type field with categorical type columns.

Parameters:

  • aggregation_function (Optional[str]) – The aggregation function of the measure field.

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that is used in the CategoricalMeasureField .

  • field_id (Optional[str]) – The custom field ID.

  • format_configuration (Union[IResolvable, StringFormatConfigurationProperty, Dict[str, Any], None]) – The format configuration of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

categorical_measure_field_property = quicksight_mixins.CfnTemplatePropsMixin.CategoricalMeasureFieldProperty(
    aggregation_function="aggregationFunction",
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",
    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    )
)

Attributes

aggregation_function

The aggregation function of the measure field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-aggregationfunction

column

The column that is used in the CategoricalMeasureField .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-column

field_id

The custom field ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-fieldid

format_configuration

The format configuration of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoricalmeasurefield.html#cfn-quicksight-template-categoricalmeasurefield-formatconfiguration

CategoryDrillDownFilterProperty

class CfnTemplatePropsMixin.CategoryDrillDownFilterProperty(*, category_values=None, column=None)

Bases: object

The category drill down filter.

Parameters:

  • category_values (Optional[Sequence[str]]) – A list of the string inputs that are the values of the category drill down filter.

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categorydrilldownfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

category_drill_down_filter_property = quicksight_mixins.CfnTemplatePropsMixin.CategoryDrillDownFilterProperty(
    category_values=["categoryValues"],
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    )
)

Attributes

category_values

A list of the string inputs that are the values of the category drill down filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categorydrilldownfilter.html#cfn-quicksight-template-categorydrilldownfilter-categoryvalues

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categorydrilldownfilter.html#cfn-quicksight-template-categorydrilldownfilter-column

CategoryFilterConfigurationProperty

class CfnTemplatePropsMixin.CategoryFilterConfigurationProperty(*, custom_filter_configuration=None, custom_filter_list_configuration=None, filter_list_configuration=None)

Bases: object

The configuration for a CategoryFilter .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

category_filter_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.CategoryFilterConfigurationProperty(
    custom_filter_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomFilterConfigurationProperty(
        category_value="categoryValue",
        match_operator="matchOperator",
        null_option="nullOption",
        parameter_name="parameterName",
        select_all_options="selectAllOptions"
    ),
    custom_filter_list_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomFilterListConfigurationProperty(
        category_values=["categoryValues"],
        match_operator="matchOperator",
        null_option="nullOption",
        select_all_options="selectAllOptions"
    ),
    filter_list_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterListConfigurationProperty(
        category_values=["categoryValues"],
        match_operator="matchOperator",
        null_option="nullOption",
        select_all_options="selectAllOptions"
    )
)

Attributes

custom_filter_configuration

A custom filter that filters based on a single value.

This filter can be partially matched.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-customfilterconfiguration

custom_filter_list_configuration

A list of custom filter values.

In the Quick Sight console, this filter type is called a custom filter list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-customfilterlistconfiguration

filter_list_configuration

A list of filter configurations.

In the Quick Sight console, this filter type is called a filter list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-filterlistconfiguration

CategoryFilterProperty

class CfnTemplatePropsMixin.CategoryFilterProperty(*, column=None, configuration=None, default_filter_control_configuration=None, filter_id=None)

Bases: object

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

category_filter_property = quicksight_mixins.CfnTemplatePropsMixin.CategoryFilterProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    configuration=quicksight_mixins.CfnTemplatePropsMixin.CategoryFilterConfigurationProperty(
        custom_filter_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomFilterConfigurationProperty(
            category_value="categoryValue",
            match_operator="matchOperator",
            null_option="nullOption",
            parameter_name="parameterName",
            select_all_options="selectAllOptions"
        ),
        custom_filter_list_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomFilterListConfigurationProperty(
            category_values=["categoryValues"],
            match_operator="matchOperator",
            null_option="nullOption",
            select_all_options="selectAllOptions"
        ),
        filter_list_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterListConfigurationProperty(
            category_values=["categoryValues"],
            match_operator="matchOperator",
            null_option="nullOption",
            select_all_options="selectAllOptions"
        )
    ),
    default_filter_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
        control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                    date_icon_visibility=date_icon_visibility,
                    date_time_format="dateTimeFormat",
                    helper_text_visibility=helper_text_visibility,
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                maximum_value=123,
                minimum_value=123,
                step_size=123,
                type="type"
            ),
            default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    filter_id="filterId"
)

Attributes

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilter.html#cfn-quicksight-template-categoryfilter-column

configuration

The configuration for a CategoryFilter .

See:

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

default_filter_control_configuration

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilter.html#cfn-quicksight-template-categoryfilter-defaultfiltercontrolconfiguration

filter_id

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilter.html#cfn-quicksight-template-categoryfilter-filterid

CategoryInnerFilterProperty

class CfnTemplatePropsMixin.CategoryInnerFilterProperty(*, column=None, configuration=None, default_filter_control_configuration=None)

Bases: object

A CategoryInnerFilter filters text values for the NestedFilter .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryinnerfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

category_inner_filter_property = quicksight_mixins.CfnTemplatePropsMixin.CategoryInnerFilterProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    configuration=quicksight_mixins.CfnTemplatePropsMixin.CategoryFilterConfigurationProperty(
        custom_filter_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomFilterConfigurationProperty(
            category_value="categoryValue",
            match_operator="matchOperator",
            null_option="nullOption",
            parameter_name="parameterName",
            select_all_options="selectAllOptions"
        ),
        custom_filter_list_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomFilterListConfigurationProperty(
            category_values=["categoryValues"],
            match_operator="matchOperator",
            null_option="nullOption",
            select_all_options="selectAllOptions"
        ),
        filter_list_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterListConfigurationProperty(
            category_values=["categoryValues"],
            match_operator="matchOperator",
            null_option="nullOption",
            select_all_options="selectAllOptions"
        )
    ),
    default_filter_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
        control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                    date_icon_visibility=date_icon_visibility,
                    date_time_format="dateTimeFormat",
                    helper_text_visibility=helper_text_visibility,
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                maximum_value=123,
                minimum_value=123,
                step_size=123,
                type="type"
            ),
            default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    )
)

Attributes

column

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryinnerfilter.html#cfn-quicksight-template-categoryinnerfilter-column

Type:

see

configuration

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

Type:

see

default_filter_control_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryinnerfilter.html#cfn-quicksight-template-categoryinnerfilter-defaultfiltercontrolconfiguration

Type:

see

ChartAxisLabelOptionsProperty

class CfnTemplatePropsMixin.ChartAxisLabelOptionsProperty(*, axis_label_options=None, sort_icon_visibility=None, visibility=None)

Bases: object

The label options for an axis on a chart.

Parameters:

  • axis_label_options (Union[IResolvable, Sequence[Union[IResolvable, AxisLabelOptionsProperty, Dict[str, Any]]], None]) – The label options for a chart axis.

  • sort_icon_visibility (Optional[str]) – The visibility configuration of the sort icon on a chart’s axis label.

  • visibility (Optional[str]) – The visibility of an axis label on a chart. Choose one of the following options:. - VISIBLE : Shows the axis. - HIDDEN : Hides the axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-chartaxislabeloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

chart_axis_label_options_property = quicksight_mixins.CfnTemplatePropsMixin.ChartAxisLabelOptionsProperty(
    axis_label_options=[quicksight_mixins.CfnTemplatePropsMixin.AxisLabelOptionsProperty(
        apply_to=quicksight_mixins.CfnTemplatePropsMixin.AxisLabelReferenceOptionsProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId"
        ),
        custom_label="customLabel",
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        )
    )],
    sort_icon_visibility="sortIconVisibility",
    visibility="visibility"
)

Attributes

axis_label_options

The label options for a chart axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-chartaxislabeloptions.html#cfn-quicksight-template-chartaxislabeloptions-axislabeloptions

sort_icon_visibility

The visibility configuration of the sort icon on a chart’s axis label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-chartaxislabeloptions.html#cfn-quicksight-template-chartaxislabeloptions-sorticonvisibility

visibility

.

  • VISIBLE : Shows the axis.

  • HIDDEN : Hides the axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-chartaxislabeloptions.html#cfn-quicksight-template-chartaxislabeloptions-visibility

Type:

The visibility of an axis label on a chart. Choose one of the following options

ClusterMarkerConfigurationProperty

class CfnTemplatePropsMixin.ClusterMarkerConfigurationProperty(*, cluster_marker=None)

Bases: object

The cluster marker configuration of the geospatial map selected point style.

Parameters:

cluster_marker (Union[IResolvable, ClusterMarkerProperty, Dict[str, Any], None]) – The cluster marker that is a part of the cluster marker configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-clustermarkerconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

cluster_marker_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ClusterMarkerConfigurationProperty(
    cluster_marker=quicksight_mixins.CfnTemplatePropsMixin.ClusterMarkerProperty(
        simple_cluster_marker=quicksight_mixins.CfnTemplatePropsMixin.SimpleClusterMarkerProperty(
            color="color"
        )
    )
)

Attributes

cluster_marker

The cluster marker that is a part of the cluster marker configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-clustermarkerconfiguration.html#cfn-quicksight-template-clustermarkerconfiguration-clustermarker

ClusterMarkerProperty

class CfnTemplatePropsMixin.ClusterMarkerProperty(*, simple_cluster_marker=None)

Bases: object

The cluster marker that is a part of the cluster marker configuration.

Parameters:

simple_cluster_marker (Union[IResolvable, SimpleClusterMarkerProperty, Dict[str, Any], None]) – The simple cluster marker of the cluster marker.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-clustermarker.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

cluster_marker_property = quicksight_mixins.CfnTemplatePropsMixin.ClusterMarkerProperty(
    simple_cluster_marker=quicksight_mixins.CfnTemplatePropsMixin.SimpleClusterMarkerProperty(
        color="color"
    )
)

Attributes

simple_cluster_marker

The simple cluster marker of the cluster marker.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-clustermarker.html#cfn-quicksight-template-clustermarker-simpleclustermarker

ColorScaleProperty

class CfnTemplatePropsMixin.ColorScaleProperty(*, color_fill_type=None, colors=None, null_value_color=None)

Bases: object

Determines the color scale that is applied to the visual.

Parameters:

  • color_fill_type (Optional[str]) – Determines the color fill type.

  • colors (Union[IResolvable, Sequence[Union[IResolvable, DataColorProperty, Dict[str, Any]]], None]) – Determines the list of colors that are applied to the visual.

  • null_value_color (Union[IResolvable, DataColorProperty, Dict[str, Any], None]) – Determines the color that is applied to null values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorscale.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

color_scale_property = quicksight_mixins.CfnTemplatePropsMixin.ColorScaleProperty(
    color_fill_type="colorFillType",
    colors=[quicksight_mixins.CfnTemplatePropsMixin.DataColorProperty(
        color="color",
        data_value=123
    )],
    null_value_color=quicksight_mixins.CfnTemplatePropsMixin.DataColorProperty(
        color="color",
        data_value=123
    )
)

Attributes

color_fill_type

Determines the color fill type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorscale.html#cfn-quicksight-template-colorscale-colorfilltype

colors

Determines the list of colors that are applied to the visual.

See:

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

null_value_color

Determines the color that is applied to null values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorscale.html#cfn-quicksight-template-colorscale-nullvaluecolor

ColorsConfigurationProperty

class CfnTemplatePropsMixin.ColorsConfigurationProperty(*, custom_colors=None)

Bases: object

The color configurations for a column.

Parameters:

custom_colors (Union[IResolvable, Sequence[Union[IResolvable, CustomColorProperty, Dict[str, Any]]], None]) – A list of up to 50 custom colors.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorsconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

colors_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ColorsConfigurationProperty(
    custom_colors=[quicksight_mixins.CfnTemplatePropsMixin.CustomColorProperty(
        color="color",
        field_value="fieldValue",
        special_value="specialValue"
    )]
)

Attributes

custom_colors

A list of up to 50 custom colors.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-colorsconfiguration.html#cfn-quicksight-template-colorsconfiguration-customcolors

ColumnConfigurationProperty

class CfnTemplatePropsMixin.ColumnConfigurationProperty(*, colors_configuration=None, column=None, format_configuration=None, role=None)

Bases: object

The general configuration of a column.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

column_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ColumnConfigurationProperty(
    colors_configuration=quicksight_mixins.CfnTemplatePropsMixin.ColorsConfigurationProperty(
        custom_colors=[quicksight_mixins.CfnTemplatePropsMixin.CustomColorProperty(
            color="color",
            field_value="fieldValue",
            special_value="specialValue"
        )]
    ),
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.FormatConfigurationProperty(
        date_time_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
            date_time_format="dateTimeFormat",
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        number_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        string_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        )
    ),
    role="role"
)

Attributes

colors_configuration

The color configurations of the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-colorsconfiguration

column

The column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-column

format_configuration

The format configuration of a column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-formatconfiguration

role

The role of the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnconfiguration.html#cfn-quicksight-template-columnconfiguration-role

ColumnGroupColumnSchemaProperty

class CfnTemplatePropsMixin.ColumnGroupColumnSchemaProperty(*, name=None)

Bases: object

A structure describing the name, data type, and geographic role of the columns.

Parameters:

name (Optional[str]) – The name of the column group’s column schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupcolumnschema.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

column_group_column_schema_property = quicksight_mixins.CfnTemplatePropsMixin.ColumnGroupColumnSchemaProperty(
    name="name"
)

Attributes

name

The name of the column group’s column schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupcolumnschema.html#cfn-quicksight-template-columngroupcolumnschema-name

ColumnGroupSchemaProperty

class CfnTemplatePropsMixin.ColumnGroupSchemaProperty(*, column_group_column_schema_list=None, name=None)

Bases: object

The column group schema.

Parameters:

  • column_group_column_schema_list (Union[IResolvable, Sequence[Union[IResolvable, ColumnGroupColumnSchemaProperty, Dict[str, Any]]], None]) – A structure containing the list of schemas for column group columns.

  • name (Optional[str]) – The name of the column group schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

column_group_schema_property = quicksight_mixins.CfnTemplatePropsMixin.ColumnGroupSchemaProperty(
    column_group_column_schema_list=[quicksight_mixins.CfnTemplatePropsMixin.ColumnGroupColumnSchemaProperty(
        name="name"
    )],
    name="name"
)

Attributes

column_group_column_schema_list

A structure containing the list of schemas for column group columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html#cfn-quicksight-template-columngroupschema-columngroupcolumnschemalist

name

The name of the column group schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html#cfn-quicksight-template-columngroupschema-name

ColumnHierarchyProperty

class CfnTemplatePropsMixin.ColumnHierarchyProperty(*, date_time_hierarchy=None, explicit_hierarchy=None, predefined_hierarchy=None)

Bases: object

The option that determines the hierarchy of the fields for a visual element.

Parameters:

  • date_time_hierarchy (Union[IResolvable, DateTimeHierarchyProperty, Dict[str, Any], None]) – The option that determines the hierarchy of any DateTime fields.

  • explicit_hierarchy (Union[IResolvable, ExplicitHierarchyProperty, Dict[str, Any], None]) – The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

  • predefined_hierarchy (Union[IResolvable, PredefinedHierarchyProperty, Dict[str, Any], None]) – The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

column_hierarchy_property = quicksight_mixins.CfnTemplatePropsMixin.ColumnHierarchyProperty(
    date_time_hierarchy=quicksight_mixins.CfnTemplatePropsMixin.DateTimeHierarchyProperty(
        drill_down_filters=[quicksight_mixins.CfnTemplatePropsMixin.DrillDownFilterProperty(
            category_filter=quicksight_mixins.CfnTemplatePropsMixin.CategoryDrillDownFilterProperty(
                category_values=["categoryValues"],
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            numeric_equality_filter=quicksight_mixins.CfnTemplatePropsMixin.NumericEqualityDrillDownFilterProperty(
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                value=123
            ),
            time_range_filter=quicksight_mixins.CfnTemplatePropsMixin.TimeRangeDrillDownFilterProperty(
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                range_maximum="rangeMaximum",
                range_minimum="rangeMinimum",
                time_granularity="timeGranularity"
            )
        )],
        hierarchy_id="hierarchyId"
    ),
    explicit_hierarchy=quicksight_mixins.CfnTemplatePropsMixin.ExplicitHierarchyProperty(
        columns=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )],
        drill_down_filters=[quicksight_mixins.CfnTemplatePropsMixin.DrillDownFilterProperty(
            category_filter=quicksight_mixins.CfnTemplatePropsMixin.CategoryDrillDownFilterProperty(
                category_values=["categoryValues"],
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            numeric_equality_filter=quicksight_mixins.CfnTemplatePropsMixin.NumericEqualityDrillDownFilterProperty(
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                value=123
            ),
            time_range_filter=quicksight_mixins.CfnTemplatePropsMixin.TimeRangeDrillDownFilterProperty(
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                range_maximum="rangeMaximum",
                range_minimum="rangeMinimum",
                time_granularity="timeGranularity"
            )
        )],
        hierarchy_id="hierarchyId"
    ),
    predefined_hierarchy=quicksight_mixins.CfnTemplatePropsMixin.PredefinedHierarchyProperty(
        columns=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )],
        drill_down_filters=[quicksight_mixins.CfnTemplatePropsMixin.DrillDownFilterProperty(
            category_filter=quicksight_mixins.CfnTemplatePropsMixin.CategoryDrillDownFilterProperty(
                category_values=["categoryValues"],
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            numeric_equality_filter=quicksight_mixins.CfnTemplatePropsMixin.NumericEqualityDrillDownFilterProperty(
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                value=123
            ),
            time_range_filter=quicksight_mixins.CfnTemplatePropsMixin.TimeRangeDrillDownFilterProperty(
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                range_maximum="rangeMaximum",
                range_minimum="rangeMinimum",
                time_granularity="timeGranularity"
            )
        )],
        hierarchy_id="hierarchyId"
    )
)

Attributes

date_time_hierarchy

The option that determines the hierarchy of any DateTime fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.html#cfn-quicksight-template-columnhierarchy-datetimehierarchy

explicit_hierarchy

The option that determines the hierarchy of the fields that are built within a visual’s field wells.

These fields can’t be duplicated to other visuals.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.html#cfn-quicksight-template-columnhierarchy-explicithierarchy

predefined_hierarchy

The option that determines the hierarchy of the fields that are defined during data preparation.

These fields are available to use in any analysis that uses the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.html#cfn-quicksight-template-columnhierarchy-predefinedhierarchy

ColumnIdentifierProperty

class CfnTemplatePropsMixin.ColumnIdentifierProperty(*, column_name=None, data_set_identifier=None)

Bases: object

A column of a data set.

Parameters:

  • column_name (Optional[str]) – The name of the column.

  • data_set_identifier (Optional[str]) – The data set that the column belongs to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnidentifier.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

column_identifier_property = quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
    column_name="columnName",
    data_set_identifier="dataSetIdentifier"
)

Attributes

column_name

The name of the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnidentifier.html#cfn-quicksight-template-columnidentifier-columnname

data_set_identifier

The data set that the column belongs to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnidentifier.html#cfn-quicksight-template-columnidentifier-datasetidentifier

ColumnSchemaProperty

class CfnTemplatePropsMixin.ColumnSchemaProperty(*, data_type=None, geographic_role=None, name=None)

Bases: object

The column schema.

Parameters:

  • data_type (Optional[str]) – The data type of the column schema.

  • geographic_role (Optional[str]) – The geographic role of the column schema.

  • name (Optional[str]) – The name of the column schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

column_schema_property = quicksight_mixins.CfnTemplatePropsMixin.ColumnSchemaProperty(
    data_type="dataType",
    geographic_role="geographicRole",
    name="name"
)

Attributes

data_type

The data type of the column schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html#cfn-quicksight-template-columnschema-datatype

geographic_role

The geographic role of the column schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html#cfn-quicksight-template-columnschema-geographicrole

name

The name of the column schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html#cfn-quicksight-template-columnschema-name

ColumnSortProperty

class CfnTemplatePropsMixin.ColumnSortProperty(*, aggregation_function=None, direction=None, sort_by=None)

Bases: object

The sort configuration for a column that is not used in a field well.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnsort.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

column_sort_property = quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
    aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    ),
    direction="direction",
    sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    )
)

Attributes

aggregation_function

The aggregation function that is defined in the column sort.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnsort.html#cfn-quicksight-template-columnsort-aggregationfunction

direction

The sort direction.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnsort.html#cfn-quicksight-template-columnsort-direction

sort_by

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnsort.html#cfn-quicksight-template-columnsort-sortby

Type:

see

ColumnTooltipItemProperty

class CfnTemplatePropsMixin.ColumnTooltipItemProperty(*, aggregation=None, column=None, label=None, tooltip_target=None, visibility=None)

Bases: object

The tooltip item for the columns that are not part of a field well.

Parameters:

  • aggregation (Union[IResolvable, AggregationFunctionProperty, Dict[str, Any], None]) – The aggregation function of the column tooltip item.

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The target column of the tooltip item.

  • label (Optional[str]) – The label of the tooltip item.

  • tooltip_target (Optional[str]) – Determines the target of the column tooltip item in a combo chart visual.

  • visibility (Optional[str]) – The visibility of the tooltip item.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

column_tooltip_item_property = quicksight_mixins.CfnTemplatePropsMixin.ColumnTooltipItemProperty(
    aggregation=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    ),
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    label="label",
    tooltip_target="tooltipTarget",
    visibility="visibility"
)

Attributes

aggregation

The aggregation function of the column tooltip item.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html#cfn-quicksight-template-columntooltipitem-aggregation

column

The target column of the tooltip item.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html#cfn-quicksight-template-columntooltipitem-column

label

The label of the tooltip item.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html#cfn-quicksight-template-columntooltipitem-label

tooltip_target

Determines the target of the column tooltip item in a combo chart visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html#cfn-quicksight-template-columntooltipitem-tooltiptarget

visibility

The visibility of the tooltip item.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columntooltipitem.html#cfn-quicksight-template-columntooltipitem-visibility

ComboChartAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.ComboChartAggregatedFieldWellsProperty(*, bar_values=None, category=None, colors=None, line_values=None)

Bases: object

The aggregated field wells of a combo chart.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
bar_values

The aggregated BarValues field well of a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartaggregatedfieldwells.html#cfn-quicksight-template-combochartaggregatedfieldwells-barvalues

category

The aggregated category field wells of a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartaggregatedfieldwells.html#cfn-quicksight-template-combochartaggregatedfieldwells-category

colors

The aggregated colors field well of a combo chart.

See:

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

line_values

The aggregated LineValues field well of a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartaggregatedfieldwells.html#cfn-quicksight-template-combochartaggregatedfieldwells-linevalues

ComboChartConfigurationProperty

class CfnTemplatePropsMixin.ComboChartConfigurationProperty(*, bar_data_labels=None, bars_arrangement=None, category_axis=None, category_label_options=None, color_label_options=None, field_wells=None, interactions=None, legend=None, line_data_labels=None, primary_y_axis_display_options=None, primary_y_axis_label_options=None, reference_lines=None, secondary_y_axis_display_options=None, secondary_y_axis_label_options=None, single_axis_options=None, sort_configuration=None, tooltip=None, visual_palette=None)

Bases: object

The configuration of a ComboChartVisual .

Parameters:

  • bar_data_labels (Union[IResolvable, DataLabelOptionsProperty, Dict[str, Any], None]) – The options that determine if visual data labels are displayed. The data label options for a bar in a combo chart.

  • bars_arrangement (Optional[str]) – Determines the bar arrangement in a combo chart. The following are valid values in this structure:. - CLUSTERED : For clustered bar combo charts. - STACKED : For stacked bar combo charts. - STACKED_PERCENT : Do not use. If you use this value, the operation returns a validation error.

  • category_axis (Union[IResolvable, AxisDisplayOptionsProperty, Dict[str, Any], None]) – The category axis of a combo chart.

  • category_label_options (Union[IResolvable, ChartAxisLabelOptionsProperty, Dict[str, Any], None]) – The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

  • color_label_options (Union[IResolvable, ChartAxisLabelOptionsProperty, Dict[str, Any], None]) – The label options (label text, label visibility, and sort icon visibility) of a combo chart’s color field well.

  • field_wells (Union[IResolvable, ComboChartFieldWellsProperty, Dict[str, Any], None]) – The field wells of the visual.

  • interactions (Union[IResolvable, VisualInteractionOptionsProperty, Dict[str, Any], None]) – The general visual interactions setup for a visual.

  • legend (Union[IResolvable, LegendOptionsProperty, Dict[str, Any], None]) – The legend display setup of the visual.

  • line_data_labels (Union[IResolvable, DataLabelOptionsProperty, Dict[str, Any], None]) – The options that determine if visual data labels are displayed. The data label options for a line in a combo chart.

  • primary_y_axis_display_options (Union[IResolvable, AxisDisplayOptionsProperty, Dict[str, Any], None]) – The label display options (grid line, range, scale, and axis step) of a combo chart’s primary y-axis (bar) field well.

  • primary_y_axis_label_options (Union[IResolvable, ChartAxisLabelOptionsProperty, Dict[str, Any], None]) – The label options (label text, label visibility, and sort icon visibility) of a combo chart’s primary y-axis (bar) field well.

  • reference_lines (Union[IResolvable, Sequence[Union[IResolvable, ReferenceLineProperty, Dict[str, Any]]], None]) – The reference line setup of the visual.

  • secondary_y_axis_display_options (Union[IResolvable, AxisDisplayOptionsProperty, Dict[str, Any], None]) – The label display options (grid line, range, scale, axis step) of a combo chart’s secondary y-axis (line) field well.

  • secondary_y_axis_label_options (Union[IResolvable, ChartAxisLabelOptionsProperty, Dict[str, Any], None]) – The label options (label text, label visibility, and sort icon visibility) of a combo chart’s secondary y-axis(line) field well.

  • single_axis_options (Union[IResolvable, SingleAxisOptionsProperty, Dict[str, Any], None])

  • sort_configuration (Union[IResolvable, ComboChartSortConfigurationProperty, Dict[str, Any], None]) – The sort configuration of a ComboChartVisual .

  • tooltip (Union[IResolvable, TooltipOptionsProperty, Dict[str, Any], None]) – The legend display setup of the visual.

  • visual_palette (Union[IResolvable, VisualPaletteProperty, Dict[str, Any], None]) – The palette (chart color) display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
bar_data_labels

The options that determine if visual data labels are displayed.

The data label options for a bar in a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-bardatalabels

bars_arrangement

.

  • CLUSTERED : For clustered bar combo charts.

  • STACKED : For stacked bar combo charts.

  • STACKED_PERCENT : Do not use. If you use this value, the operation returns a validation error.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-barsarrangement

Type:

Determines the bar arrangement in a combo chart. The following are valid values in this structure

category_axis

The category axis of a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-categoryaxis

category_label_options

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-categorylabeloptions

color_label_options

The label options (label text, label visibility, and sort icon visibility) of a combo chart’s color field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-colorlabeloptions

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-interactions

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-legend

line_data_labels

The options that determine if visual data labels are displayed.

The data label options for a line in a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-linedatalabels

primary_y_axis_display_options

The label display options (grid line, range, scale, and axis step) of a combo chart’s primary y-axis (bar) field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-primaryyaxisdisplayoptions

primary_y_axis_label_options

The label options (label text, label visibility, and sort icon visibility) of a combo chart’s primary y-axis (bar) field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-primaryyaxislabeloptions

reference_lines

The reference line setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-referencelines

secondary_y_axis_display_options

The label display options (grid line, range, scale, axis step) of a combo chart’s secondary y-axis (line) field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-secondaryyaxisdisplayoptions

secondary_y_axis_label_options

The label options (label text, label visibility, and sort icon visibility) of a combo chart’s secondary y-axis(line) field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-secondaryyaxislabeloptions

single_axis_options

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-singleaxisoptions

Type:

see

sort_configuration

The sort configuration of a ComboChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-sortconfiguration

tooltip

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-tooltip

visual_palette

The palette (chart color) display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartconfiguration.html#cfn-quicksight-template-combochartconfiguration-visualpalette

ComboChartFieldWellsProperty

class CfnTemplatePropsMixin.ComboChartFieldWellsProperty(*, combo_chart_aggregated_field_wells=None)

Bases: object

The field wells of the visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

combo_chart_aggregated_field_wells (Union[IResolvable, ComboChartAggregatedFieldWellsProperty, Dict[str, Any], None]) – The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
combo_chart_aggregated_field_wells

The aggregated field wells of a combo chart.

Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartfieldwells.html#cfn-quicksight-template-combochartfieldwells-combochartaggregatedfieldwells

ComboChartSortConfigurationProperty

class CfnTemplatePropsMixin.ComboChartSortConfigurationProperty(*, category_items_limit=None, category_sort=None, color_items_limit=None, color_sort=None)

Bases: object

The sort configuration of a ComboChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

combo_chart_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ComboChartSortConfigurationProperty(
    category_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    color_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    color_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

category_items_limit

The item limit configuration for the category field well of a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartsortconfiguration.html#cfn-quicksight-template-combochartsortconfiguration-categoryitemslimit

category_sort

The sort configuration of the category field well in a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartsortconfiguration.html#cfn-quicksight-template-combochartsortconfiguration-categorysort

color_items_limit

The item limit configuration of the color field well in a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartsortconfiguration.html#cfn-quicksight-template-combochartsortconfiguration-coloritemslimit

color_sort

The sort configuration of the color field well in a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartsortconfiguration.html#cfn-quicksight-template-combochartsortconfiguration-colorsort

ComboChartVisualProperty

class CfnTemplatePropsMixin.ComboChartVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A combo chart.

The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts

For more information, see Using combo charts in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-combochartvisual.html#cfn-quicksight-template-combochartvisual-visualid

ComparisonConfigurationProperty

class CfnTemplatePropsMixin.ComparisonConfigurationProperty(*, comparison_format=None, comparison_method=None)

Bases: object

The comparison display configuration of a KPI or gauge chart.

Parameters:

  • comparison_format (Union[IResolvable, ComparisonFormatConfigurationProperty, Dict[str, Any], None]) – The format of the comparison.

  • comparison_method (Optional[str]) – The method of the comparison. Choose from the following options:. - DIFFERENCE - PERCENT_DIFFERENCE - PERCENT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

comparison_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ComparisonConfigurationProperty(
    comparison_format=quicksight_mixins.CfnTemplatePropsMixin.ComparisonFormatConfigurationProperty(
        number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        )
    ),
    comparison_method="comparisonMethod"
)

Attributes

comparison_format

The format of the comparison.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonconfiguration.html#cfn-quicksight-template-comparisonconfiguration-comparisonformat

comparison_method

.

  • DIFFERENCE

  • PERCENT_DIFFERENCE

  • PERCENT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonconfiguration.html#cfn-quicksight-template-comparisonconfiguration-comparisonmethod

Type:

The method of the comparison. Choose from the following options

ComparisonFormatConfigurationProperty

class CfnTemplatePropsMixin.ComparisonFormatConfigurationProperty(*, number_display_format_configuration=None, percentage_display_format_configuration=None)

Bases: object

The format of the comparison.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonformatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

comparison_format_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ComparisonFormatConfigurationProperty(
    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
            decimal_places=123
        ),
        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
            display_mode="displayMode"
        ),
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        number_scale="numberScale",
        prefix="prefix",
        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
            decimal_separator="decimalSeparator",
            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                grouping_style="groupingStyle",
                symbol="symbol",
                visibility="visibility"
            )
        ),
        suffix="suffix"
    ),
    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
            decimal_places=123
        ),
        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
            display_mode="displayMode"
        ),
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        prefix="prefix",
        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
            decimal_separator="decimalSeparator",
            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                grouping_style="groupingStyle",
                symbol="symbol",
                visibility="visibility"
            )
        ),
        suffix="suffix"
    )
)

Attributes

number_display_format_configuration

The number display format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonformatconfiguration.html#cfn-quicksight-template-comparisonformatconfiguration-numberdisplayformatconfiguration

percentage_display_format_configuration

The percentage display format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-comparisonformatconfiguration.html#cfn-quicksight-template-comparisonformatconfiguration-percentagedisplayformatconfiguration

ComputationProperty

class CfnTemplatePropsMixin.ComputationProperty(*, forecast=None, growth_rate=None, maximum_minimum=None, metric_comparison=None, period_over_period=None, period_to_date=None, top_bottom_movers=None, top_bottom_ranked=None, total_aggregation=None, unique_values=None)

Bases: object

The computation union that is used in an insight visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
forecast

The forecast computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-forecast

growth_rate

The growth rate computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-growthrate

maximum_minimum

The maximum and minimum computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-maximumminimum

metric_comparison

The metric comparison computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-metriccomparison

period_over_period

The period over period computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-periodoverperiod

period_to_date

The period to DataSetIdentifier computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-periodtodate

top_bottom_movers

The top movers and bottom movers computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-topbottommovers

top_bottom_ranked

The top ranked and bottom ranked computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-topbottomranked

total_aggregation

The total aggregation computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-totalaggregation

unique_values

The unique values computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-computation.html#cfn-quicksight-template-computation-uniquevalues

ConditionalFormattingColorProperty

class CfnTemplatePropsMixin.ConditionalFormattingColorProperty(*, gradient=None, solid=None)

Bases: object

The formatting configuration for the color.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcolor.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

conditional_formatting_color_property = quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
    gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
        color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
            stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                color="color",
                data_value=123,
                gradient_offset=123
            )]
        ),
        expression="expression"
    ),
    solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
        color="color",
        expression="expression"
    )
)

Attributes

gradient

Formatting configuration for gradient color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcolor.html#cfn-quicksight-template-conditionalformattingcolor-gradient

solid

Formatting configuration for solid color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcolor.html#cfn-quicksight-template-conditionalformattingcolor-solid

ConditionalFormattingCustomIconConditionProperty

class CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(*, color=None, display_configuration=None, expression=None, icon_options=None)

Bases: object

Determines the custom condition for an icon set.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconcondition.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

conditional_formatting_custom_icon_condition_property = quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
    color="color",
    display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
        icon_display_option="iconDisplayOption"
    ),
    expression="expression",
    icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
        icon="icon",
        unicode_icon="unicodeIcon"
    )
)

Attributes

color

Determines the color of the icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconcondition.html#cfn-quicksight-template-conditionalformattingcustomiconcondition-color

display_configuration

Determines the icon display configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconcondition.html#cfn-quicksight-template-conditionalformattingcustomiconcondition-displayconfiguration

expression

The expression that determines the condition of the icon set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconcondition.html#cfn-quicksight-template-conditionalformattingcustomiconcondition-expression

icon_options

Custom icon options for an icon set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconcondition.html#cfn-quicksight-template-conditionalformattingcustomiconcondition-iconoptions

ConditionalFormattingCustomIconOptionsProperty

class CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(*, icon=None, unicode_icon=None)

Bases: object

Custom icon options for an icon set.

Parameters:

  • icon (Optional[str]) – Determines the type of icon.

  • unicode_icon (Optional[str]) – Determines the Unicode icon type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

conditional_formatting_custom_icon_options_property = quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
    icon="icon",
    unicode_icon="unicodeIcon"
)

Attributes

icon

Determines the type of icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconoptions.html#cfn-quicksight-template-conditionalformattingcustomiconoptions-icon

unicode_icon

Determines the Unicode icon type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingcustomiconoptions.html#cfn-quicksight-template-conditionalformattingcustomiconoptions-unicodeicon

ConditionalFormattingGradientColorProperty

class CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(*, color=None, expression=None)

Bases: object

Formatting configuration for gradient color.

Parameters:

  • color (Union[IResolvable, GradientColorProperty, Dict[str, Any], None]) – Determines the color.

  • expression (Optional[str]) – The expression that determines the formatting configuration for gradient color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattinggradientcolor.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

conditional_formatting_gradient_color_property = quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
            color="color",
            data_value=123,
            gradient_offset=123
        )]
    ),
    expression="expression"
)

Attributes

color

Determines the color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattinggradientcolor.html#cfn-quicksight-template-conditionalformattinggradientcolor-color

expression

The expression that determines the formatting configuration for gradient color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattinggradientcolor.html#cfn-quicksight-template-conditionalformattinggradientcolor-expression

ConditionalFormattingIconDisplayConfigurationProperty

class CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(*, icon_display_option=None)

Bases: object

Determines the icon display configuration.

Parameters:

icon_display_option (Optional[str]) – Determines the icon display configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingicondisplayconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

conditional_formatting_icon_display_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
    icon_display_option="iconDisplayOption"
)

Attributes

icon_display_option

Determines the icon display configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingicondisplayconfiguration.html#cfn-quicksight-template-conditionalformattingicondisplayconfiguration-icondisplayoption

ConditionalFormattingIconProperty

class CfnTemplatePropsMixin.ConditionalFormattingIconProperty(*, custom_condition=None, icon_set=None)

Bases: object

The formatting configuration for the icon.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingicon.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

conditional_formatting_icon_property = quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
    custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
        color="color",
        display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
            icon_display_option="iconDisplayOption"
        ),
        expression="expression",
        icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
            icon="icon",
            unicode_icon="unicodeIcon"
        )
    ),
    icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
        expression="expression",
        icon_set_type="iconSetType"
    )
)

Attributes

custom_condition

Determines the custom condition for an icon set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingicon.html#cfn-quicksight-template-conditionalformattingicon-customcondition

icon_set

Formatting configuration for icon set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingicon.html#cfn-quicksight-template-conditionalformattingicon-iconset

ConditionalFormattingIconSetProperty

class CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(*, expression=None, icon_set_type=None)

Bases: object

Formatting configuration for icon set.

Parameters:

  • expression (Optional[str]) – The expression that determines the formatting configuration for the icon set.

  • icon_set_type (Optional[str]) – Determines the icon set type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingiconset.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

conditional_formatting_icon_set_property = quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
    expression="expression",
    icon_set_type="iconSetType"
)

Attributes

expression

The expression that determines the formatting configuration for the icon set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingiconset.html#cfn-quicksight-template-conditionalformattingiconset-expression

icon_set_type

Determines the icon set type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingiconset.html#cfn-quicksight-template-conditionalformattingiconset-iconsettype

ConditionalFormattingSolidColorProperty

class CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(*, color=None, expression=None)

Bases: object

Formatting configuration for solid color.

Parameters:

  • color (Optional[str]) – Determines the color.

  • expression (Optional[str]) – The expression that determines the formatting configuration for solid color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingsolidcolor.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

conditional_formatting_solid_color_property = quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
    color="color",
    expression="expression"
)

Attributes

color

Determines the color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingsolidcolor.html#cfn-quicksight-template-conditionalformattingsolidcolor-color

expression

The expression that determines the formatting configuration for solid color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-conditionalformattingsolidcolor.html#cfn-quicksight-template-conditionalformattingsolidcolor-expression

ContextMenuOptionProperty

class CfnTemplatePropsMixin.ContextMenuOptionProperty(*, availability_status=None)

Bases: object

The context menu options for a visual’s interactions.

Parameters:

availability_status (Optional[str]) – The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-contextmenuoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

context_menu_option_property = quicksight_mixins.CfnTemplatePropsMixin.ContextMenuOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

The availability status of the context menu options.

If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-contextmenuoption.html#cfn-quicksight-template-contextmenuoption-availabilitystatus

ContributionAnalysisDefaultProperty

class CfnTemplatePropsMixin.ContributionAnalysisDefaultProperty(*, contributor_dimensions=None, measure_field_id=None)

Bases: object

The contribution analysis visual display for a line, pie, or bar chart.

Parameters:

  • contributor_dimensions (Union[IResolvable, Sequence[Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any]]], None]) – The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .

  • measure_field_id (Optional[str]) – The measure field that is used in the contribution analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-contributionanalysisdefault.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

contribution_analysis_default_property = quicksight_mixins.CfnTemplatePropsMixin.ContributionAnalysisDefaultProperty(
    contributor_dimensions=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    )],
    measure_field_id="measureFieldId"
)

Attributes

contributor_dimensions

The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-contributionanalysisdefault.html#cfn-quicksight-template-contributionanalysisdefault-contributordimensions

measure_field_id

The measure field that is used in the contribution analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-contributionanalysisdefault.html#cfn-quicksight-template-contributionanalysisdefault-measurefieldid

CurrencyDisplayFormatConfigurationProperty

class CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(*, decimal_places_configuration=None, negative_value_configuration=None, null_value_format_configuration=None, number_scale=None, prefix=None, separator_configuration=None, suffix=None, symbol=None)

Bases: object

The options that determine the currency display format configuration.

Parameters:

  • decimal_places_configuration (Union[IResolvable, DecimalPlacesConfigurationProperty, Dict[str, Any], None]) – The option that determines the decimal places configuration.

  • negative_value_configuration (Union[IResolvable, NegativeValueConfigurationProperty, Dict[str, Any], None]) – The options that determine the negative value configuration.

  • null_value_format_configuration (Union[IResolvable, NullValueFormatConfigurationProperty, Dict[str, Any], None]) – The options that determine the null value format configuration.

  • number_scale (Optional[str]) – Determines the number scale value for the currency format.

  • prefix (Optional[str]) – Determines the prefix value of the currency format.

  • separator_configuration (Union[IResolvable, NumericSeparatorConfigurationProperty, Dict[str, Any], None]) – The options that determine the numeric separator configuration.

  • suffix (Optional[str]) – Determines the suffix value of the currency format.

  • symbol (Optional[str]) – Determines the symbol for the currency format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

currency_display_format_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
        decimal_places=123
    ),
    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
        display_mode="displayMode"
    ),
    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    number_scale="numberScale",
    prefix="prefix",
    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
        decimal_separator="decimalSeparator",
        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
            grouping_style="groupingStyle",
            symbol="symbol",
            visibility="visibility"
        )
    ),
    suffix="suffix",
    symbol="symbol"
)

Attributes

decimal_places_configuration

The option that determines the decimal places configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-decimalplacesconfiguration

negative_value_configuration

The options that determine the negative value configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-negativevalueconfiguration

null_value_format_configuration

The options that determine the null value format configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-nullvalueformatconfiguration

number_scale

Determines the number scale value for the currency format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-numberscale

prefix

Determines the prefix value of the currency format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-prefix

separator_configuration

The options that determine the numeric separator configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-separatorconfiguration

suffix

Determines the suffix value of the currency format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-suffix

symbol

Determines the symbol for the currency format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-currencydisplayformatconfiguration.html#cfn-quicksight-template-currencydisplayformatconfiguration-symbol

CustomActionFilterOperationProperty

class CfnTemplatePropsMixin.CustomActionFilterOperationProperty(*, selected_fields_configuration=None, target_visuals_configuration=None)

Bases: object

The filter operation that filters data included in a visual or in an entire sheet.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionfilteroperation.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_action_filter_operation_property = quicksight_mixins.CfnTemplatePropsMixin.CustomActionFilterOperationProperty(
    selected_fields_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterOperationSelectedFieldsConfigurationProperty(
        selected_columns=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )],
        selected_field_options="selectedFieldOptions",
        selected_fields=["selectedFields"]
    ),
    target_visuals_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterOperationTargetVisualsConfigurationProperty(
        same_sheet_target_visual_configuration=quicksight_mixins.CfnTemplatePropsMixin.SameSheetTargetVisualConfigurationProperty(
            target_visual_options="targetVisualOptions",
            target_visuals=["targetVisuals"]
        )
    )
)

Attributes

selected_fields_configuration

The configuration that chooses the fields to be filtered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionfilteroperation.html#cfn-quicksight-template-customactionfilteroperation-selectedfieldsconfiguration

target_visuals_configuration

The configuration that chooses the target visuals to be filtered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionfilteroperation.html#cfn-quicksight-template-customactionfilteroperation-targetvisualsconfiguration

CustomActionNavigationOperationProperty

class CfnTemplatePropsMixin.CustomActionNavigationOperationProperty(*, local_navigation_configuration=None)

Bases: object

The navigation operation that navigates between different sheets in the same analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

local_navigation_configuration (Union[IResolvable, LocalNavigationConfigurationProperty, Dict[str, Any], None]) – The configuration that chooses the navigation target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionnavigationoperation.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_action_navigation_operation_property = quicksight_mixins.CfnTemplatePropsMixin.CustomActionNavigationOperationProperty(
    local_navigation_configuration=quicksight_mixins.CfnTemplatePropsMixin.LocalNavigationConfigurationProperty(
        target_sheet_id="targetSheetId"
    )
)

Attributes

local_navigation_configuration

The configuration that chooses the navigation target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionnavigationoperation.html#cfn-quicksight-template-customactionnavigationoperation-localnavigationconfiguration

CustomActionSetParametersOperationProperty

class CfnTemplatePropsMixin.CustomActionSetParametersOperationProperty(*, parameter_value_configurations=None)

Bases: object

The set parameter operation that sets parameters in custom action.

Parameters:

parameter_value_configurations (Union[IResolvable, Sequence[Union[IResolvable, SetParameterValueConfigurationProperty, Dict[str, Any]]], None]) – The parameter that determines the value configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionsetparametersoperation.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_action_set_parameters_operation_property = quicksight_mixins.CfnTemplatePropsMixin.CustomActionSetParametersOperationProperty(
    parameter_value_configurations=[quicksight_mixins.CfnTemplatePropsMixin.SetParameterValueConfigurationProperty(
        destination_parameter_name="destinationParameterName",
        value=quicksight_mixins.CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(
            custom_values_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
                custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
                    date_time_values=["dateTimeValues"],
                    decimal_values=[123],
                    integer_values=[123],
                    string_values=["stringValues"]
                ),
                include_null_value=False
            ),
            select_all_value_options="selectAllValueOptions",
            source_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_field="sourceField",
            source_parameter_name="sourceParameterName"
        )
    )]
)

Attributes

parameter_value_configurations

The parameter that determines the value configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionsetparametersoperation.html#cfn-quicksight-template-customactionsetparametersoperation-parametervalueconfigurations

CustomActionURLOperationProperty

class CfnTemplatePropsMixin.CustomActionURLOperationProperty(*, url_target=None, url_template=None)

Bases: object

The URL operation that opens a link to another webpage.

Parameters:

  • url_target (Optional[str]) – The target of the CustomActionURLOperation . Valid values are defined as follows: - NEW_TAB : Opens the target URL in a new browser tab. - NEW_WINDOW : Opens the target URL in a new browser window. - SAME_TAB : Opens the target URL in the same browser tab.

  • url_template (Optional[str]) – THe URL link of the CustomActionURLOperation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionurloperation.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_action_uRLOperation_property = quicksight_mixins.CfnTemplatePropsMixin.CustomActionURLOperationProperty(
    url_target="urlTarget",
    url_template="urlTemplate"
)

Attributes

url_target

The target of the CustomActionURLOperation .

Valid values are defined as follows:

  • NEW_TAB : Opens the target URL in a new browser tab.

  • NEW_WINDOW : Opens the target URL in a new browser window.

  • SAME_TAB : Opens the target URL in the same browser tab.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionurloperation.html#cfn-quicksight-template-customactionurloperation-urltarget

url_template

THe URL link of the CustomActionURLOperation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customactionurloperation.html#cfn-quicksight-template-customactionurloperation-urltemplate

CustomColorProperty

class CfnTemplatePropsMixin.CustomColorProperty(*, color=None, field_value=None, special_value=None)

Bases: object

Determines the color that’s applied to a particular data value in a column.

Parameters:

  • color (Optional[str]) – The color that is applied to the data value.

  • field_value (Optional[str]) – The data value that the color is applied to.

  • special_value (Optional[str]) – The value of a special data value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcolor.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_color_property = quicksight_mixins.CfnTemplatePropsMixin.CustomColorProperty(
    color="color",
    field_value="fieldValue",
    special_value="specialValue"
)

Attributes

color

The color that is applied to the data value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcolor.html#cfn-quicksight-template-customcolor-color

field_value

The data value that the color is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcolor.html#cfn-quicksight-template-customcolor-fieldvalue

special_value

The value of a special data value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcolor.html#cfn-quicksight-template-customcolor-specialvalue

CustomContentConfigurationProperty

class CfnTemplatePropsMixin.CustomContentConfigurationProperty(*, content_type=None, content_url=None, image_scaling=None, interactions=None)

Bases: object

The configuration of a CustomContentVisual .

Parameters:

  • content_type (Optional[str]) – The content type of the custom content visual. You can use this to have the visual render as an image.

  • content_url (Optional[str]) – The input URL that links to the custom content that you want in the custom visual.

  • image_scaling (Optional[str]) – The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE' .

  • interactions (Union[IResolvable, VisualInteractionOptionsProperty, Dict[str, Any], None]) – The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_content_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.CustomContentConfigurationProperty(
    content_type="contentType",
    content_url="contentUrl",
    image_scaling="imageScaling",
    interactions=quicksight_mixins.CfnTemplatePropsMixin.VisualInteractionOptionsProperty(
        context_menu_option=quicksight_mixins.CfnTemplatePropsMixin.ContextMenuOptionProperty(
            availability_status="availabilityStatus"
        ),
        visual_menu_option=quicksight_mixins.CfnTemplatePropsMixin.VisualMenuOptionProperty(
            availability_status="availabilityStatus"
        )
    )
)

Attributes

content_type

The content type of the custom content visual.

You can use this to have the visual render as an image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-contenttype

content_url

The input URL that links to the custom content that you want in the custom visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-contenturl

image_scaling

The sizing options for the size of the custom content visual.

This structure is required when the ContentType of the visual is 'IMAGE' .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-imagescaling

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-interactions

CustomContentVisualProperty

class CfnTemplatePropsMixin.CustomContentVisualProperty(*, actions=None, chart_configuration=None, data_set_identifier=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon Quick Suite User Guide .

Parameters:

  • actions (Union[IResolvable, Sequence[Union[IResolvable, VisualCustomActionProperty, Dict[str, Any]]], None]) – The list of custom actions that are configured for a visual.

  • chart_configuration (Union[IResolvable, CustomContentConfigurationProperty, Dict[str, Any], None]) – The configuration of a CustomContentVisual .

  • data_set_identifier (Optional[str]) – The dataset that is used to create the custom content visual. You can’t create a visual without a dataset.

  • subtitle (Union[IResolvable, VisualSubtitleLabelOptionsProperty, Dict[str, Any], None]) – The subtitle that is displayed on the visual.

  • title (Union[IResolvable, VisualTitleLabelOptionsProperty, Dict[str, Any], None]) – The title that is displayed on the visual.

  • visual_content_alt_text (Optional[str]) – The alt text for the visual.

  • visual_id (Optional[str]) – The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_content_visual_property = quicksight_mixins.CfnTemplatePropsMixin.CustomContentVisualProperty(
    actions=[quicksight_mixins.CfnTemplatePropsMixin.VisualCustomActionProperty(
        action_operations=[quicksight_mixins.CfnTemplatePropsMixin.VisualCustomActionOperationProperty(
            filter_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionFilterOperationProperty(
                selected_fields_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterOperationSelectedFieldsConfigurationProperty(
                    selected_columns=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    )],
                    selected_field_options="selectedFieldOptions",
                    selected_fields=["selectedFields"]
                ),
                target_visuals_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterOperationTargetVisualsConfigurationProperty(
                    same_sheet_target_visual_configuration=quicksight_mixins.CfnTemplatePropsMixin.SameSheetTargetVisualConfigurationProperty(
                        target_visual_options="targetVisualOptions",
                        target_visuals=["targetVisuals"]
                    )
                )
            ),
            navigation_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionNavigationOperationProperty(
                local_navigation_configuration=quicksight_mixins.CfnTemplatePropsMixin.LocalNavigationConfigurationProperty(
                    target_sheet_id="targetSheetId"
                )
            ),
            set_parameters_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionSetParametersOperationProperty(
                parameter_value_configurations=[quicksight_mixins.CfnTemplatePropsMixin.SetParameterValueConfigurationProperty(
                    destination_parameter_name="destinationParameterName",
                    value=quicksight_mixins.CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(
                        custom_values_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
                            custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
                                date_time_values=["dateTimeValues"],
                                decimal_values=[123],
                                integer_values=[123],
                                string_values=["stringValues"]
                            ),
                            include_null_value=False
                        ),
                        select_all_value_options="selectAllValueOptions",
                        source_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                            column_name="columnName",
                            data_set_identifier="dataSetIdentifier"
                        ),
                        source_field="sourceField",
                        source_parameter_name="sourceParameterName"
                    )
                )]
            ),
            url_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionURLOperationProperty(
                url_target="urlTarget",
                url_template="urlTemplate"
            )
        )],
        custom_action_id="customActionId",
        name="name",
        status="status",
        trigger="trigger"
    )],
    chart_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomContentConfigurationProperty(
        content_type="contentType",
        content_url="contentUrl",
        image_scaling="imageScaling",
        interactions=quicksight_mixins.CfnTemplatePropsMixin.VisualInteractionOptionsProperty(
            context_menu_option=quicksight_mixins.CfnTemplatePropsMixin.ContextMenuOptionProperty(
                availability_status="availabilityStatus"
            ),
            visual_menu_option=quicksight_mixins.CfnTemplatePropsMixin.VisualMenuOptionProperty(
                availability_status="availabilityStatus"
            )
        )
    ),
    data_set_identifier="dataSetIdentifier",
    subtitle=quicksight_mixins.CfnTemplatePropsMixin.VisualSubtitleLabelOptionsProperty(
        format_text=quicksight_mixins.CfnTemplatePropsMixin.LongFormatTextProperty(
            plain_text="plainText",
            rich_text="richText"
        ),
        visibility="visibility"
    ),
    title=quicksight_mixins.CfnTemplatePropsMixin.VisualTitleLabelOptionsProperty(
        format_text=quicksight_mixins.CfnTemplatePropsMixin.ShortFormatTextProperty(
            plain_text="plainText",
            rich_text="richText"
        ),
        visibility="visibility"
    ),
    visual_content_alt_text="visualContentAltText",
    visual_id="visualId"
)

Attributes

actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration of a CustomContentVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-chartconfiguration

data_set_identifier

The dataset that is used to create the custom content visual.

You can’t create a visual without a dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-datasetidentifier

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentvisual.html#cfn-quicksight-template-customcontentvisual-visualid

CustomFilterConfigurationProperty

class CfnTemplatePropsMixin.CustomFilterConfigurationProperty(*, category_value=None, match_operator=None, null_option=None, parameter_name=None, select_all_options=None)

Bases: object

A custom filter that filters based on a single value.

This filter can be partially matched.

Parameters:

  • category_value (Optional[str]) – The category value for the filter. This field is mutually exclusive to ParameterName .

  • match_operator (Optional[str]) – The match operator that is used to determine if a filter should be applied.

  • null_option (Optional[str]) – This option determines how null values should be treated when filtering data. - ALL_VALUES : Include null values in filtered results. - NULLS_ONLY : Only include null values in filtered results. - NON_NULLS_ONLY : Exclude null values from filtered results.

  • parameter_name (Optional[str]) – The parameter whose value should be used for the filter value. This field is mutually exclusive to CategoryValue .

  • select_all_options (Optional[str]) – Select all of the values. Null is not the assigned value of select all. - FILTER_ALL_VALUES

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_filter_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.CustomFilterConfigurationProperty(
    category_value="categoryValue",
    match_operator="matchOperator",
    null_option="nullOption",
    parameter_name="parameterName",
    select_all_options="selectAllOptions"
)

Attributes

category_value

The category value for the filter.

This field is mutually exclusive to ParameterName .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html#cfn-quicksight-template-customfilterconfiguration-categoryvalue

match_operator

The match operator that is used to determine if a filter should be applied.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html#cfn-quicksight-template-customfilterconfiguration-matchoperator

null_option

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.

  • NULLS_ONLY : Only include null values in filtered results.

  • NON_NULLS_ONLY : Exclude null values from filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html#cfn-quicksight-template-customfilterconfiguration-nulloption

parameter_name

The parameter whose value should be used for the filter value.

This field is mutually exclusive to CategoryValue .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html#cfn-quicksight-template-customfilterconfiguration-parametername

select_all_options

Select all of the values. Null is not the assigned value of select all.

  • FILTER_ALL_VALUES

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterconfiguration.html#cfn-quicksight-template-customfilterconfiguration-selectalloptions

CustomFilterListConfigurationProperty

class CfnTemplatePropsMixin.CustomFilterListConfigurationProperty(*, category_values=None, match_operator=None, null_option=None, select_all_options=None)

Bases: object

A list of custom filter values.

Parameters:

  • category_values (Optional[Sequence[str]]) – The list of category values for the filter.

  • match_operator (Optional[str]) – The match operator that is used to determine if a filter should be applied.

  • null_option (Optional[str]) – This option determines how null values should be treated when filtering data. - ALL_VALUES : Include null values in filtered results. - NULLS_ONLY : Only include null values in filtered results. - NON_NULLS_ONLY : Exclude null values from filtered results.

  • select_all_options (Optional[str]) – Select all of the values. Null is not the assigned value of select all. - FILTER_ALL_VALUES

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterlistconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_filter_list_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.CustomFilterListConfigurationProperty(
    category_values=["categoryValues"],
    match_operator="matchOperator",
    null_option="nullOption",
    select_all_options="selectAllOptions"
)

Attributes

category_values

The list of category values for the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterlistconfiguration.html#cfn-quicksight-template-customfilterlistconfiguration-categoryvalues

match_operator

The match operator that is used to determine if a filter should be applied.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterlistconfiguration.html#cfn-quicksight-template-customfilterlistconfiguration-matchoperator

null_option

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.

  • NULLS_ONLY : Only include null values in filtered results.

  • NON_NULLS_ONLY : Exclude null values from filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterlistconfiguration.html#cfn-quicksight-template-customfilterlistconfiguration-nulloption

select_all_options

Select all of the values. Null is not the assigned value of select all.

  • FILTER_ALL_VALUES

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customfilterlistconfiguration.html#cfn-quicksight-template-customfilterlistconfiguration-selectalloptions

CustomNarrativeOptionsProperty

class CfnTemplatePropsMixin.CustomNarrativeOptionsProperty(*, narrative=None)

Bases: object

The custom narrative options.

Parameters:

narrative (Optional[str]) – The string input of custom narrative.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customnarrativeoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_narrative_options_property = quicksight_mixins.CfnTemplatePropsMixin.CustomNarrativeOptionsProperty(
    narrative="narrative"
)

Attributes

narrative

The string input of custom narrative.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customnarrativeoptions.html#cfn-quicksight-template-customnarrativeoptions-narrative

CustomParameterValuesProperty

class CfnTemplatePropsMixin.CustomParameterValuesProperty(*, date_time_values=None, decimal_values=None, integer_values=None, string_values=None)

Bases: object

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • date_time_values (Optional[Sequence[str]]) – A list of datetime-type parameter values.

  • decimal_values (Union[Sequence[Union[int, float]], IResolvable, None]) – A list of decimal-type parameter values.

  • integer_values (Union[Sequence[Union[int, float]], IResolvable, None]) – A list of integer-type parameter values.

  • string_values (Optional[Sequence[str]]) – A list of string-type parameter values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customparametervalues.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_parameter_values_property = quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
    date_time_values=["dateTimeValues"],
    decimal_values=[123],
    integer_values=[123],
    string_values=["stringValues"]
)

Attributes

date_time_values

A list of datetime-type parameter values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customparametervalues.html#cfn-quicksight-template-customparametervalues-datetimevalues

decimal_values

A list of decimal-type parameter values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customparametervalues.html#cfn-quicksight-template-customparametervalues-decimalvalues

integer_values

A list of integer-type parameter values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customparametervalues.html#cfn-quicksight-template-customparametervalues-integervalues

string_values

A list of string-type parameter values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customparametervalues.html#cfn-quicksight-template-customparametervalues-stringvalues

CustomValuesConfigurationProperty

class CfnTemplatePropsMixin.CustomValuesConfigurationProperty(*, custom_values=None, include_null_value=None)

Bases: object

The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customvaluesconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

custom_values_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
    custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
        date_time_values=["dateTimeValues"],
        decimal_values=[123],
        integer_values=[123],
        string_values=["stringValues"]
    ),
    include_null_value=False
)

Attributes

custom_values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customvaluesconfiguration.html#cfn-quicksight-template-customvaluesconfiguration-customvalues

Type:

see

include_null_value

Includes the null value in custom action parameter values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customvaluesconfiguration.html#cfn-quicksight-template-customvaluesconfiguration-includenullvalue

DataBarsOptionsProperty

class CfnTemplatePropsMixin.DataBarsOptionsProperty(*, field_id=None, negative_color=None, positive_color=None)

Bases: object

The options for data bars.

Parameters:

  • field_id (Optional[str]) – The field ID for the data bars options.

  • negative_color (Optional[str]) – The color of the negative data bar.

  • positive_color (Optional[str]) – The color of the positive data bar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-databarsoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_bars_options_property = quicksight_mixins.CfnTemplatePropsMixin.DataBarsOptionsProperty(
    field_id="fieldId",
    negative_color="negativeColor",
    positive_color="positiveColor"
)

Attributes

field_id

The field ID for the data bars options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-databarsoptions.html#cfn-quicksight-template-databarsoptions-fieldid

negative_color

The color of the negative data bar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-databarsoptions.html#cfn-quicksight-template-databarsoptions-negativecolor

positive_color

The color of the positive data bar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-databarsoptions.html#cfn-quicksight-template-databarsoptions-positivecolor

DataColorProperty

class CfnTemplatePropsMixin.DataColorProperty(*, color=None, data_value=None)

Bases: object

Determines the color that is applied to a particular data value.

Parameters:

  • color (Optional[str]) – The color that is applied to the data value.

  • data_value (Union[int, float, None]) – The data value that the color is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datacolor.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_color_property = quicksight_mixins.CfnTemplatePropsMixin.DataColorProperty(
    color="color",
    data_value=123
)

Attributes

color

The color that is applied to the data value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datacolor.html#cfn-quicksight-template-datacolor-color

data_value

The data value that the color is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datacolor.html#cfn-quicksight-template-datacolor-datavalue

DataFieldSeriesItemProperty

class CfnTemplatePropsMixin.DataFieldSeriesItemProperty(*, axis_binding=None, field_id=None, field_value=None, settings=None)

Bases: object

The data field series item configuration of a line chart.

Parameters:

  • axis_binding (Optional[str]) – The axis that you are binding the field to.

  • field_id (Optional[str]) – The field ID of the field that you are setting the axis binding to.

  • field_value (Optional[str]) – The field value of the field that you are setting the axis binding to.

  • settings (Union[IResolvable, LineChartSeriesSettingsProperty, Dict[str, Any], None]) – The options that determine the presentation of line series associated to the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datafieldseriesitem.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_field_series_item_property = quicksight_mixins.CfnTemplatePropsMixin.DataFieldSeriesItemProperty(
    axis_binding="axisBinding",
    field_id="fieldId",
    field_value="fieldValue",
    settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartSeriesSettingsProperty(
        line_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartLineStyleSettingsProperty(
            line_interpolation="lineInterpolation",
            line_style="lineStyle",
            line_visibility="lineVisibility",
            line_width="lineWidth"
        ),
        marker_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartMarkerStyleSettingsProperty(
            marker_color="markerColor",
            marker_shape="markerShape",
            marker_size="markerSize",
            marker_visibility="markerVisibility"
        )
    )
)

Attributes

axis_binding

The axis that you are binding the field to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datafieldseriesitem.html#cfn-quicksight-template-datafieldseriesitem-axisbinding

field_id

The field ID of the field that you are setting the axis binding to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datafieldseriesitem.html#cfn-quicksight-template-datafieldseriesitem-fieldid

field_value

The field value of the field that you are setting the axis binding to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datafieldseriesitem.html#cfn-quicksight-template-datafieldseriesitem-fieldvalue

settings

The options that determine the presentation of line series associated to the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datafieldseriesitem.html#cfn-quicksight-template-datafieldseriesitem-settings

DataLabelOptionsProperty

class CfnTemplatePropsMixin.DataLabelOptionsProperty(*, category_label_visibility=None, data_label_types=None, label_color=None, label_content=None, label_font_configuration=None, measure_label_visibility=None, overlap=None, position=None, totals_visibility=None, visibility=None)

Bases: object

The options that determine the presentation of the data labels.

Parameters:

  • category_label_visibility (Optional[str]) – Determines the visibility of the category field labels.

  • data_label_types (Union[IResolvable, Sequence[Union[IResolvable, DataLabelTypeProperty, Dict[str, Any]]], None]) – The option that determines the data label type.

  • label_color (Optional[str]) – Determines the color of the data labels.

  • label_content (Optional[str]) – Determines the content of the data labels.

  • label_font_configuration (Union[IResolvable, FontConfigurationProperty, Dict[str, Any], None]) – Determines the font configuration of the data labels.

  • measure_label_visibility (Optional[str]) – Determines the visibility of the measure field labels.

  • overlap (Optional[str]) – Determines whether overlap is enabled or disabled for the data labels.

  • position (Optional[str]) – Determines the position of the data labels.

  • totals_visibility (Optional[str]) – Determines the visibility of the total.

  • visibility (Optional[str]) – Determines the visibility of the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_label_options_property = quicksight_mixins.CfnTemplatePropsMixin.DataLabelOptionsProperty(
    category_label_visibility="categoryLabelVisibility",
    data_label_types=[quicksight_mixins.CfnTemplatePropsMixin.DataLabelTypeProperty(
        data_path_label_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathLabelTypeProperty(
            field_id="fieldId",
            field_value="fieldValue",
            visibility="visibility"
        ),
        field_label_type=quicksight_mixins.CfnTemplatePropsMixin.FieldLabelTypeProperty(
            field_id="fieldId",
            visibility="visibility"
        ),
        maximum_label_type=quicksight_mixins.CfnTemplatePropsMixin.MaximumLabelTypeProperty(
            visibility="visibility"
        ),
        minimum_label_type=quicksight_mixins.CfnTemplatePropsMixin.MinimumLabelTypeProperty(
            visibility="visibility"
        ),
        range_ends_label_type=quicksight_mixins.CfnTemplatePropsMixin.RangeEndsLabelTypeProperty(
            visibility="visibility"
        )
    )],
    label_color="labelColor",
    label_content="labelContent",
    label_font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    ),
    measure_label_visibility="measureLabelVisibility",
    overlap="overlap",
    position="position",
    totals_visibility="totalsVisibility",
    visibility="visibility"
)

Attributes

category_label_visibility

Determines the visibility of the category field labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-categorylabelvisibility

data_label_types

The option that determines the data label type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-datalabeltypes

label_color

Determines the color of the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-labelcolor

label_content

Determines the content of the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-labelcontent

label_font_configuration

Determines the font configuration of the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-labelfontconfiguration

measure_label_visibility

Determines the visibility of the measure field labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-measurelabelvisibility

overlap

Determines whether overlap is enabled or disabled for the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-overlap

position

Determines the position of the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-position

totals_visibility

Determines the visibility of the total.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-totalsvisibility

visibility

Determines the visibility of the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeloptions.html#cfn-quicksight-template-datalabeloptions-visibility

DataLabelTypeProperty

class CfnTemplatePropsMixin.DataLabelTypeProperty(*, data_path_label_type=None, field_label_type=None, maximum_label_type=None, minimum_label_type=None, range_ends_label_type=None)

Bases: object

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_label_type_property = quicksight_mixins.CfnTemplatePropsMixin.DataLabelTypeProperty(
    data_path_label_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathLabelTypeProperty(
        field_id="fieldId",
        field_value="fieldValue",
        visibility="visibility"
    ),
    field_label_type=quicksight_mixins.CfnTemplatePropsMixin.FieldLabelTypeProperty(
        field_id="fieldId",
        visibility="visibility"
    ),
    maximum_label_type=quicksight_mixins.CfnTemplatePropsMixin.MaximumLabelTypeProperty(
        visibility="visibility"
    ),
    minimum_label_type=quicksight_mixins.CfnTemplatePropsMixin.MinimumLabelTypeProperty(
        visibility="visibility"
    ),
    range_ends_label_type=quicksight_mixins.CfnTemplatePropsMixin.RangeEndsLabelTypeProperty(
        visibility="visibility"
    )
)

Attributes

data_path_label_type

The option that specifies individual data values for labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html#cfn-quicksight-template-datalabeltype-datapathlabeltype

field_label_type

Determines the label configuration for the entire field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html#cfn-quicksight-template-datalabeltype-fieldlabeltype

maximum_label_type

Determines the label configuration for the maximum value in a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html#cfn-quicksight-template-datalabeltype-maximumlabeltype

minimum_label_type

Determines the label configuration for the minimum value in a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html#cfn-quicksight-template-datalabeltype-minimumlabeltype

range_ends_label_type

Determines the label configuration for range end value in a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datalabeltype.html#cfn-quicksight-template-datalabeltype-rangeendslabeltype

DataPathColorProperty

class CfnTemplatePropsMixin.DataPathColorProperty(*, color=None, element=None, time_granularity=None)

Bases: object

The color map that determines the color options for a particular element.

Parameters:

  • color (Optional[str]) – The color that needs to be applied to the element.

  • element (Union[IResolvable, DataPathValueProperty, Dict[str, Any], None]) – The element that the color needs to be applied to.

  • time_granularity (Optional[str]) – The time granularity of the field that the color needs to be applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathcolor.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_path_color_property = quicksight_mixins.CfnTemplatePropsMixin.DataPathColorProperty(
    color="color",
    element=quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
        data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
            pivot_table_data_path_type="pivotTableDataPathType"
        ),
        field_id="fieldId",
        field_value="fieldValue"
    ),
    time_granularity="timeGranularity"
)

Attributes

color

The color that needs to be applied to the element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathcolor.html#cfn-quicksight-template-datapathcolor-color

element

The element that the color needs to be applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathcolor.html#cfn-quicksight-template-datapathcolor-element

time_granularity

The time granularity of the field that the color needs to be applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathcolor.html#cfn-quicksight-template-datapathcolor-timegranularity

DataPathLabelTypeProperty

class CfnTemplatePropsMixin.DataPathLabelTypeProperty(*, field_id=None, field_value=None, visibility=None)

Bases: object

The option that specifies individual data values for labels.

Parameters:

  • field_id (Optional[str]) – The field ID of the field that the data label needs to be applied to.

  • field_value (Optional[str]) – The actual value of the field that is labeled.

  • visibility (Optional[str]) – The visibility of the data label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathlabeltype.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_path_label_type_property = quicksight_mixins.CfnTemplatePropsMixin.DataPathLabelTypeProperty(
    field_id="fieldId",
    field_value="fieldValue",
    visibility="visibility"
)

Attributes

field_id

The field ID of the field that the data label needs to be applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathlabeltype.html#cfn-quicksight-template-datapathlabeltype-fieldid

field_value

The actual value of the field that is labeled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathlabeltype.html#cfn-quicksight-template-datapathlabeltype-fieldvalue

visibility

The visibility of the data label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathlabeltype.html#cfn-quicksight-template-datapathlabeltype-visibility

DataPathSortProperty

class CfnTemplatePropsMixin.DataPathSortProperty(*, direction=None, sort_paths=None)

Bases: object

Allows data paths to be sorted by a specific data value.

Parameters:

  • direction (Optional[str]) – Determines the sort direction.

  • sort_paths (Union[IResolvable, Sequence[Union[IResolvable, DataPathValueProperty, Dict[str, Any]]], None]) – The list of data paths that need to be sorted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathsort.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_path_sort_property = quicksight_mixins.CfnTemplatePropsMixin.DataPathSortProperty(
    direction="direction",
    sort_paths=[quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
        data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
            pivot_table_data_path_type="pivotTableDataPathType"
        ),
        field_id="fieldId",
        field_value="fieldValue"
    )]
)

Attributes

direction

Determines the sort direction.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathsort.html#cfn-quicksight-template-datapathsort-direction

sort_paths

The list of data paths that need to be sorted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathsort.html#cfn-quicksight-template-datapathsort-sortpaths

DataPathTypeProperty

class CfnTemplatePropsMixin.DataPathTypeProperty(*, pivot_table_data_path_type=None)

Bases: object

The type of the data path value.

Parameters:

pivot_table_data_path_type (Optional[str]) – The type of data path value utilized in a pivot table. Choose one of the following options:. - HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY . - MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement. - EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement. - COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathtype.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_path_type_property = quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
    pivot_table_data_path_type="pivotTableDataPathType"
)

Attributes

pivot_table_data_path_type

.

  • HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .

  • MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.

  • EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.

  • COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathtype.html#cfn-quicksight-template-datapathtype-pivottabledatapathtype

Type:

The type of data path value utilized in a pivot table. Choose one of the following options

DataPathValueProperty

class CfnTemplatePropsMixin.DataPathValueProperty(*, data_path_type=None, field_id=None, field_value=None)

Bases: object

The data path that needs to be sorted.

Parameters:

  • data_path_type (Union[IResolvable, DataPathTypeProperty, Dict[str, Any], None]) – The type configuration of the field.

  • field_id (Optional[str]) – The field ID of the field that needs to be sorted.

  • field_value (Optional[str]) – The actual value of the field that needs to be sorted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathvalue.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_path_value_property = quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
    data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
        pivot_table_data_path_type="pivotTableDataPathType"
    ),
    field_id="fieldId",
    field_value="fieldValue"
)

Attributes

data_path_type

The type configuration of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathvalue.html#cfn-quicksight-template-datapathvalue-datapathtype

field_id

The field ID of the field that needs to be sorted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathvalue.html#cfn-quicksight-template-datapathvalue-fieldid

field_value

The actual value of the field that needs to be sorted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datapathvalue.html#cfn-quicksight-template-datapathvalue-fieldvalue

DataSetConfigurationProperty

class CfnTemplatePropsMixin.DataSetConfigurationProperty(*, column_group_schema_list=None, data_set_schema=None, placeholder=None)

Bases: object

Dataset configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_set_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DataSetConfigurationProperty(
    column_group_schema_list=[quicksight_mixins.CfnTemplatePropsMixin.ColumnGroupSchemaProperty(
        column_group_column_schema_list=[quicksight_mixins.CfnTemplatePropsMixin.ColumnGroupColumnSchemaProperty(
            name="name"
        )],
        name="name"
    )],
    data_set_schema=quicksight_mixins.CfnTemplatePropsMixin.DataSetSchemaProperty(
        column_schema_list=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSchemaProperty(
            data_type="dataType",
            geographic_role="geographicRole",
            name="name"
        )]
    ),
    placeholder="placeholder"
)

Attributes

column_group_schema_list

A structure containing the list of column group schemas.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html#cfn-quicksight-template-datasetconfiguration-columngroupschemalist

data_set_schema

Dataset schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html#cfn-quicksight-template-datasetconfiguration-datasetschema

placeholder

Placeholder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html#cfn-quicksight-template-datasetconfiguration-placeholder

DataSetReferenceProperty

class CfnTemplatePropsMixin.DataSetReferenceProperty(*, data_set_arn=None, data_set_placeholder=None)

Bases: object

Dataset reference.

Parameters:

  • data_set_arn (Optional[str]) – Dataset Amazon Resource Name (ARN).

  • data_set_placeholder (Optional[str]) – Dataset placeholder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetreference.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_set_reference_property = quicksight_mixins.CfnTemplatePropsMixin.DataSetReferenceProperty(
    data_set_arn="dataSetArn",
    data_set_placeholder="dataSetPlaceholder"
)

Attributes

data_set_arn

Dataset Amazon Resource Name (ARN).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetreference.html#cfn-quicksight-template-datasetreference-datasetarn

data_set_placeholder

Dataset placeholder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetreference.html#cfn-quicksight-template-datasetreference-datasetplaceholder

DataSetSchemaProperty

class CfnTemplatePropsMixin.DataSetSchemaProperty(*, column_schema_list=None)

Bases: object

Dataset schema.

Parameters:

column_schema_list (Union[IResolvable, Sequence[Union[IResolvable, ColumnSchemaProperty, Dict[str, Any]]], None]) – A structure containing the list of column schemas.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetschema.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

data_set_schema_property = quicksight_mixins.CfnTemplatePropsMixin.DataSetSchemaProperty(
    column_schema_list=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSchemaProperty(
        data_type="dataType",
        geographic_role="geographicRole",
        name="name"
    )]
)

Attributes

column_schema_list

A structure containing the list of column schemas.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetschema.html#cfn-quicksight-template-datasetschema-columnschemalist

DateAxisOptionsProperty

class CfnTemplatePropsMixin.DateAxisOptionsProperty(*, missing_date_visibility=None)

Bases: object

The options that determine how a date axis is displayed.

Parameters:

missing_date_visibility (Optional[str]) – Determines whether or not missing dates are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dateaxisoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

date_axis_options_property = quicksight_mixins.CfnTemplatePropsMixin.DateAxisOptionsProperty(
    missing_date_visibility="missingDateVisibility"
)

Attributes

missing_date_visibility

Determines whether or not missing dates are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dateaxisoptions.html#cfn-quicksight-template-dateaxisoptions-missingdatevisibility

DateDimensionFieldProperty

class CfnTemplatePropsMixin.DateDimensionFieldProperty(*, column=None, date_granularity=None, field_id=None, format_configuration=None, hierarchy_id=None)

Bases: object

The dimension type field with date type columns.

Parameters:

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that is used in the DateDimensionField .

  • date_granularity (Optional[str]) – The date granularity of the DateDimensionField . Choose one of the following options:. - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR - MINUTE - SECOND - MILLISECOND

  • field_id (Optional[str]) – The custom field ID.

  • format_configuration (Union[IResolvable, DateTimeFormatConfigurationProperty, Dict[str, Any], None]) – The format configuration of the field.

  • hierarchy_id (Optional[str]) – The custom hierarchy ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

date_dimension_field_property = quicksight_mixins.CfnTemplatePropsMixin.DateDimensionFieldProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    date_granularity="dateGranularity",
    field_id="fieldId",
    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
        date_time_format="dateTimeFormat",
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    ),
    hierarchy_id="hierarchyId"
)

Attributes

column

The column that is used in the DateDimensionField .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html#cfn-quicksight-template-datedimensionfield-column

date_granularity

.

  • YEAR

  • QUARTER

  • MONTH

  • WEEK

  • DAY

  • HOUR

  • MINUTE

  • SECOND

  • MILLISECOND

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html#cfn-quicksight-template-datedimensionfield-dategranularity

Type:

The date granularity of the DateDimensionField . Choose one of the following options

field_id

The custom field ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html#cfn-quicksight-template-datedimensionfield-fieldid

format_configuration

The format configuration of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html#cfn-quicksight-template-datedimensionfield-formatconfiguration

hierarchy_id

The custom hierarchy ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datedimensionfield.html#cfn-quicksight-template-datedimensionfield-hierarchyid

DateMeasureFieldProperty

class CfnTemplatePropsMixin.DateMeasureFieldProperty(*, aggregation_function=None, column=None, field_id=None, format_configuration=None)

Bases: object

The measure type field with date type columns.

Parameters:

  • aggregation_function (Optional[str]) – The aggregation function of the measure field.

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that is used in the DateMeasureField .

  • field_id (Optional[str]) – The custom field ID.

  • format_configuration (Union[IResolvable, DateTimeFormatConfigurationProperty, Dict[str, Any], None]) – The format configuration of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datemeasurefield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

date_measure_field_property = quicksight_mixins.CfnTemplatePropsMixin.DateMeasureFieldProperty(
    aggregation_function="aggregationFunction",
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",
    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
        date_time_format="dateTimeFormat",
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    )
)

Attributes

aggregation_function

The aggregation function of the measure field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datemeasurefield.html#cfn-quicksight-template-datemeasurefield-aggregationfunction

column

The column that is used in the DateMeasureField .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datemeasurefield.html#cfn-quicksight-template-datemeasurefield-column

field_id

The custom field ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datemeasurefield.html#cfn-quicksight-template-datemeasurefield-fieldid

format_configuration

The format configuration of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datemeasurefield.html#cfn-quicksight-template-datemeasurefield-formatconfiguration

DateTimeDefaultValuesProperty

class CfnTemplatePropsMixin.DateTimeDefaultValuesProperty(*, dynamic_value=None, rolling_date=None, static_values=None)

Bases: object

The default values of the DateTimeParameterDeclaration .

Parameters:

  • dynamic_value (Union[IResolvable, DynamicDefaultValueProperty, Dict[str, Any], None]) – The dynamic value of the DataTimeDefaultValues . Different defaults are displayed according to users, groups, and values mapping.

  • rolling_date (Union[IResolvable, RollingDateConfigurationProperty, Dict[str, Any], None]) – The rolling date of the DataTimeDefaultValues . The date is determined from the dataset based on input expression.

  • static_values (Optional[Sequence[str]]) – The static values of the DataTimeDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimedefaultvalues.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

date_time_default_values_property = quicksight_mixins.CfnTemplatePropsMixin.DateTimeDefaultValuesProperty(
    dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
        default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    ),
    rolling_date=quicksight_mixins.CfnTemplatePropsMixin.RollingDateConfigurationProperty(
        data_set_identifier="dataSetIdentifier",
        expression="expression"
    ),
    static_values=["staticValues"]
)

Attributes

dynamic_value

The dynamic value of the DataTimeDefaultValues .

Different defaults are displayed according to users, groups, and values mapping.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimedefaultvalues.html#cfn-quicksight-template-datetimedefaultvalues-dynamicvalue

rolling_date

The rolling date of the DataTimeDefaultValues .

The date is determined from the dataset based on input expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimedefaultvalues.html#cfn-quicksight-template-datetimedefaultvalues-rollingdate

static_values

The static values of the DataTimeDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimedefaultvalues.html#cfn-quicksight-template-datetimedefaultvalues-staticvalues

DateTimeFormatConfigurationProperty

class CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(*, date_time_format=None, null_value_format_configuration=None, numeric_format_configuration=None)

Bases: object

Formatting configuration for DateTime fields.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeformatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

date_time_format_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
    date_time_format="dateTimeFormat",
    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
        currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix",
            symbol="symbol"
        ),
        number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        )
    )
)

Attributes

date_time_format

Determines the DateTime format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeformatconfiguration.html#cfn-quicksight-template-datetimeformatconfiguration-datetimeformat

null_value_format_configuration

The options that determine the null value format configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeformatconfiguration.html#cfn-quicksight-template-datetimeformatconfiguration-nullvalueformatconfiguration

numeric_format_configuration

The formatting configuration for numeric DateTime fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeformatconfiguration.html#cfn-quicksight-template-datetimeformatconfiguration-numericformatconfiguration

DateTimeHierarchyProperty

class CfnTemplatePropsMixin.DateTimeHierarchyProperty(*, drill_down_filters=None, hierarchy_id=None)

Bases: object

The option that determines the hierarchy of any DateTime fields.

Parameters:

  • drill_down_filters (Union[IResolvable, Sequence[Union[IResolvable, DrillDownFilterProperty, Dict[str, Any]]], None]) – The option that determines the drill down filters for the DateTime hierarchy.

  • hierarchy_id (Optional[str]) – The hierarchy ID of the DateTime hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimehierarchy.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

date_time_hierarchy_property = quicksight_mixins.CfnTemplatePropsMixin.DateTimeHierarchyProperty(
    drill_down_filters=[quicksight_mixins.CfnTemplatePropsMixin.DrillDownFilterProperty(
        category_filter=quicksight_mixins.CfnTemplatePropsMixin.CategoryDrillDownFilterProperty(
            category_values=["categoryValues"],
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        numeric_equality_filter=quicksight_mixins.CfnTemplatePropsMixin.NumericEqualityDrillDownFilterProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            value=123
        ),
        time_range_filter=quicksight_mixins.CfnTemplatePropsMixin.TimeRangeDrillDownFilterProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            range_maximum="rangeMaximum",
            range_minimum="rangeMinimum",
            time_granularity="timeGranularity"
        )
    )],
    hierarchy_id="hierarchyId"
)

Attributes

drill_down_filters

The option that determines the drill down filters for the DateTime hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimehierarchy.html#cfn-quicksight-template-datetimehierarchy-drilldownfilters

hierarchy_id

The hierarchy ID of the DateTime hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimehierarchy.html#cfn-quicksight-template-datetimehierarchy-hierarchyid

DateTimeParameterDeclarationProperty

class CfnTemplatePropsMixin.DateTimeParameterDeclarationProperty(*, default_values=None, mapped_data_set_parameters=None, name=None, time_granularity=None, value_when_unset=None)

Bases: object

A parameter declaration for the DateTime data type.

Parameters:

  • default_values (Union[IResolvable, DateTimeDefaultValuesProperty, Dict[str, Any], None]) – The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

  • mapped_data_set_parameters (Union[IResolvable, Sequence[Union[IResolvable, MappedDataSetParameterProperty, Dict[str, Any]]], None])

  • name (Optional[str]) – The name of the parameter that is being declared.

  • time_granularity (Optional[str]) – The level of time precision that is used to aggregate DateTime values.

  • value_when_unset (Union[IResolvable, DateTimeValueWhenUnsetConfigurationProperty, Dict[str, Any], None]) – The configuration that defines the default value of a DateTime parameter when a value has not been set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

date_time_parameter_declaration_property = quicksight_mixins.CfnTemplatePropsMixin.DateTimeParameterDeclarationProperty(
    default_values=quicksight_mixins.CfnTemplatePropsMixin.DateTimeDefaultValuesProperty(
        dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
            default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        rolling_date=quicksight_mixins.CfnTemplatePropsMixin.RollingDateConfigurationProperty(
            data_set_identifier="dataSetIdentifier",
            expression="expression"
        ),
        static_values=["staticValues"]
    ),
    mapped_data_set_parameters=[quicksight_mixins.CfnTemplatePropsMixin.MappedDataSetParameterProperty(
        data_set_identifier="dataSetIdentifier",
        data_set_parameter_name="dataSetParameterName"
    )],
    name="name",
    time_granularity="timeGranularity",
    value_when_unset=quicksight_mixins.CfnTemplatePropsMixin.DateTimeValueWhenUnsetConfigurationProperty(
        custom_value="customValue",
        value_when_unset_option="valueWhenUnsetOption"
    )
)

Attributes

default_values

The default values of a parameter.

If the parameter is a single-value parameter, a maximum of one default value can be provided.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html#cfn-quicksight-template-datetimeparameterdeclaration-defaultvalues

mapped_data_set_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html#cfn-quicksight-template-datetimeparameterdeclaration-mappeddatasetparameters

Type:

see

name

The name of the parameter that is being declared.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html#cfn-quicksight-template-datetimeparameterdeclaration-name

time_granularity

The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html#cfn-quicksight-template-datetimeparameterdeclaration-timegranularity

value_when_unset

The configuration that defines the default value of a DateTime parameter when a value has not been set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimeparameterdeclaration.html#cfn-quicksight-template-datetimeparameterdeclaration-valuewhenunset

DateTimePickerControlDisplayOptionsProperty

class CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(*, date_icon_visibility=None, date_time_format=None, helper_text_visibility=None, info_icon_label_options=None, title_options=None)

Bases: object

The display options of a control.

Parameters:

  • date_icon_visibility (Any) – The date icon visibility of the DateTimePickerControlDisplayOptions .

  • date_time_format (Optional[str]) – Customize how dates are formatted in controls.

  • helper_text_visibility (Any) – The helper text visibility of the DateTimePickerControlDisplayOptions .

  • info_icon_label_options (Union[IResolvable, SheetControlInfoIconLabelOptionsProperty, Dict[str, Any], None]) – The configuration of info icon label options.

  • title_options (Union[IResolvable, LabelOptionsProperty, Dict[str, Any], None]) – The options to configure the title visibility, name, and font size.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

date_time_picker_control_display_options_property = quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
    date_icon_visibility=date_icon_visibility,
    date_time_format="dateTimeFormat",
    helper_text_visibility=helper_text_visibility,
    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        visibility="visibility"
    )
)

Attributes

date_icon_visibility

The date icon visibility of the DateTimePickerControlDisplayOptions .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html#cfn-quicksight-template-datetimepickercontroldisplayoptions-dateiconvisibility

date_time_format

Customize how dates are formatted in controls.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html#cfn-quicksight-template-datetimepickercontroldisplayoptions-datetimeformat

helper_text_visibility

The helper text visibility of the DateTimePickerControlDisplayOptions .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html#cfn-quicksight-template-datetimepickercontroldisplayoptions-helpertextvisibility

info_icon_label_options

The configuration of info icon label options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html#cfn-quicksight-template-datetimepickercontroldisplayoptions-infoiconlabeloptions

title_options

The options to configure the title visibility, name, and font size.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimepickercontroldisplayoptions.html#cfn-quicksight-template-datetimepickercontroldisplayoptions-titleoptions

DateTimeValueWhenUnsetConfigurationProperty

class CfnTemplatePropsMixin.DateTimeValueWhenUnsetConfigurationProperty(*, custom_value=None, value_when_unset_option=None)

Bases: object

The configuration that defines the default value of a DateTime parameter when a value has not been set.

Parameters:

  • custom_value (Optional[str]) – A custom value that’s used when the value of a parameter isn’t set.

  • value_when_unset_option (Optional[str]) – The built-in options for default values. The value can be one of the following:. - RECOMMENDED : The recommended value. - NULL : The NULL value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimevaluewhenunsetconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

date_time_value_when_unset_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DateTimeValueWhenUnsetConfigurationProperty(
    custom_value="customValue",
    value_when_unset_option="valueWhenUnsetOption"
)

Attributes

custom_value

A custom value that’s used when the value of a parameter isn’t set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimevaluewhenunsetconfiguration.html#cfn-quicksight-template-datetimevaluewhenunsetconfiguration-customvalue

value_when_unset_option

.

  • RECOMMENDED : The recommended value.

  • NULL : The NULL value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datetimevaluewhenunsetconfiguration.html#cfn-quicksight-template-datetimevaluewhenunsetconfiguration-valuewhenunsetoption

Type:

The built-in options for default values. The value can be one of the following

DecimalDefaultValuesProperty

class CfnTemplatePropsMixin.DecimalDefaultValuesProperty(*, dynamic_value=None, static_values=None)

Bases: object

The default values of the DecimalParameterDeclaration .

Parameters:

  • dynamic_value (Union[IResolvable, DynamicDefaultValueProperty, Dict[str, Any], None]) – The dynamic value of the DecimalDefaultValues . Different defaults are displayed according to users, groups, and values mapping.

  • static_values (Union[Sequence[Union[int, float]], IResolvable, None]) – The static values of the DecimalDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimaldefaultvalues.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

decimal_default_values_property = quicksight_mixins.CfnTemplatePropsMixin.DecimalDefaultValuesProperty(
    dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
        default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    ),
    static_values=[123]
)

Attributes

dynamic_value

The dynamic value of the DecimalDefaultValues .

Different defaults are displayed according to users, groups, and values mapping.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimaldefaultvalues.html#cfn-quicksight-template-decimaldefaultvalues-dynamicvalue

static_values

The static values of the DecimalDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimaldefaultvalues.html#cfn-quicksight-template-decimaldefaultvalues-staticvalues

DecimalParameterDeclarationProperty

class CfnTemplatePropsMixin.DecimalParameterDeclarationProperty(*, default_values=None, mapped_data_set_parameters=None, name=None, parameter_value_type=None, value_when_unset=None)

Bases: object

A parameter declaration for the Decimal data type.

Parameters:

  • default_values (Union[IResolvable, DecimalDefaultValuesProperty, Dict[str, Any], None]) – The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

  • mapped_data_set_parameters (Union[IResolvable, Sequence[Union[IResolvable, MappedDataSetParameterProperty, Dict[str, Any]]], None])

  • name (Optional[str]) – The name of the parameter that is being declared.

  • parameter_value_type (Optional[str]) – The value type determines whether the parameter is a single-value or multi-value parameter.

  • value_when_unset (Union[IResolvable, DecimalValueWhenUnsetConfigurationProperty, Dict[str, Any], None]) – The configuration that defines the default value of a Decimal parameter when a value has not been set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

decimal_parameter_declaration_property = quicksight_mixins.CfnTemplatePropsMixin.DecimalParameterDeclarationProperty(
    default_values=quicksight_mixins.CfnTemplatePropsMixin.DecimalDefaultValuesProperty(
        dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
            default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        static_values=[123]
    ),
    mapped_data_set_parameters=[quicksight_mixins.CfnTemplatePropsMixin.MappedDataSetParameterProperty(
        data_set_identifier="dataSetIdentifier",
        data_set_parameter_name="dataSetParameterName"
    )],
    name="name",
    parameter_value_type="parameterValueType",
    value_when_unset=quicksight_mixins.CfnTemplatePropsMixin.DecimalValueWhenUnsetConfigurationProperty(
        custom_value=123,
        value_when_unset_option="valueWhenUnsetOption"
    )
)

Attributes

default_values

The default values of a parameter.

If the parameter is a single-value parameter, a maximum of one default value can be provided.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html#cfn-quicksight-template-decimalparameterdeclaration-defaultvalues

mapped_data_set_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html#cfn-quicksight-template-decimalparameterdeclaration-mappeddatasetparameters

Type:

see

name

The name of the parameter that is being declared.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html#cfn-quicksight-template-decimalparameterdeclaration-name

parameter_value_type

The value type determines whether the parameter is a single-value or multi-value parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html#cfn-quicksight-template-decimalparameterdeclaration-parametervaluetype

value_when_unset

The configuration that defines the default value of a Decimal parameter when a value has not been set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalparameterdeclaration.html#cfn-quicksight-template-decimalparameterdeclaration-valuewhenunset

DecimalPlacesConfigurationProperty

class CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(*, decimal_places=None)

Bases: object

The option that determines the decimal places configuration.

Parameters:

decimal_places (Union[int, float, None]) – The values of the decimal places.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalplacesconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

decimal_places_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
    decimal_places=123
)

Attributes

decimal_places

The values of the decimal places.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalplacesconfiguration.html#cfn-quicksight-template-decimalplacesconfiguration-decimalplaces

DecimalValueWhenUnsetConfigurationProperty

class CfnTemplatePropsMixin.DecimalValueWhenUnsetConfigurationProperty(*, custom_value=None, value_when_unset_option=None)

Bases: object

The configuration that defines the default value of a Decimal parameter when a value has not been set.

Parameters:

  • custom_value (Union[int, float, None]) – A custom value that’s used when the value of a parameter isn’t set.

  • value_when_unset_option (Optional[str]) – The built-in options for default values. The value can be one of the following:. - RECOMMENDED : The recommended value. - NULL : The NULL value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalvaluewhenunsetconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

decimal_value_when_unset_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DecimalValueWhenUnsetConfigurationProperty(
    custom_value=123,
    value_when_unset_option="valueWhenUnsetOption"
)

Attributes

custom_value

A custom value that’s used when the value of a parameter isn’t set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalvaluewhenunsetconfiguration.html#cfn-quicksight-template-decimalvaluewhenunsetconfiguration-customvalue

value_when_unset_option

.

  • RECOMMENDED : The recommended value.

  • NULL : The NULL value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-decimalvaluewhenunsetconfiguration.html#cfn-quicksight-template-decimalvaluewhenunsetconfiguration-valuewhenunsetoption

Type:

The built-in options for default values. The value can be one of the following

DefaultDateTimePickerControlOptionsProperty

class CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(*, commit_mode=None, display_options=None, type=None)

Bases: object

The default options that correspond to the filter control type of a DateTimePicker .

Parameters:

  • commit_mode (Optional[str]) – The visibility configuration of the Apply button on a DateTimePickerControl .

  • display_options (Union[IResolvable, DateTimePickerControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • type (Optional[str]) – The date time picker type of the DefaultDateTimePickerControlOptions . Choose one of the following options:. - SINGLE_VALUED : The filter condition is a fixed date. - DATE_RANGE : The filter condition is a date time range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultdatetimepickercontroloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

default_date_time_picker_control_options_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
    commit_mode="commitMode",
    display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
        date_icon_visibility=date_icon_visibility,
        date_time_format="dateTimeFormat",
        helper_text_visibility=helper_text_visibility,
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    type="type"
)

Attributes

commit_mode

The visibility configuration of the Apply button on a DateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultdatetimepickercontroloptions.html#cfn-quicksight-template-defaultdatetimepickercontroloptions-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultdatetimepickercontroloptions.html#cfn-quicksight-template-defaultdatetimepickercontroloptions-displayoptions

type

.

  • SINGLE_VALUED : The filter condition is a fixed date.

  • DATE_RANGE : The filter condition is a date time range.

See:

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

Type:

The date time picker type of the DefaultDateTimePickerControlOptions . Choose one of the following options

DefaultFilterControlConfigurationProperty

class CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(*, control_options=None, title=None)

Bases: object

The default configuration for all dependent controls of the filter.

Parameters:

  • control_options (Union[IResolvable, DefaultFilterControlOptionsProperty, Dict[str, Any], None]) – The control option for the DefaultFilterControlConfiguration .

  • title (Optional[str]) – The title of the DefaultFilterControlConfiguration . This title is shared by all controls that are tied to this filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontrolconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

default_filter_control_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
    control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
        default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
            commit_mode="commitMode",
            display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                date_icon_visibility=date_icon_visibility,
                date_time_format="dateTimeFormat",
                helper_text_visibility=helper_text_visibility,
                info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_family="fontFamily",
                        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                            absolute="absolute",
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            ),
            type="type"
        ),
        default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
            commit_mode="commitMode",
            display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                    visibility="visibility"
                ),
                title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_family="fontFamily",
                        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                            absolute="absolute",
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            ),
            selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                values=["values"]
            ),
            type="type"
        ),
        default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
            display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                    visibility="visibility"
                ),
                select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                    visibility="visibility"
                ),
                title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_family="fontFamily",
                        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                            absolute="absolute",
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            ),
            selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                values=["values"]
            ),
            type="type"
        ),
        default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
            commit_mode="commitMode",
            display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                date_time_format="dateTimeFormat",
                info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_family="fontFamily",
                        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                            absolute="absolute",
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            )
        ),
        default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
            display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_family="fontFamily",
                        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                            absolute="absolute",
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            ),
            maximum_value=123,
            minimum_value=123,
            step_size=123,
            type="type"
        ),
        default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
            delimiter="delimiter",
            display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                    visibility="visibility"
                ),
                title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_family="fontFamily",
                        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                            absolute="absolute",
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            )
        ),
        default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
            display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                    visibility="visibility"
                ),
                title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_family="fontFamily",
                        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                            absolute="absolute",
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            )
        )
    ),
    title="title"
)

Attributes

control_options

The control option for the DefaultFilterControlConfiguration .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html#cfn-quicksight-template-defaultfiltercontrolconfiguration-controloptions

title

The title of the DefaultFilterControlConfiguration .

This title is shared by all controls that are tied to this filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontrolconfiguration.html#cfn-quicksight-template-defaultfiltercontrolconfiguration-title

DefaultFilterControlOptionsProperty

class CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(*, default_date_time_picker_options=None, default_dropdown_options=None, default_list_options=None, default_relative_date_time_options=None, default_slider_options=None, default_text_area_options=None, default_text_field_options=None)

Bases: object

The option that corresponds to the control type of the filter.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

default_filter_control_options_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
    default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
        commit_mode="commitMode",
        display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
            date_icon_visibility=date_icon_visibility,
            date_time_format="dateTimeFormat",
            helper_text_visibility=helper_text_visibility,
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        type="type"
    ),
    default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
        commit_mode="commitMode",
        display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
            values=["values"]
        ),
        type="type"
    ),
    default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
        display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                visibility="visibility"
            ),
            select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
            values=["values"]
        ),
        type="type"
    ),
    default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
        commit_mode="commitMode",
        display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
            date_time_format="dateTimeFormat",
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    ),
    default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
        display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        maximum_value=123,
        minimum_value=123,
        step_size=123,
        type="type"
    ),
    default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
        delimiter="delimiter",
        display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    ),
    default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
        display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    )
)

Attributes

default_date_time_picker_options

The default options that correspond to the filter control type of a DateTimePicker .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaultdatetimepickeroptions

default_dropdown_options

The default options that correspond to the Dropdown filter control type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaultdropdownoptions

default_list_options

The default options that correspond to the List filter control type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaultlistoptions

default_relative_date_time_options

The default options that correspond to the RelativeDateTime filter control type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaultrelativedatetimeoptions

default_slider_options

The default options that correspond to the Slider filter control type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaultslideroptions

default_text_area_options

The default options that correspond to the TextArea filter control type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaulttextareaoptions

default_text_field_options

The default options that correspond to the TextField filter control type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfiltercontroloptions.html#cfn-quicksight-template-defaultfiltercontroloptions-defaulttextfieldoptions

DefaultFilterDropDownControlOptionsProperty

class CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(*, commit_mode=None, display_options=None, selectable_values=None, type=None)

Bases: object

The default options that correspond to the Dropdown filter control type.

Parameters:

  • commit_mode (Optional[str]) – The visibility configuration of the Apply button on a FilterDropDownControl .

  • display_options (Union[IResolvable, DropDownControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • selectable_values (Union[IResolvable, FilterSelectableValuesProperty, Dict[str, Any], None]) – A list of selectable values that are used in a control.

  • type (Optional[str]) – The type of the FilterDropDownControl . Choose one of the following options:. - MULTI_SELECT : The user can select multiple entries from a dropdown menu. - SINGLE_SELECT : The user can select a single entry from a dropdown menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterdropdowncontroloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_filter_drop_down_control_options_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
    commit_mode="commitMode",
    display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
        values=["values"]
    ),
    type="type"
)

Attributes

commit_mode

The visibility configuration of the Apply button on a FilterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterdropdowncontroloptions.html#cfn-quicksight-template-defaultfilterdropdowncontroloptions-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterdropdowncontroloptions.html#cfn-quicksight-template-defaultfilterdropdowncontroloptions-displayoptions

selectable_values

A list of selectable values that are used in a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterdropdowncontroloptions.html#cfn-quicksight-template-defaultfilterdropdowncontroloptions-selectablevalues

type

.

  • MULTI_SELECT : The user can select multiple entries from a dropdown menu.

  • SINGLE_SELECT : The user can select a single entry from a dropdown menu.

See:

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

Type:

The type of the FilterDropDownControl . Choose one of the following options

DefaultFilterListControlOptionsProperty

class CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(*, display_options=None, selectable_values=None, type=None)

Bases: object

The default options that correspond to the List filter control type.

Parameters:

  • display_options (Union[IResolvable, ListControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • selectable_values (Union[IResolvable, FilterSelectableValuesProperty, Dict[str, Any], None]) – A list of selectable values that are used in a control.

  • type (Optional[str]) – The type of the DefaultFilterListControlOptions . Choose one of the following options:. - MULTI_SELECT : The user can select multiple entries from the list. - SINGLE_SELECT : The user can select a single entry from the list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterlistcontroloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_filter_list_control_options_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
    display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
            visibility="visibility"
        ),
        select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
        values=["values"]
    ),
    type="type"
)

Attributes

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterlistcontroloptions.html#cfn-quicksight-template-defaultfilterlistcontroloptions-displayoptions

selectable_values

A list of selectable values that are used in a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfilterlistcontroloptions.html#cfn-quicksight-template-defaultfilterlistcontroloptions-selectablevalues

type

.

  • MULTI_SELECT : The user can select multiple entries from the list.

  • SINGLE_SELECT : The user can select a single entry from the list.

See:

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

Type:

The type of the DefaultFilterListControlOptions . Choose one of the following options

DefaultFreeFormLayoutConfigurationProperty

class CfnTemplatePropsMixin.DefaultFreeFormLayoutConfigurationProperty(*, canvas_size_options=None)

Bases: object

The options that determine the default settings of a free-form layout configuration.

Parameters:

canvas_size_options (Union[IResolvable, FreeFormLayoutCanvasSizeOptionsProperty, Dict[str, Any], None]) – Determines the screen canvas size options for a free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfreeformlayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_free_form_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultFreeFormLayoutConfigurationProperty(
    canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutCanvasSizeOptionsProperty(
        screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutScreenCanvasSizeOptionsProperty(
            optimized_view_port_width="optimizedViewPortWidth"
        )
    )
)

Attributes

canvas_size_options

Determines the screen canvas size options for a free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultfreeformlayoutconfiguration.html#cfn-quicksight-template-defaultfreeformlayoutconfiguration-canvassizeoptions

DefaultGridLayoutConfigurationProperty

class CfnTemplatePropsMixin.DefaultGridLayoutConfigurationProperty(*, canvas_size_options=None)

Bases: object

The options that determine the default settings for a grid layout configuration.

Parameters:

canvas_size_options (Union[IResolvable, GridLayoutCanvasSizeOptionsProperty, Dict[str, Any], None]) – Determines the screen canvas size options for a grid layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultgridlayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_grid_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultGridLayoutConfigurationProperty(
    canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(
        screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
            optimized_view_port_width="optimizedViewPortWidth",
            resize_option="resizeOption"
        )
    )
)

Attributes

canvas_size_options

Determines the screen canvas size options for a grid layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultgridlayoutconfiguration.html#cfn-quicksight-template-defaultgridlayoutconfiguration-canvassizeoptions

DefaultInteractiveLayoutConfigurationProperty

class CfnTemplatePropsMixin.DefaultInteractiveLayoutConfigurationProperty(*, free_form=None, grid=None)

Bases: object

The options that determine the default settings for interactive layout configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultinteractivelayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_interactive_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultInteractiveLayoutConfigurationProperty(
    free_form=quicksight_mixins.CfnTemplatePropsMixin.DefaultFreeFormLayoutConfigurationProperty(
        canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutCanvasSizeOptionsProperty(
            screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutScreenCanvasSizeOptionsProperty(
                optimized_view_port_width="optimizedViewPortWidth"
            )
        )
    ),
    grid=quicksight_mixins.CfnTemplatePropsMixin.DefaultGridLayoutConfigurationProperty(
        canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(
            screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
                optimized_view_port_width="optimizedViewPortWidth",
                resize_option="resizeOption"
            )
        )
    )
)

Attributes

free_form

The options that determine the default settings of a free-form layout configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultinteractivelayoutconfiguration.html#cfn-quicksight-template-defaultinteractivelayoutconfiguration-freeform

grid

The options that determine the default settings for a grid layout configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultinteractivelayoutconfiguration.html#cfn-quicksight-template-defaultinteractivelayoutconfiguration-grid

DefaultNewSheetConfigurationProperty

class CfnTemplatePropsMixin.DefaultNewSheetConfigurationProperty(*, interactive_layout_configuration=None, paginated_layout_configuration=None, sheet_content_type=None)

Bases: object

The configuration for default new sheet settings.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultnewsheetconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_new_sheet_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultNewSheetConfigurationProperty(
    interactive_layout_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultInteractiveLayoutConfigurationProperty(
        free_form=quicksight_mixins.CfnTemplatePropsMixin.DefaultFreeFormLayoutConfigurationProperty(
            canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutCanvasSizeOptionsProperty(
                screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutScreenCanvasSizeOptionsProperty(
                    optimized_view_port_width="optimizedViewPortWidth"
                )
            )
        ),
        grid=quicksight_mixins.CfnTemplatePropsMixin.DefaultGridLayoutConfigurationProperty(
            canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(
                screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
                    optimized_view_port_width="optimizedViewPortWidth",
                    resize_option="resizeOption"
                )
            )
        )
    ),
    paginated_layout_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultPaginatedLayoutConfigurationProperty(
        section_based=quicksight_mixins.CfnTemplatePropsMixin.DefaultSectionBasedLayoutConfigurationProperty(
            canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutCanvasSizeOptionsProperty(
                paper_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
                    paper_margin=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                        bottom="bottom",
                        left="left",
                        right="right",
                        top="top"
                    ),
                    paper_orientation="paperOrientation",
                    paper_size="paperSize"
                )
            )
        )
    ),
    sheet_content_type="sheetContentType"
)

Attributes

interactive_layout_configuration

The options that determine the default settings for interactive layout configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultnewsheetconfiguration.html#cfn-quicksight-template-defaultnewsheetconfiguration-interactivelayoutconfiguration

paginated_layout_configuration

The options that determine the default settings for a paginated layout configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultnewsheetconfiguration.html#cfn-quicksight-template-defaultnewsheetconfiguration-paginatedlayoutconfiguration

sheet_content_type

The option that determines the sheet content type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultnewsheetconfiguration.html#cfn-quicksight-template-defaultnewsheetconfiguration-sheetcontenttype

DefaultPaginatedLayoutConfigurationProperty

class CfnTemplatePropsMixin.DefaultPaginatedLayoutConfigurationProperty(*, section_based=None)

Bases: object

The options that determine the default settings for a paginated layout configuration.

Parameters:

section_based (Union[IResolvable, DefaultSectionBasedLayoutConfigurationProperty, Dict[str, Any], None]) – The options that determine the default settings for a section-based layout configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultpaginatedlayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_paginated_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultPaginatedLayoutConfigurationProperty(
    section_based=quicksight_mixins.CfnTemplatePropsMixin.DefaultSectionBasedLayoutConfigurationProperty(
        canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutCanvasSizeOptionsProperty(
            paper_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
                paper_margin=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                    bottom="bottom",
                    left="left",
                    right="right",
                    top="top"
                ),
                paper_orientation="paperOrientation",
                paper_size="paperSize"
            )
        )
    )
)

Attributes

section_based

The options that determine the default settings for a section-based layout configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultpaginatedlayoutconfiguration.html#cfn-quicksight-template-defaultpaginatedlayoutconfiguration-sectionbased

DefaultRelativeDateTimeControlOptionsProperty

class CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(*, commit_mode=None, display_options=None)

Bases: object

The default options that correspond to the RelativeDateTime filter control type.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultrelativedatetimecontroloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_relative_date_time_control_options_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
    commit_mode="commitMode",
    display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
        date_time_format="dateTimeFormat",
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    )
)

Attributes

commit_mode

The visibility configuration of the Apply button on a RelativeDateTimeControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultrelativedatetimecontroloptions.html#cfn-quicksight-template-defaultrelativedatetimecontroloptions-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultrelativedatetimecontroloptions.html#cfn-quicksight-template-defaultrelativedatetimecontroloptions-displayoptions

DefaultSectionBasedLayoutConfigurationProperty

class CfnTemplatePropsMixin.DefaultSectionBasedLayoutConfigurationProperty(*, canvas_size_options=None)

Bases: object

The options that determine the default settings for a section-based layout configuration.

Parameters:

canvas_size_options (Union[IResolvable, SectionBasedLayoutCanvasSizeOptionsProperty, Dict[str, Any], None]) – Determines the screen canvas size options for a section-based layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultsectionbasedlayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_section_based_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultSectionBasedLayoutConfigurationProperty(
    canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutCanvasSizeOptionsProperty(
        paper_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
            paper_margin=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                bottom="bottom",
                left="left",
                right="right",
                top="top"
            ),
            paper_orientation="paperOrientation",
            paper_size="paperSize"
        )
    )
)

Attributes

canvas_size_options

Determines the screen canvas size options for a section-based layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultsectionbasedlayoutconfiguration.html#cfn-quicksight-template-defaultsectionbasedlayoutconfiguration-canvassizeoptions

DefaultSliderControlOptionsProperty

class CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(*, display_options=None, maximum_value=None, minimum_value=None, step_size=None, type=None)

Bases: object

The default options that correspond to the Slider filter control type.

Parameters:

  • display_options (Union[IResolvable, SliderControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • maximum_value (Union[int, float, None]) – The larger value that is displayed at the right of the slider. Default: - 0

  • minimum_value (Union[int, float, None]) – The smaller value that is displayed at the left of the slider. Default: - 0

  • step_size (Union[int, float, None]) – The number of increments that the slider bar is divided into. Default: - 0

  • type (Optional[str]) – The type of the DefaultSliderControlOptions . Choose one of the following options:. - SINGLE_POINT : Filter against(equals) a single data point. - RANGE : Filter data that is in a specified range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_slider_control_options_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
    display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    maximum_value=123,
    minimum_value=123,
    step_size=123,
    type="type"
)

Attributes

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-displayoptions

maximum_value

The larger value that is displayed at the right of the slider.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-maximumvalue

minimum_value

The smaller value that is displayed at the left of the slider.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-minimumvalue

step_size

The number of increments that the slider bar is divided into.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaultslidercontroloptions.html#cfn-quicksight-template-defaultslidercontroloptions-stepsize

type

.

  • SINGLE_POINT : Filter against(equals) a single data point.

  • RANGE : Filter data that is in a specified range.

See:

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

Type:

The type of the DefaultSliderControlOptions . Choose one of the following options

DefaultTextAreaControlOptionsProperty

class CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(*, delimiter=None, display_options=None)

Bases: object

The default options that correspond to the TextArea filter control type.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaulttextareacontroloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_text_area_control_options_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
    delimiter="delimiter",
    display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    )
)

Attributes

delimiter

The delimiter that is used to separate the lines in text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaulttextareacontroloptions.html#cfn-quicksight-template-defaulttextareacontroloptions-delimiter

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaulttextareacontroloptions.html#cfn-quicksight-template-defaulttextareacontroloptions-displayoptions

DefaultTextFieldControlOptionsProperty

class CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(*, display_options=None)

Bases: object

The default options that correspond to the TextField filter control type.

Parameters:

display_options (Union[IResolvable, TextFieldControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaulttextfieldcontroloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

default_text_field_control_options_property = quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
    display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    )
)

Attributes

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-defaulttextfieldcontroloptions.html#cfn-quicksight-template-defaulttextfieldcontroloptions-displayoptions

DestinationParameterValueConfigurationProperty

class CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(*, custom_values_configuration=None, select_all_value_options=None, source_column=None, source_field=None, source_parameter_name=None)

Bases: object

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • custom_values_configuration (Union[IResolvable, CustomValuesConfigurationProperty, Dict[str, Any], None]) – The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

  • select_all_value_options (Optional[str]) – The configuration that selects all options.

  • source_column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – A column of a data set.

  • source_field (Optional[str]) – The source field ID of the destination parameter.

  • source_parameter_name (Optional[str]) – The source parameter name of the destination parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

destination_parameter_value_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(
    custom_values_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
        custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
            date_time_values=["dateTimeValues"],
            decimal_values=[123],
            integer_values=[123],
            string_values=["stringValues"]
        ),
        include_null_value=False
    ),
    select_all_value_options="selectAllValueOptions",
    source_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    source_field="sourceField",
    source_parameter_name="sourceParameterName"
)

Attributes

custom_values_configuration

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html#cfn-quicksight-template-destinationparametervalueconfiguration-customvaluesconfiguration

select_all_value_options

The configuration that selects all options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html#cfn-quicksight-template-destinationparametervalueconfiguration-selectallvalueoptions

source_column

A column of a data set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html#cfn-quicksight-template-destinationparametervalueconfiguration-sourcecolumn

source_field

The source field ID of the destination parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html#cfn-quicksight-template-destinationparametervalueconfiguration-sourcefield

source_parameter_name

The source parameter name of the destination parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-destinationparametervalueconfiguration.html#cfn-quicksight-template-destinationparametervalueconfiguration-sourceparametername

DimensionFieldProperty

class CfnTemplatePropsMixin.DimensionFieldProperty(*, categorical_dimension_field=None, date_dimension_field=None, numerical_dimension_field=None)

Bases: object

The dimension type field.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dimensionfield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

dimension_field_property = quicksight_mixins.CfnTemplatePropsMixin.DimensionFieldProperty(
    categorical_dimension_field=quicksight_mixins.CfnTemplatePropsMixin.CategoricalDimensionFieldProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        hierarchy_id="hierarchyId"
    ),
    date_dimension_field=quicksight_mixins.CfnTemplatePropsMixin.DateDimensionFieldProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        date_granularity="dateGranularity",
        field_id="fieldId",
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
            date_time_format="dateTimeFormat",
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        hierarchy_id="hierarchyId"
    ),
    numerical_dimension_field=quicksight_mixins.CfnTemplatePropsMixin.NumericalDimensionFieldProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        hierarchy_id="hierarchyId"
    )
)

Attributes

categorical_dimension_field

The dimension type field with categorical type columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dimensionfield.html#cfn-quicksight-template-dimensionfield-categoricaldimensionfield

date_dimension_field

The dimension type field with date type columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dimensionfield.html#cfn-quicksight-template-dimensionfield-datedimensionfield

numerical_dimension_field

The dimension type field with numerical type columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dimensionfield.html#cfn-quicksight-template-dimensionfield-numericaldimensionfield

DonutCenterOptionsProperty

class CfnTemplatePropsMixin.DonutCenterOptionsProperty(*, label_visibility=None)

Bases: object

The label options of the label that is displayed in the center of a donut chart.

This option isn’t available for pie charts.

Parameters:

label_visibility (Optional[str]) – Determines the visibility of the label in a donut chart. In the Quick Sight console, this option is called 'Show total' .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutcenteroptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

donut_center_options_property = quicksight_mixins.CfnTemplatePropsMixin.DonutCenterOptionsProperty(
    label_visibility="labelVisibility"
)

Attributes

label_visibility

Determines the visibility of the label in a donut chart.

In the Quick Sight console, this option is called 'Show total' .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutcenteroptions.html#cfn-quicksight-template-donutcenteroptions-labelvisibility

DonutOptionsProperty

class CfnTemplatePropsMixin.DonutOptionsProperty(*, arc_options=None, donut_center_options=None)

Bases: object

The options for configuring a donut chart or pie chart.

Parameters:

  • arc_options (Union[IResolvable, ArcOptionsProperty, Dict[str, Any], None]) – The option for define the arc of the chart shape. Valid values are as follows:. - WHOLE - A pie chart - SMALL - A small-sized donut chart - MEDIUM - A medium-sized donut chart - LARGE - A large-sized donut chart

  • donut_center_options (Union[IResolvable, DonutCenterOptionsProperty, Dict[str, Any], None]) – The label options of the label that is displayed in the center of a donut chart. This option isn’t available for pie charts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

donut_options_property = quicksight_mixins.CfnTemplatePropsMixin.DonutOptionsProperty(
    arc_options=quicksight_mixins.CfnTemplatePropsMixin.ArcOptionsProperty(
        arc_thickness="arcThickness"
    ),
    donut_center_options=quicksight_mixins.CfnTemplatePropsMixin.DonutCenterOptionsProperty(
        label_visibility="labelVisibility"
    )
)

Attributes

arc_options

.

  • WHOLE - A pie chart

  • SMALL - A small-sized donut chart

  • MEDIUM - A medium-sized donut chart

  • LARGE - A large-sized donut chart

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutoptions.html#cfn-quicksight-template-donutoptions-arcoptions

Type:

The option for define the arc of the chart shape. Valid values are as follows

donut_center_options

The label options of the label that is displayed in the center of a donut chart.

This option isn’t available for pie charts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutoptions.html#cfn-quicksight-template-donutoptions-donutcenteroptions

DrillDownFilterProperty

class CfnTemplatePropsMixin.DrillDownFilterProperty(*, category_filter=None, numeric_equality_filter=None, time_range_filter=None)

Bases: object

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-drilldownfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

drill_down_filter_property = quicksight_mixins.CfnTemplatePropsMixin.DrillDownFilterProperty(
    category_filter=quicksight_mixins.CfnTemplatePropsMixin.CategoryDrillDownFilterProperty(
        category_values=["categoryValues"],
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    ),
    numeric_equality_filter=quicksight_mixins.CfnTemplatePropsMixin.NumericEqualityDrillDownFilterProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        value=123
    ),
    time_range_filter=quicksight_mixins.CfnTemplatePropsMixin.TimeRangeDrillDownFilterProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        range_maximum="rangeMaximum",
        range_minimum="rangeMinimum",
        time_granularity="timeGranularity"
    )
)

Attributes

category_filter

The category type drill down filter.

This filter is used for string type columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-drilldownfilter.html#cfn-quicksight-template-drilldownfilter-categoryfilter

numeric_equality_filter

The numeric equality type drill down filter.

This filter is used for number type columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-drilldownfilter.html#cfn-quicksight-template-drilldownfilter-numericequalityfilter

time_range_filter

The time range drill down filter.

This filter is used for date time columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-drilldownfilter.html#cfn-quicksight-template-drilldownfilter-timerangefilter

DynamicDefaultValueProperty

class CfnTemplatePropsMixin.DynamicDefaultValueProperty(*, default_value_column=None, group_name_column=None, user_name_column=None)

Bases: object

Defines different defaults to the users or groups based on mapping.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dynamicdefaultvalue.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

dynamic_default_value_property = quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
    default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    )
)

Attributes

default_value_column

The column that contains the default value of each user or group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dynamicdefaultvalue.html#cfn-quicksight-template-dynamicdefaultvalue-defaultvaluecolumn

group_name_column

The column that contains the group name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dynamicdefaultvalue.html#cfn-quicksight-template-dynamicdefaultvalue-groupnamecolumn

user_name_column

The column that contains the username.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-dynamicdefaultvalue.html#cfn-quicksight-template-dynamicdefaultvalue-usernamecolumn

EmptyVisualProperty

class CfnTemplatePropsMixin.EmptyVisualProperty(*, actions=None, data_set_identifier=None, visual_id=None)

Bases: object

An empty visual.

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Quick Sight console is considered an EmptyVisual until a visual type is selected.

Parameters:

  • actions (Union[IResolvable, Sequence[Union[IResolvable, VisualCustomActionProperty, Dict[str, Any]]], None]) – The list of custom actions that are configured for a visual.

  • data_set_identifier (Optional[str]) – The data set that is used in the empty visual. Every visual requires a dataset to render.

  • visual_id (Optional[str]) – The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-emptyvisual.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

empty_visual_property = quicksight_mixins.CfnTemplatePropsMixin.EmptyVisualProperty(
    actions=[quicksight_mixins.CfnTemplatePropsMixin.VisualCustomActionProperty(
        action_operations=[quicksight_mixins.CfnTemplatePropsMixin.VisualCustomActionOperationProperty(
            filter_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionFilterOperationProperty(
                selected_fields_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterOperationSelectedFieldsConfigurationProperty(
                    selected_columns=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    )],
                    selected_field_options="selectedFieldOptions",
                    selected_fields=["selectedFields"]
                ),
                target_visuals_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterOperationTargetVisualsConfigurationProperty(
                    same_sheet_target_visual_configuration=quicksight_mixins.CfnTemplatePropsMixin.SameSheetTargetVisualConfigurationProperty(
                        target_visual_options="targetVisualOptions",
                        target_visuals=["targetVisuals"]
                    )
                )
            ),
            navigation_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionNavigationOperationProperty(
                local_navigation_configuration=quicksight_mixins.CfnTemplatePropsMixin.LocalNavigationConfigurationProperty(
                    target_sheet_id="targetSheetId"
                )
            ),
            set_parameters_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionSetParametersOperationProperty(
                parameter_value_configurations=[quicksight_mixins.CfnTemplatePropsMixin.SetParameterValueConfigurationProperty(
                    destination_parameter_name="destinationParameterName",
                    value=quicksight_mixins.CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(
                        custom_values_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
                            custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
                                date_time_values=["dateTimeValues"],
                                decimal_values=[123],
                                integer_values=[123],
                                string_values=["stringValues"]
                            ),
                            include_null_value=False
                        ),
                        select_all_value_options="selectAllValueOptions",
                        source_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                            column_name="columnName",
                            data_set_identifier="dataSetIdentifier"
                        ),
                        source_field="sourceField",
                        source_parameter_name="sourceParameterName"
                    )
                )]
            ),
            url_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionURLOperationProperty(
                url_target="urlTarget",
                url_template="urlTemplate"
            )
        )],
        custom_action_id="customActionId",
        name="name",
        status="status",
        trigger="trigger"
    )],
    data_set_identifier="dataSetIdentifier",
    visual_id="visualId"
)

Attributes

actions

The list of custom actions that are configured for a visual.

See:

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

data_set_identifier

The data set that is used in the empty visual.

Every visual requires a dataset to render.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-emptyvisual.html#cfn-quicksight-template-emptyvisual-datasetidentifier

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-emptyvisual.html#cfn-quicksight-template-emptyvisual-visualid

EntityProperty

class CfnTemplatePropsMixin.EntityProperty(*, path=None)

Bases: object

An object, structure, or sub-structure of an analysis, template, or dashboard.

Parameters:

path (Optional[str]) – The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-entity.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

entity_property = quicksight_mixins.CfnTemplatePropsMixin.EntityProperty(
    path="path"
)

Attributes

path

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-entity.html#cfn-quicksight-template-entity-path

ExcludePeriodConfigurationProperty

class CfnTemplatePropsMixin.ExcludePeriodConfigurationProperty(*, amount=None, granularity=None, status=None)

Bases: object

The exclude period of TimeRangeFilter or RelativeDatesFilter .

Parameters:

  • amount (Union[int, float, None]) – The amount or number of the exclude period.

  • granularity (Optional[str]) – The granularity or unit (day, month, year) of the exclude period.

  • status (Optional[str]) – The status of the exclude period. Choose from the following options:. - ENABLED - DISABLED

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-excludeperiodconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

exclude_period_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ExcludePeriodConfigurationProperty(
    amount=123,
    granularity="granularity",
    status="status"
)

Attributes

amount

The amount or number of the exclude period.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-excludeperiodconfiguration.html#cfn-quicksight-template-excludeperiodconfiguration-amount

granularity

The granularity or unit (day, month, year) of the exclude period.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-excludeperiodconfiguration.html#cfn-quicksight-template-excludeperiodconfiguration-granularity

status

.

  • ENABLED

  • DISABLED

See:

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

Type:

The status of the exclude period. Choose from the following options

ExplicitHierarchyProperty

class CfnTemplatePropsMixin.ExplicitHierarchyProperty(*, columns=None, drill_down_filters=None, hierarchy_id=None)

Bases: object

The option that determines the hierarchy of the fields that are built within a visual’s field wells.

These fields can’t be duplicated to other visuals.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-explicithierarchy.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

explicit_hierarchy_property = quicksight_mixins.CfnTemplatePropsMixin.ExplicitHierarchyProperty(
    columns=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    )],
    drill_down_filters=[quicksight_mixins.CfnTemplatePropsMixin.DrillDownFilterProperty(
        category_filter=quicksight_mixins.CfnTemplatePropsMixin.CategoryDrillDownFilterProperty(
            category_values=["categoryValues"],
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        numeric_equality_filter=quicksight_mixins.CfnTemplatePropsMixin.NumericEqualityDrillDownFilterProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            value=123
        ),
        time_range_filter=quicksight_mixins.CfnTemplatePropsMixin.TimeRangeDrillDownFilterProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            range_maximum="rangeMaximum",
            range_minimum="rangeMinimum",
            time_granularity="timeGranularity"
        )
    )],
    hierarchy_id="hierarchyId"
)

Attributes

columns

The list of columns that define the explicit hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-explicithierarchy.html#cfn-quicksight-template-explicithierarchy-columns

drill_down_filters

The option that determines the drill down filters for the explicit hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-explicithierarchy.html#cfn-quicksight-template-explicithierarchy-drilldownfilters

hierarchy_id

The hierarchy ID of the explicit hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-explicithierarchy.html#cfn-quicksight-template-explicithierarchy-hierarchyid

FieldBasedTooltipProperty

class CfnTemplatePropsMixin.FieldBasedTooltipProperty(*, aggregation_visibility=None, tooltip_fields=None, tooltip_title_type=None)

Bases: object

The setup for the detailed tooltip.

Parameters:

  • aggregation_visibility (Optional[str]) – The visibility of Show aggregations .

  • tooltip_fields (Union[IResolvable, Sequence[Union[IResolvable, TooltipItemProperty, Dict[str, Any]]], None]) – The fields configuration in the tooltip.

  • tooltip_title_type (Optional[str]) – The type for the >tooltip title. Choose one of the following options:. - NONE : Doesn’t use the primary value as the title. - PRIMARY_VALUE : Uses primary value as the title.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldbasedtooltip.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

field_based_tooltip_property = quicksight_mixins.CfnTemplatePropsMixin.FieldBasedTooltipProperty(
    aggregation_visibility="aggregationVisibility",
    tooltip_fields=[quicksight_mixins.CfnTemplatePropsMixin.TooltipItemProperty(
        column_tooltip_item=quicksight_mixins.CfnTemplatePropsMixin.ColumnTooltipItemProperty(
            aggregation=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            label="label",
            tooltip_target="tooltipTarget",
            visibility="visibility"
        ),
        field_tooltip_item=quicksight_mixins.CfnTemplatePropsMixin.FieldTooltipItemProperty(
            field_id="fieldId",
            label="label",
            tooltip_target="tooltipTarget",
            visibility="visibility"
        )
    )],
    tooltip_title_type="tooltipTitleType"
)

Attributes

aggregation_visibility

The visibility of Show aggregations .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldbasedtooltip.html#cfn-quicksight-template-fieldbasedtooltip-aggregationvisibility

tooltip_fields

The fields configuration in the tooltip.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldbasedtooltip.html#cfn-quicksight-template-fieldbasedtooltip-tooltipfields

tooltip_title_type

.

  • NONE : Doesn’t use the primary value as the title.

  • PRIMARY_VALUE : Uses primary value as the title.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldbasedtooltip.html#cfn-quicksight-template-fieldbasedtooltip-tooltiptitletype

Type:

The type for the >tooltip title. Choose one of the following options

FieldLabelTypeProperty

class CfnTemplatePropsMixin.FieldLabelTypeProperty(*, field_id=None, visibility=None)

Bases: object

The field label type.

Parameters:

  • field_id (Optional[str]) – Indicates the field that is targeted by the field label.

  • visibility (Optional[str]) – The visibility of the field label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldlabeltype.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

field_label_type_property = quicksight_mixins.CfnTemplatePropsMixin.FieldLabelTypeProperty(
    field_id="fieldId",
    visibility="visibility"
)

Attributes

field_id

Indicates the field that is targeted by the field label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldlabeltype.html#cfn-quicksight-template-fieldlabeltype-fieldid

visibility

The visibility of the field label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldlabeltype.html#cfn-quicksight-template-fieldlabeltype-visibility

FieldSeriesItemProperty

class CfnTemplatePropsMixin.FieldSeriesItemProperty(*, axis_binding=None, field_id=None, settings=None)

Bases: object

The field series item configuration of a line chart.

Parameters:

  • axis_binding (Optional[str]) – The axis that you are binding the field to.

  • field_id (Optional[str]) – The field ID of the field for which you are setting the axis binding.

  • settings (Union[IResolvable, LineChartSeriesSettingsProperty, Dict[str, Any], None]) – The options that determine the presentation of line series associated to the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldseriesitem.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

field_series_item_property = quicksight_mixins.CfnTemplatePropsMixin.FieldSeriesItemProperty(
    axis_binding="axisBinding",
    field_id="fieldId",
    settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartSeriesSettingsProperty(
        line_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartLineStyleSettingsProperty(
            line_interpolation="lineInterpolation",
            line_style="lineStyle",
            line_visibility="lineVisibility",
            line_width="lineWidth"
        ),
        marker_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartMarkerStyleSettingsProperty(
            marker_color="markerColor",
            marker_shape="markerShape",
            marker_size="markerSize",
            marker_visibility="markerVisibility"
        )
    )
)

Attributes

axis_binding

The axis that you are binding the field to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldseriesitem.html#cfn-quicksight-template-fieldseriesitem-axisbinding

field_id

The field ID of the field for which you are setting the axis binding.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldseriesitem.html#cfn-quicksight-template-fieldseriesitem-fieldid

settings

The options that determine the presentation of line series associated to the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldseriesitem.html#cfn-quicksight-template-fieldseriesitem-settings

FieldSortOptionsProperty

class CfnTemplatePropsMixin.FieldSortOptionsProperty(*, column_sort=None, field_sort=None)

Bases: object

The field sort options in a chart configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsortoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

field_sort_options_property = quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
    column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
        aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        ),
        direction="direction",
        sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    ),
    field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
        direction="direction",
        field_id="fieldId"
    )
)

Attributes

column_sort

The sort configuration for a column that is not used in a field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsortoptions.html#cfn-quicksight-template-fieldsortoptions-columnsort

field_sort

The sort configuration for a field in a field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsortoptions.html#cfn-quicksight-template-fieldsortoptions-fieldsort

FieldSortProperty

class CfnTemplatePropsMixin.FieldSortProperty(*, direction=None, field_id=None)

Bases: object

The sort configuration for a field in a field well.

Parameters:

  • direction (Optional[str]) – The sort direction. Choose one of the following options:. - ASC : Ascending - DESC : Descending

  • field_id (Optional[str]) – The sort configuration target field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsort.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

field_sort_property = quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
    direction="direction",
    field_id="fieldId"
)

Attributes

direction

.

  • ASC : Ascending

  • DESC : Descending

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsort.html#cfn-quicksight-template-fieldsort-direction

Type:

The sort direction. Choose one of the following options

field_id

The sort configuration target field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldsort.html#cfn-quicksight-template-fieldsort-fieldid

FieldTooltipItemProperty

class CfnTemplatePropsMixin.FieldTooltipItemProperty(*, field_id=None, label=None, tooltip_target=None, visibility=None)

Bases: object

The tooltip item for the fields.

Parameters:

  • field_id (Optional[str]) – The unique ID of the field that is targeted by the tooltip.

  • label (Optional[str]) – The label of the tooltip item.

  • tooltip_target (Optional[str]) – Determines the target of the field tooltip item in a combo chart visual.

  • visibility (Optional[str]) – The visibility of the tooltip item.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldtooltipitem.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

field_tooltip_item_property = quicksight_mixins.CfnTemplatePropsMixin.FieldTooltipItemProperty(
    field_id="fieldId",
    label="label",
    tooltip_target="tooltipTarget",
    visibility="visibility"
)

Attributes

field_id

The unique ID of the field that is targeted by the tooltip.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldtooltipitem.html#cfn-quicksight-template-fieldtooltipitem-fieldid

label

The label of the tooltip item.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldtooltipitem.html#cfn-quicksight-template-fieldtooltipitem-label

tooltip_target

Determines the target of the field tooltip item in a combo chart visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldtooltipitem.html#cfn-quicksight-template-fieldtooltipitem-tooltiptarget

visibility

The visibility of the tooltip item.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fieldtooltipitem.html#cfn-quicksight-template-fieldtooltipitem-visibility

FilledMapAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.FilledMapAggregatedFieldWellsProperty(*, geospatial=None, values=None)

Bases: object

The aggregated field well of the filled map.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
geospatial

The aggregated location field well of the filled map.

Values are grouped by location fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapaggregatedfieldwells.html#cfn-quicksight-template-filledmapaggregatedfieldwells-geospatial

values

The aggregated color field well of a filled map.

Values are aggregated based on location fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapaggregatedfieldwells.html#cfn-quicksight-template-filledmapaggregatedfieldwells-values

FilledMapConditionalFormattingOptionProperty

class CfnTemplatePropsMixin.FilledMapConditionalFormattingOptionProperty(*, shape=None)

Bases: object

Conditional formatting options of a FilledMapVisual .

Parameters:

shape (Union[IResolvable, FilledMapShapeConditionalFormattingProperty, Dict[str, Any], None]) – The conditional formatting that determines the shape of the filled map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconditionalformattingoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filled_map_conditional_formatting_option_property = quicksight_mixins.CfnTemplatePropsMixin.FilledMapConditionalFormattingOptionProperty(
    shape=quicksight_mixins.CfnTemplatePropsMixin.FilledMapShapeConditionalFormattingProperty(
        field_id="fieldId",
        format=quicksight_mixins.CfnTemplatePropsMixin.ShapeConditionalFormatProperty(
            background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            )
        )
    )
)

Attributes

shape

The conditional formatting that determines the shape of the filled map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconditionalformattingoption.html#cfn-quicksight-template-filledmapconditionalformattingoption-shape

FilledMapConditionalFormattingProperty

class CfnTemplatePropsMixin.FilledMapConditionalFormattingProperty(*, conditional_formatting_options=None)

Bases: object

The conditional formatting of a FilledMapVisual .

Parameters:

conditional_formatting_options (Union[IResolvable, Sequence[Union[IResolvable, FilledMapConditionalFormattingOptionProperty, Dict[str, Any]]], None]) – Conditional formatting options of a FilledMapVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filled_map_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.FilledMapConditionalFormattingProperty(
    conditional_formatting_options=[quicksight_mixins.CfnTemplatePropsMixin.FilledMapConditionalFormattingOptionProperty(
        shape=quicksight_mixins.CfnTemplatePropsMixin.FilledMapShapeConditionalFormattingProperty(
            field_id="fieldId",
            format=quicksight_mixins.CfnTemplatePropsMixin.ShapeConditionalFormatProperty(
                background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                    gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                        color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                            stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                                color="color",
                                data_value=123,
                                gradient_offset=123
                            )]
                        ),
                        expression="expression"
                    ),
                    solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                        color="color",
                        expression="expression"
                    )
                )
            )
        )
    )]
)

Attributes

conditional_formatting_options

Conditional formatting options of a FilledMapVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconditionalformatting.html#cfn-quicksight-template-filledmapconditionalformatting-conditionalformattingoptions

FilledMapConfigurationProperty

class CfnTemplatePropsMixin.FilledMapConfigurationProperty(*, field_wells=None, interactions=None, legend=None, map_style_options=None, sort_configuration=None, tooltip=None, window_options=None)

Bases: object

The configuration for a FilledMapVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-interactions

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-legend

map_style_options

The map style options of the filled map visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-mapstyleoptions

sort_configuration

The sort configuration of a FilledMapVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-sortconfiguration

tooltip

The tooltip display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-tooltip

window_options

The window options of the filled map visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapconfiguration.html#cfn-quicksight-template-filledmapconfiguration-windowoptions

FilledMapFieldWellsProperty

class CfnTemplatePropsMixin.FilledMapFieldWellsProperty(*, filled_map_aggregated_field_wells=None)

Bases: object

The field wells of a FilledMapVisual .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

filled_map_aggregated_field_wells (Union[IResolvable, FilledMapAggregatedFieldWellsProperty, Dict[str, Any], None]) – The aggregated field well of the filled map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
filled_map_aggregated_field_wells

The aggregated field well of the filled map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapfieldwells.html#cfn-quicksight-template-filledmapfieldwells-filledmapaggregatedfieldwells

FilledMapShapeConditionalFormattingProperty

class CfnTemplatePropsMixin.FilledMapShapeConditionalFormattingProperty(*, field_id=None, format=None)

Bases: object

The conditional formatting that determines the shape of the filled map.

Parameters:

  • field_id (Optional[str]) – The field ID of the filled map shape.

  • format (Union[IResolvable, ShapeConditionalFormatProperty, Dict[str, Any], None]) – The conditional formatting that determines the background color of a filled map’s shape.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapshapeconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filled_map_shape_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.FilledMapShapeConditionalFormattingProperty(
    field_id="fieldId",
    format=quicksight_mixins.CfnTemplatePropsMixin.ShapeConditionalFormatProperty(
        background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        )
    )
)

Attributes

field_id

The field ID of the filled map shape.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapshapeconditionalformatting.html#cfn-quicksight-template-filledmapshapeconditionalformatting-fieldid

format

The conditional formatting that determines the background color of a filled map’s shape.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapshapeconditionalformatting.html#cfn-quicksight-template-filledmapshapeconditionalformatting-format

FilledMapSortConfigurationProperty

class CfnTemplatePropsMixin.FilledMapSortConfigurationProperty(*, category_sort=None)

Bases: object

The sort configuration of a FilledMapVisual .

Parameters:

category_sort (Union[IResolvable, Sequence[Union[IResolvable, FieldSortOptionsProperty, Dict[str, Any]]], None]) – The sort configuration of the location fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filled_map_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.FilledMapSortConfigurationProperty(
    category_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

category_sort

The sort configuration of the location fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapsortconfiguration.html#cfn-quicksight-template-filledmapsortconfiguration-categorysort

FilledMapVisualProperty

class CfnTemplatePropsMixin.FilledMapVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, conditional_formatting=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A filled map.

For more information, see Creating filled maps in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-columnhierarchies

conditional_formatting

The conditional formatting of a FilledMapVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-conditionalformatting

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filledmapvisual.html#cfn-quicksight-template-filledmapvisual-visualid

FilterControlProperty

class CfnTemplatePropsMixin.FilterControlProperty(*, cross_sheet=None, date_time_picker=None, dropdown=None, list=None, relative_date_time=None, slider=None, text_area=None, text_field=None)

Bases: object

The control of a filter that is used to interact with a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

filter_control_property = quicksight_mixins.CfnTemplatePropsMixin.FilterControlProperty(
    cross_sheet=quicksight_mixins.CfnTemplatePropsMixin.FilterCrossSheetControlProperty(
        cascading_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
            source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
                column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_sheet_control_id="sourceSheetControlId"
            )]
        ),
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId"
    ),
    date_time_picker=quicksight_mixins.CfnTemplatePropsMixin.FilterDateTimePickerControlProperty(
        commit_mode="commitMode",
        display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
            date_icon_visibility=date_icon_visibility,
            date_time_format="dateTimeFormat",
            helper_text_visibility=helper_text_visibility,
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",
        title="title",
        type="type"
    ),
    dropdown=quicksight_mixins.CfnTemplatePropsMixin.FilterDropDownControlProperty(
        cascading_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
            source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
                column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_sheet_control_id="sourceSheetControlId"
            )]
        ),
        commit_mode="commitMode",
        display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        filter_control_id="filterControlId",
        selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
            values=["values"]
        ),
        source_filter_id="sourceFilterId",
        title="title",
        type="type"
    ),
    list=quicksight_mixins.CfnTemplatePropsMixin.FilterListControlProperty(
        cascading_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
            source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
                column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_sheet_control_id="sourceSheetControlId"
            )]
        ),
        display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                visibility="visibility"
            ),
            select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        filter_control_id="filterControlId",
        selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
            values=["values"]
        ),
        source_filter_id="sourceFilterId",
        title="title",
        type="type"
    ),
    relative_date_time=quicksight_mixins.CfnTemplatePropsMixin.FilterRelativeDateTimeControlProperty(
        commit_mode="commitMode",
        display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
            date_time_format="dateTimeFormat",
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",
        title="title"
    ),
    slider=quicksight_mixins.CfnTemplatePropsMixin.FilterSliderControlProperty(
        display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        filter_control_id="filterControlId",
        maximum_value=123,
        minimum_value=123,
        source_filter_id="sourceFilterId",
        step_size=123,
        title="title",
        type="type"
    ),
    text_area=quicksight_mixins.CfnTemplatePropsMixin.FilterTextAreaControlProperty(
        delimiter="delimiter",
        display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",
        title="title"
    ),
    text_field=quicksight_mixins.CfnTemplatePropsMixin.FilterTextFieldControlProperty(
        display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",
        title="title"
    )
)

Attributes

cross_sheet

A control from a filter that is scoped across more than one sheet.

This represents your filter control on a sheet

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-crosssheet

date_time_picker

A control from a date filter that is used to specify date and time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-datetimepicker

dropdown

A control to display a dropdown list with buttons that are used to select a single value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-dropdown

list

A control to display a list of buttons or boxes.

This is used to select either a single value or multiple values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-list

relative_date_time

A control from a date filter that is used to specify the relative date.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-relativedatetime

slider

A control to display a horizontal toggle bar.

This is used to change a value by sliding the toggle.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-slider

text_area

A control to display a text box that is used to enter multiple entries.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-textarea

text_field

A control to display a text box that is used to enter a single entry.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercontrol.html#cfn-quicksight-template-filtercontrol-textfield

FilterCrossSheetControlProperty

class CfnTemplatePropsMixin.FilterCrossSheetControlProperty(*, cascading_control_configuration=None, filter_control_id=None, source_filter_id=None)

Bases: object

A control from a filter that is scoped across more than one sheet.

This represents your filter control on a sheet

Parameters:

  • cascading_control_configuration (Union[IResolvable, CascadingControlConfigurationProperty, Dict[str, Any], None]) – The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

  • filter_control_id (Optional[str]) – The ID of the FilterCrossSheetControl .

  • source_filter_id (Optional[str]) – The source filter ID of the FilterCrossSheetControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercrosssheetcontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_cross_sheet_control_property = quicksight_mixins.CfnTemplatePropsMixin.FilterCrossSheetControlProperty(
    cascading_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
        source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
            column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_sheet_control_id="sourceSheetControlId"
        )]
    ),
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId"
)

Attributes

cascading_control_configuration

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercrosssheetcontrol.html#cfn-quicksight-template-filtercrosssheetcontrol-cascadingcontrolconfiguration

filter_control_id

The ID of the FilterCrossSheetControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercrosssheetcontrol.html#cfn-quicksight-template-filtercrosssheetcontrol-filtercontrolid

source_filter_id

The source filter ID of the FilterCrossSheetControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtercrosssheetcontrol.html#cfn-quicksight-template-filtercrosssheetcontrol-sourcefilterid

FilterDateTimePickerControlProperty

class CfnTemplatePropsMixin.FilterDateTimePickerControlProperty(*, commit_mode=None, display_options=None, filter_control_id=None, source_filter_id=None, title=None, type=None)

Bases: object

A control from a date filter that is used to specify date and time.

Parameters:

  • commit_mode (Optional[str]) – The visibility configurationof the Apply button on a DateTimePickerControl .

  • display_options (Union[IResolvable, DateTimePickerControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • filter_control_id (Optional[str]) – The ID of the FilterDateTimePickerControl .

  • source_filter_id (Optional[str]) – The source filter ID of the FilterDateTimePickerControl .

  • title (Optional[str]) – The title of the FilterDateTimePickerControl .

  • type (Optional[str]) – The type of the FilterDropDownControl . Choose one of the following options:. - MULTI_SELECT : The user can select multiple entries from a dropdown menu. - SINGLE_SELECT : The user can select a single entry from a dropdown menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

filter_date_time_picker_control_property = quicksight_mixins.CfnTemplatePropsMixin.FilterDateTimePickerControlProperty(
    commit_mode="commitMode",
    display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
        date_icon_visibility=date_icon_visibility,
        date_time_format="dateTimeFormat",
        helper_text_visibility=helper_text_visibility,
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",
    title="title",
    type="type"
)

Attributes

commit_mode

The visibility configurationof the Apply button on a DateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-displayoptions

filter_control_id

The ID of the FilterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-filtercontrolid

source_filter_id

The source filter ID of the FilterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-sourcefilterid

title

The title of the FilterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdatetimepickercontrol.html#cfn-quicksight-template-filterdatetimepickercontrol-title

type

.

  • MULTI_SELECT : The user can select multiple entries from a dropdown menu.

  • SINGLE_SELECT : The user can select a single entry from a dropdown menu.

See:

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

Type:

The type of the FilterDropDownControl . Choose one of the following options

FilterDropDownControlProperty

class CfnTemplatePropsMixin.FilterDropDownControlProperty(*, cascading_control_configuration=None, commit_mode=None, display_options=None, filter_control_id=None, selectable_values=None, source_filter_id=None, title=None, type=None)

Bases: object

A control to display a dropdown list with buttons that are used to select a single value.

Parameters:

  • cascading_control_configuration (Union[IResolvable, CascadingControlConfigurationProperty, Dict[str, Any], None]) – The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

  • commit_mode (Optional[str]) – The visibility configuration of the Apply button on a FilterDropDownControl .

  • display_options (Union[IResolvable, DropDownControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of the FilterDropDownControl .

  • filter_control_id (Optional[str]) – The ID of the FilterDropDownControl .

  • selectable_values (Union[IResolvable, FilterSelectableValuesProperty, Dict[str, Any], None]) – A list of selectable values that are used in a control.

  • source_filter_id (Optional[str]) – The source filter ID of the FilterDropDownControl .

  • title (Optional[str]) – The title of the FilterDropDownControl .

  • type (Optional[str]) – The type of the FilterDropDownControl . Choose one of the following options:. - MULTI_SELECT : The user can select multiple entries from a dropdown menu. - SINGLE_SELECT : The user can select a single entry from a dropdown menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_drop_down_control_property = quicksight_mixins.CfnTemplatePropsMixin.FilterDropDownControlProperty(
    cascading_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
        source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
            column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_sheet_control_id="sourceSheetControlId"
        )]
    ),
    commit_mode="commitMode",
    display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    filter_control_id="filterControlId",
    selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
        values=["values"]
    ),
    source_filter_id="sourceFilterId",
    title="title",
    type="type"
)

Attributes

cascading_control_configuration

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-cascadingcontrolconfiguration

commit_mode

The visibility configuration of the Apply button on a FilterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-commitmode

display_options

The display options of the FilterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-displayoptions

filter_control_id

The ID of the FilterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-filtercontrolid

selectable_values

A list of selectable values that are used in a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-selectablevalues

source_filter_id

The source filter ID of the FilterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-sourcefilterid

title

The title of the FilterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterdropdowncontrol.html#cfn-quicksight-template-filterdropdowncontrol-title

type

.

  • MULTI_SELECT : The user can select multiple entries from a dropdown menu.

  • SINGLE_SELECT : The user can select a single entry from a dropdown menu.

See:

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

Type:

The type of the FilterDropDownControl . Choose one of the following options

FilterGroupProperty

class CfnTemplatePropsMixin.FilterGroupProperty(*, cross_dataset=None, filter_group_id=None, filters=None, scope_configuration=None, status=None)

Bases: object

A grouping of individual filters. Filter groups are applied to the same group of visuals.

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon Quick Suite User Guide .

Parameters:

  • cross_dataset (Optional[str]) – The filter new feature which can apply filter group to all data sets. Choose one of the following options:. - ALL_DATASETS - SINGLE_DATASET

  • filter_group_id (Optional[str]) – The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

  • filters (Union[IResolvable, Sequence[Union[IResolvable, FilterProperty, Dict[str, Any]]], None]) – The list of filters that are present in a FilterGroup .

  • scope_configuration (Union[IResolvable, FilterScopeConfigurationProperty, Dict[str, Any], None]) – The configuration that specifies what scope to apply to a FilterGroup . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

  • status (Optional[str]) – The status of the FilterGroup .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
cross_dataset

.

  • ALL_DATASETS

  • SINGLE_DATASET

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html#cfn-quicksight-template-filtergroup-crossdataset

Type:

The filter new feature which can apply filter group to all data sets. Choose one of the following options

filter_group_id

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html#cfn-quicksight-template-filtergroup-filtergroupid

filters

The list of filters that are present in a FilterGroup .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html#cfn-quicksight-template-filtergroup-filters

scope_configuration

The configuration that specifies what scope to apply to a FilterGroup .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtergroup.html#cfn-quicksight-template-filtergroup-scopeconfiguration

status

The status of the FilterGroup .

See:

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

FilterListConfigurationProperty

class CfnTemplatePropsMixin.FilterListConfigurationProperty(*, category_values=None, match_operator=None, null_option=None, select_all_options=None)

Bases: object

A list of filter configurations.

Parameters:

  • category_values (Optional[Sequence[str]]) – The list of category values for the filter.

  • match_operator (Optional[str]) – The match operator that is used to determine if a filter should be applied.

  • null_option (Optional[str]) – This option determines how null values should be treated when filtering data. - ALL_VALUES : Include null values in filtered results. - NULLS_ONLY : Only include null values in filtered results. - NON_NULLS_ONLY : Exclude null values from filtered results.

  • select_all_options (Optional[str]) – Select all of the values. Null is not the assigned value of select all. - FILTER_ALL_VALUES

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_list_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.FilterListConfigurationProperty(
    category_values=["categoryValues"],
    match_operator="matchOperator",
    null_option="nullOption",
    select_all_options="selectAllOptions"
)

Attributes

category_values

The list of category values for the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistconfiguration.html#cfn-quicksight-template-filterlistconfiguration-categoryvalues

match_operator

The match operator that is used to determine if a filter should be applied.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistconfiguration.html#cfn-quicksight-template-filterlistconfiguration-matchoperator

null_option

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.

  • NULLS_ONLY : Only include null values in filtered results.

  • NON_NULLS_ONLY : Exclude null values from filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistconfiguration.html#cfn-quicksight-template-filterlistconfiguration-nulloption

select_all_options

Select all of the values. Null is not the assigned value of select all.

  • FILTER_ALL_VALUES

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistconfiguration.html#cfn-quicksight-template-filterlistconfiguration-selectalloptions

FilterListControlProperty

class CfnTemplatePropsMixin.FilterListControlProperty(*, cascading_control_configuration=None, display_options=None, filter_control_id=None, selectable_values=None, source_filter_id=None, title=None, type=None)

Bases: object

A control to display a list of buttons or boxes.

This is used to select either a single value or multiple values.

Parameters:

  • cascading_control_configuration (Union[IResolvable, CascadingControlConfigurationProperty, Dict[str, Any], None]) – The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

  • display_options (Union[IResolvable, ListControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • filter_control_id (Optional[str]) – The ID of the FilterListControl .

  • selectable_values (Union[IResolvable, FilterSelectableValuesProperty, Dict[str, Any], None]) – A list of selectable values that are used in a control.

  • source_filter_id (Optional[str]) – The source filter ID of the FilterListControl .

  • title (Optional[str]) – The title of the FilterListControl .

  • type (Optional[str]) – The type of the FilterListControl . Choose one of the following options:. - MULTI_SELECT : The user can select multiple entries from the list. - SINGLE_SELECT : The user can select a single entry from the list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_list_control_property = quicksight_mixins.CfnTemplatePropsMixin.FilterListControlProperty(
    cascading_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
        source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
            column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_sheet_control_id="sourceSheetControlId"
        )]
    ),
    display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
            visibility="visibility"
        ),
        select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    filter_control_id="filterControlId",
    selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
        values=["values"]
    ),
    source_filter_id="sourceFilterId",
    title="title",
    type="type"
)

Attributes

cascading_control_configuration

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-cascadingcontrolconfiguration

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-displayoptions

filter_control_id

The ID of the FilterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-filtercontrolid

selectable_values

A list of selectable values that are used in a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-selectablevalues

source_filter_id

The source filter ID of the FilterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-sourcefilterid

title

The title of the FilterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterlistcontrol.html#cfn-quicksight-template-filterlistcontrol-title

type

.

  • MULTI_SELECT : The user can select multiple entries from the list.

  • SINGLE_SELECT : The user can select a single entry from the list.

See:

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

Type:

The type of the FilterListControl . Choose one of the following options

FilterOperationSelectedFieldsConfigurationProperty

class CfnTemplatePropsMixin.FilterOperationSelectedFieldsConfigurationProperty(*, selected_columns=None, selected_field_options=None, selected_fields=None)

Bases: object

The configuration of selected fields in the CustomActionFilterOperation .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • selected_columns (Union[IResolvable, Sequence[Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any]]], None]) – The selected columns of a dataset.

  • selected_field_options (Optional[str]) – A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation . Valid values are defined as follows: - ALL_FIELDS : Applies the filter operation to all fields.

  • selected_fields (Optional[Sequence[str]]) – Chooses the fields that are filtered in CustomActionFilterOperation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationselectedfieldsconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_operation_selected_fields_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.FilterOperationSelectedFieldsConfigurationProperty(
    selected_columns=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    )],
    selected_field_options="selectedFieldOptions",
    selected_fields=["selectedFields"]
)

Attributes

selected_columns

The selected columns of a dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-template-filteroperationselectedfieldsconfiguration-selectedcolumns

selected_field_options

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

  • ALL_FIELDS : Applies the filter operation to all fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-template-filteroperationselectedfieldsconfiguration-selectedfieldoptions

selected_fields

Chooses the fields that are filtered in CustomActionFilterOperation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-template-filteroperationselectedfieldsconfiguration-selectedfields

FilterOperationTargetVisualsConfigurationProperty

class CfnTemplatePropsMixin.FilterOperationTargetVisualsConfigurationProperty(*, same_sheet_target_visual_configuration=None)

Bases: object

The configuration of target visuals that you want to be filtered.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

same_sheet_target_visual_configuration (Union[IResolvable, SameSheetTargetVisualConfigurationProperty, Dict[str, Any], None]) – The configuration of the same-sheet target visuals that you want to be filtered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationtargetvisualsconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_operation_target_visuals_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.FilterOperationTargetVisualsConfigurationProperty(
    same_sheet_target_visual_configuration=quicksight_mixins.CfnTemplatePropsMixin.SameSheetTargetVisualConfigurationProperty(
        target_visual_options="targetVisualOptions",
        target_visuals=["targetVisuals"]
    )
)

Attributes

same_sheet_target_visual_configuration

The configuration of the same-sheet target visuals that you want to be filtered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filteroperationtargetvisualsconfiguration.html#cfn-quicksight-template-filteroperationtargetvisualsconfiguration-samesheettargetvisualconfiguration

FilterProperty

class CfnTemplatePropsMixin.FilterProperty(*, category_filter=None, nested_filter=None, numeric_equality_filter=None, numeric_range_filter=None, relative_dates_filter=None, time_equality_filter=None, time_range_filter=None, top_bottom_filter=None)

Bases: object

With a Filter , you can remove portions of data from a particular visual or view.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category_filter

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-categoryfilter

nested_filter

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-nestedfilter

numeric_equality_filter

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-numericequalityfilter

numeric_range_filter

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-numericrangefilter

relative_dates_filter

A RelativeDatesFilter filters date values that are relative to a given date.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-relativedatesfilter

time_equality_filter

A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-timeequalityfilter

time_range_filter

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-timerangefilter

top_bottom_filter

A TopBottomFilter filters data to the top or bottom values for a given column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-topbottomfilter

FilterRelativeDateTimeControlProperty

class CfnTemplatePropsMixin.FilterRelativeDateTimeControlProperty(*, commit_mode=None, display_options=None, filter_control_id=None, source_filter_id=None, title=None)

Bases: object

A control from a date filter that is used to specify the relative date.

Parameters:

  • commit_mode (Optional[str]) – The visibility configuration of the Apply button on a FilterRelativeDateTimeControl .

  • display_options (Union[IResolvable, RelativeDateTimeControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • filter_control_id (Optional[str]) – The ID of the FilterTextAreaControl .

  • source_filter_id (Optional[str]) – The source filter ID of the FilterTextAreaControl .

  • title (Optional[str]) – The title of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_relative_date_time_control_property = quicksight_mixins.CfnTemplatePropsMixin.FilterRelativeDateTimeControlProperty(
    commit_mode="commitMode",
    display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
        date_time_format="dateTimeFormat",
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",
    title="title"
)

Attributes

commit_mode

The visibility configuration of the Apply button on a FilterRelativeDateTimeControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html#cfn-quicksight-template-filterrelativedatetimecontrol-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html#cfn-quicksight-template-filterrelativedatetimecontrol-displayoptions

filter_control_id

The ID of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html#cfn-quicksight-template-filterrelativedatetimecontrol-filtercontrolid

source_filter_id

The source filter ID of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html#cfn-quicksight-template-filterrelativedatetimecontrol-sourcefilterid

title

The title of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterrelativedatetimecontrol.html#cfn-quicksight-template-filterrelativedatetimecontrol-title

FilterScopeConfigurationProperty

class CfnTemplatePropsMixin.FilterScopeConfigurationProperty(*, all_sheets=None, selected_sheets=None)

Bases: object

The scope configuration for a FilterGroup .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • all_sheets (Any) – The configuration that applies a filter to all sheets. When you choose AllSheets as the value for a FilterScopeConfiguration , this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

  • selected_sheets (Union[IResolvable, SelectedSheetsFilterScopeConfigurationProperty, Dict[str, Any], None]) – The configuration for applying a filter to specific sheets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterscopeconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# all_sheets: Any

filter_scope_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.FilterScopeConfigurationProperty(
    all_sheets=all_sheets,
    selected_sheets=quicksight_mixins.CfnTemplatePropsMixin.SelectedSheetsFilterScopeConfigurationProperty(
        sheet_visual_scoping_configurations=[quicksight_mixins.CfnTemplatePropsMixin.SheetVisualScopingConfigurationProperty(
            scope="scope",
            sheet_id="sheetId",
            visual_ids=["visualIds"]
        )]
    )
)

Attributes

all_sheets

The configuration that applies a filter to all sheets.

When you choose AllSheets as the value for a FilterScopeConfiguration , this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterscopeconfiguration.html#cfn-quicksight-template-filterscopeconfiguration-allsheets

selected_sheets

The configuration for applying a filter to specific sheets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterscopeconfiguration.html#cfn-quicksight-template-filterscopeconfiguration-selectedsheets

FilterSelectableValuesProperty

class CfnTemplatePropsMixin.FilterSelectableValuesProperty(*, values=None)

Bases: object

A list of selectable values that are used in a control.

Parameters:

values (Optional[Sequence[str]]) – The values that are used in the FilterSelectableValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterselectablevalues.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_selectable_values_property = quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
    values=["values"]
)

Attributes

values

The values that are used in the FilterSelectableValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterselectablevalues.html#cfn-quicksight-template-filterselectablevalues-values

FilterSliderControlProperty

class CfnTemplatePropsMixin.FilterSliderControlProperty(*, display_options=None, filter_control_id=None, maximum_value=None, minimum_value=None, source_filter_id=None, step_size=None, title=None, type=None)

Bases: object

A control to display a horizontal toggle bar.

This is used to change a value by sliding the toggle.

Parameters:

  • display_options (Union[IResolvable, SliderControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • filter_control_id (Optional[str]) – The ID of the FilterSliderControl .

  • maximum_value (Union[int, float, None]) – The larger value that is displayed at the right of the slider. Default: - 0

  • minimum_value (Union[int, float, None]) – The smaller value that is displayed at the left of the slider. Default: - 0

  • source_filter_id (Optional[str]) – The source filter ID of the FilterSliderControl .

  • step_size (Union[int, float, None]) – The number of increments that the slider bar is divided into. Default: - 0

  • title (Optional[str]) – The title of the FilterSliderControl .

  • type (Optional[str]) – The type of the FilterSliderControl . Choose one of the following options:. - SINGLE_POINT : Filter against(equals) a single data point. - RANGE : Filter data that is in a specified range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_slider_control_property = quicksight_mixins.CfnTemplatePropsMixin.FilterSliderControlProperty(
    display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    filter_control_id="filterControlId",
    maximum_value=123,
    minimum_value=123,
    source_filter_id="sourceFilterId",
    step_size=123,
    title="title",
    type="type"
)

Attributes

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-displayoptions

filter_control_id

The ID of the FilterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-filtercontrolid

maximum_value

The larger value that is displayed at the right of the slider.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-maximumvalue

minimum_value

The smaller value that is displayed at the left of the slider.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-minimumvalue

source_filter_id

The source filter ID of the FilterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-sourcefilterid

step_size

The number of increments that the slider bar is divided into.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-stepsize

title

The title of the FilterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterslidercontrol.html#cfn-quicksight-template-filterslidercontrol-title

type

.

  • SINGLE_POINT : Filter against(equals) a single data point.

  • RANGE : Filter data that is in a specified range.

See:

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

Type:

The type of the FilterSliderControl . Choose one of the following options

FilterTextAreaControlProperty

class CfnTemplatePropsMixin.FilterTextAreaControlProperty(*, delimiter=None, display_options=None, filter_control_id=None, source_filter_id=None, title=None)

Bases: object

A control to display a text box that is used to enter multiple entries.

Parameters:

  • delimiter (Optional[str]) – The delimiter that is used to separate the lines in text.

  • display_options (Union[IResolvable, TextAreaControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • filter_control_id (Optional[str]) – The ID of the FilterTextAreaControl .

  • source_filter_id (Optional[str]) – The source filter ID of the FilterTextAreaControl .

  • title (Optional[str]) – The title of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_text_area_control_property = quicksight_mixins.CfnTemplatePropsMixin.FilterTextAreaControlProperty(
    delimiter="delimiter",
    display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",
    title="title"
)

Attributes

delimiter

The delimiter that is used to separate the lines in text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-delimiter

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-displayoptions

filter_control_id

The ID of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-filtercontrolid

source_filter_id

The source filter ID of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-sourcefilterid

title

The title of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-title

FilterTextFieldControlProperty

class CfnTemplatePropsMixin.FilterTextFieldControlProperty(*, display_options=None, filter_control_id=None, source_filter_id=None, title=None)

Bases: object

A control to display a text box that is used to enter a single entry.

Parameters:

  • display_options (Union[IResolvable, TextFieldControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • filter_control_id (Optional[str]) – The ID of the FilterTextFieldControl .

  • source_filter_id (Optional[str]) – The source filter ID of the FilterTextFieldControl .

  • title (Optional[str]) – The title of the FilterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextfieldcontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

filter_text_field_control_property = quicksight_mixins.CfnTemplatePropsMixin.FilterTextFieldControlProperty(
    display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",
    title="title"
)

Attributes

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextfieldcontrol.html#cfn-quicksight-template-filtertextfieldcontrol-displayoptions

filter_control_id

The ID of the FilterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextfieldcontrol.html#cfn-quicksight-template-filtertextfieldcontrol-filtercontrolid

source_filter_id

The source filter ID of the FilterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextfieldcontrol.html#cfn-quicksight-template-filtertextfieldcontrol-sourcefilterid

title

The title of the FilterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextfieldcontrol.html#cfn-quicksight-template-filtertextfieldcontrol-title

FontConfigurationProperty

class CfnTemplatePropsMixin.FontConfigurationProperty(*, font_color=None, font_decoration=None, font_family=None, font_size=None, font_style=None, font_weight=None)

Bases: object

Configures the display properties of the given text.

Parameters:

  • font_color (Optional[str]) – Determines the color of the text.

  • font_decoration (Optional[str]) – Determines the appearance of decorative lines on the text.

  • font_family (Optional[str]) – The font family that you want to use.

  • font_size (Union[IResolvable, FontSizeProperty, Dict[str, Any], None]) – The option that determines the text display size.

  • font_style (Optional[str]) – Determines the text display face that is inherited by the given font family.

  • font_weight (Union[IResolvable, FontWeightProperty, Dict[str, Any], None]) – The option that determines the text display weight, or boldness.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

font_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
    font_color="fontColor",
    font_decoration="fontDecoration",
    font_family="fontFamily",
    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
        absolute="absolute",
        relative="relative"
    ),
    font_style="fontStyle",
    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
        name="name"
    )
)

Attributes

font_color

Determines the color of the text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontcolor

font_decoration

Determines the appearance of decorative lines on the text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontdecoration

font_family

The font family that you want to use.

See:

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

font_size

The option that determines the text display size.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontsize

font_style

Determines the text display face that is inherited by the given font family.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontstyle

font_weight

The option that determines the text display weight, or boldness.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontconfiguration.html#cfn-quicksight-template-fontconfiguration-fontweight

FontSizeProperty

class CfnTemplatePropsMixin.FontSizeProperty(*, absolute=None, relative=None)

Bases: object

The option that determines the text display size.

Parameters:

  • absolute (Optional[str]) – The font size that you want to use in px.

  • relative (Optional[str]) – The lexical name for the text size, proportional to its surrounding context.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontsize.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

font_size_property = quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
    absolute="absolute",
    relative="relative"
)

Attributes

absolute

The font size that you want to use in px.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontsize.html#cfn-quicksight-template-fontsize-absolute

relative

The lexical name for the text size, proportional to its surrounding context.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontsize.html#cfn-quicksight-template-fontsize-relative

FontWeightProperty

class CfnTemplatePropsMixin.FontWeightProperty(*, name=None)

Bases: object

The option that determines the text display weight, or boldness.

Parameters:

name (Optional[str]) – The lexical name for the level of boldness of the text display.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontweight.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

font_weight_property = quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
    name="name"
)

Attributes

name

The lexical name for the level of boldness of the text display.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-fontweight.html#cfn-quicksight-template-fontweight-name

ForecastComputationProperty

class CfnTemplatePropsMixin.ForecastComputationProperty(*, computation_id=None, custom_seasonality_value=None, lower_boundary=None, name=None, periods_backward=None, periods_forward=None, prediction_interval=None, seasonality=None, time=None, upper_boundary=None, value=None)

Bases: object

The forecast computation configuration.

Parameters:

  • computation_id (Optional[str]) – The ID for a computation.

  • custom_seasonality_value (Union[int, float, None]) – The custom seasonality value setup of a forecast computation.

  • lower_boundary (Union[int, float, None]) – The lower boundary setup of a forecast computation.

  • name (Optional[str]) – The name of a computation.

  • periods_backward (Union[int, float, None]) – The periods backward setup of a forecast computation.

  • periods_forward (Union[int, float, None]) – The periods forward setup of a forecast computation.

  • prediction_interval (Union[int, float, None]) – The prediction interval setup of a forecast computation.

  • seasonality (Optional[str]) – The seasonality setup of a forecast computation. Choose one of the following options:. - AUTOMATIC - CUSTOM : Checks the custom seasonality value.

  • time (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The time field that is used in a computation.

  • upper_boundary (Union[int, float, None]) – The upper boundary setup of a forecast computation.

  • value (Union[IResolvable, MeasureFieldProperty, Dict[str, Any], None]) – The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-computationid

custom_seasonality_value

The custom seasonality value setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-customseasonalityvalue

lower_boundary

The lower boundary setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-lowerboundary

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-name

periods_backward

The periods backward setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-periodsbackward

periods_forward

The periods forward setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-periodsforward

prediction_interval

The prediction interval setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-predictioninterval

seasonality

.

  • AUTOMATIC

  • CUSTOM : Checks the custom seasonality value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-seasonality

Type:

The seasonality setup of a forecast computation. Choose one of the following options

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-time

upper_boundary

The upper boundary setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-upperboundary

value

The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastcomputation.html#cfn-quicksight-template-forecastcomputation-value

ForecastConfigurationProperty

class CfnTemplatePropsMixin.ForecastConfigurationProperty(*, forecast_properties=None, scenario=None)

Bases: object

The forecast configuration that is used in a line chart’s display properties.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

forecast_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ForecastConfigurationProperty(
    forecast_properties=quicksight_mixins.CfnTemplatePropsMixin.TimeBasedForecastPropertiesProperty(
        lower_boundary=123,
        periods_backward=123,
        periods_forward=123,
        prediction_interval=123,
        seasonality=123,
        upper_boundary=123
    ),
    scenario=quicksight_mixins.CfnTemplatePropsMixin.ForecastScenarioProperty(
        what_if_point_scenario=quicksight_mixins.CfnTemplatePropsMixin.WhatIfPointScenarioProperty(
            date="date",
            value=123
        ),
        what_if_range_scenario=quicksight_mixins.CfnTemplatePropsMixin.WhatIfRangeScenarioProperty(
            end_date="endDate",
            start_date="startDate",
            value=123
        )
    )
)

Attributes

forecast_properties

The forecast properties setup of a forecast in the line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastconfiguration.html#cfn-quicksight-template-forecastconfiguration-forecastproperties

scenario

The forecast scenario of a forecast in the line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastconfiguration.html#cfn-quicksight-template-forecastconfiguration-scenario

ForecastScenarioProperty

class CfnTemplatePropsMixin.ForecastScenarioProperty(*, what_if_point_scenario=None, what_if_range_scenario=None)

Bases: object

The forecast scenario of a forecast in the line chart.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastscenario.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

forecast_scenario_property = quicksight_mixins.CfnTemplatePropsMixin.ForecastScenarioProperty(
    what_if_point_scenario=quicksight_mixins.CfnTemplatePropsMixin.WhatIfPointScenarioProperty(
        date="date",
        value=123
    ),
    what_if_range_scenario=quicksight_mixins.CfnTemplatePropsMixin.WhatIfRangeScenarioProperty(
        end_date="endDate",
        start_date="startDate",
        value=123
    )
)

Attributes

what_if_point_scenario

The what-if analysis forecast setup with the target date.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastscenario.html#cfn-quicksight-template-forecastscenario-whatifpointscenario

what_if_range_scenario

The what-if analysis forecast setup with the date range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-forecastscenario.html#cfn-quicksight-template-forecastscenario-whatifrangescenario

FormatConfigurationProperty

class CfnTemplatePropsMixin.FormatConfigurationProperty(*, date_time_format_configuration=None, number_format_configuration=None, string_format_configuration=None)

Bases: object

The formatting configuration for all types of field.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-formatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

format_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.FormatConfigurationProperty(
    date_time_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
        date_time_format="dateTimeFormat",
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    ),
    number_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    ),
    string_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    )
)

Attributes

date_time_format_configuration

Formatting configuration for DateTime fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-formatconfiguration.html#cfn-quicksight-template-formatconfiguration-datetimeformatconfiguration

number_format_configuration

Formatting configuration for number fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-formatconfiguration.html#cfn-quicksight-template-formatconfiguration-numberformatconfiguration

string_format_configuration

Formatting configuration for string fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-formatconfiguration.html#cfn-quicksight-template-formatconfiguration-stringformatconfiguration

FreeFormLayoutCanvasSizeOptionsProperty

class CfnTemplatePropsMixin.FreeFormLayoutCanvasSizeOptionsProperty(*, screen_canvas_size_options=None)

Bases: object

Configuration options for the canvas of a free-form layout.

Parameters:

screen_canvas_size_options (Union[IResolvable, FreeFormLayoutScreenCanvasSizeOptionsProperty, Dict[str, Any], None]) – The options that determine the sizing of the canvas used in a free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutcanvassizeoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

free_form_layout_canvas_size_options_property = quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutCanvasSizeOptionsProperty(
    screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutScreenCanvasSizeOptionsProperty(
        optimized_view_port_width="optimizedViewPortWidth"
    )
)

Attributes

screen_canvas_size_options

The options that determine the sizing of the canvas used in a free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutcanvassizeoptions.html#cfn-quicksight-template-freeformlayoutcanvassizeoptions-screencanvassizeoptions

FreeFormLayoutConfigurationProperty

class CfnTemplatePropsMixin.FreeFormLayoutConfigurationProperty(*, canvas_size_options=None, elements=None)

Bases: object

The configuration of a free-form layout.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

free_form_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutConfigurationProperty(
    canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutCanvasSizeOptionsProperty(
        screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutScreenCanvasSizeOptionsProperty(
            optimized_view_port_width="optimizedViewPortWidth"
        )
    ),
    elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
        background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
            color="color",
            visibility="visibility"
        ),
        border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
            color="color",
            visibility="visibility"
        ),
        element_id="elementId",
        element_type="elementType",
        height="height",
        loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
            visibility="visibility"
        ),
        rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
            configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                visibility="visibility"
            ),
            expression="expression"
        )],
        selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
            color="color",
            visibility="visibility"
        ),
        visibility="visibility",
        width="width",
        x_axis_location="xAxisLocation",
        y_axis_location="yAxisLocation"
    )]
)

Attributes

canvas_size_options

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutconfiguration.html#cfn-quicksight-template-freeformlayoutconfiguration-canvassizeoptions

Type:

see

elements

The elements that are included in a free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutconfiguration.html#cfn-quicksight-template-freeformlayoutconfiguration-elements

FreeFormLayoutElementBackgroundStyleProperty

class CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(*, color=None, visibility=None)

Bases: object

The background style configuration of a free-form layout element.

Parameters:

  • color (Optional[str]) – The background color of a free-form layout element.

  • visibility (Optional[str]) – The background visibility of a free-form layout element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementbackgroundstyle.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

free_form_layout_element_background_style_property = quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
    color="color",
    visibility="visibility"
)

Attributes

color

The background color of a free-form layout element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementbackgroundstyle.html#cfn-quicksight-template-freeformlayoutelementbackgroundstyle-color

visibility

The background visibility of a free-form layout element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementbackgroundstyle.html#cfn-quicksight-template-freeformlayoutelementbackgroundstyle-visibility

FreeFormLayoutElementBorderStyleProperty

class CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(*, color=None, visibility=None)

Bases: object

The background style configuration of a free-form layout element.

Parameters:

  • color (Optional[str]) – The border color of a free-form layout element.

  • visibility (Optional[str]) – The border visibility of a free-form layout element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementborderstyle.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

free_form_layout_element_border_style_property = quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
    color="color",
    visibility="visibility"
)

Attributes

color

The border color of a free-form layout element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementborderstyle.html#cfn-quicksight-template-freeformlayoutelementborderstyle-color

visibility

The border visibility of a free-form layout element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelementborderstyle.html#cfn-quicksight-template-freeformlayoutelementborderstyle-visibility

FreeFormLayoutElementProperty

class CfnTemplatePropsMixin.FreeFormLayoutElementProperty(*, background_style=None, border_style=None, element_id=None, element_type=None, height=None, loading_animation=None, rendering_rules=None, selected_border_style=None, visibility=None, width=None, x_axis_location=None, y_axis_location=None)

Bases: object

An element within a free-form layout.

Parameters:

  • background_style (Union[IResolvable, FreeFormLayoutElementBackgroundStyleProperty, Dict[str, Any], None]) – The background style configuration of a free-form layout element.

  • border_style (Union[IResolvable, FreeFormLayoutElementBorderStyleProperty, Dict[str, Any], None]) – The border style configuration of a free-form layout element.

  • element_id (Optional[str]) – A unique identifier for an element within a free-form layout.

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

  • height (Optional[str]) – The height of an element within a free-form layout.

  • loading_animation (Union[IResolvable, LoadingAnimationProperty, Dict[str, Any], None]) – The loading animation configuration of a free-form layout element.

  • rendering_rules (Union[IResolvable, Sequence[Union[IResolvable, SheetElementRenderingRuleProperty, Dict[str, Any]]], None]) – The rendering rules that determine when an element should be displayed within a free-form layout.

  • selected_border_style (Union[IResolvable, FreeFormLayoutElementBorderStyleProperty, Dict[str, Any], None]) – The border style configuration of a free-form layout element. This border style is used when the element is selected.

  • visibility (Optional[str]) – The visibility of an element within a free-form layout.

  • width (Optional[str]) – The width of an element within a free-form layout.

  • x_axis_location (Optional[str]) – The x-axis coordinate of the element.

  • y_axis_location (Optional[str]) – The y-axis coordinate of the element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

free_form_layout_element_property = quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
    background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
        color="color",
        visibility="visibility"
    ),
    border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
        color="color",
        visibility="visibility"
    ),
    element_id="elementId",
    element_type="elementType",
    height="height",
    loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
        visibility="visibility"
    ),
    rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
        configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
            visibility="visibility"
        ),
        expression="expression"
    )],
    selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
        color="color",
        visibility="visibility"
    ),
    visibility="visibility",
    width="width",
    x_axis_location="xAxisLocation",
    y_axis_location="yAxisLocation"
)

Attributes

background_style

The background style configuration of a free-form layout element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-backgroundstyle

border_style

The border style configuration of a free-form layout element.

See:

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

element_id

A unique identifier for an element within a free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-elementid

element_type

The type of element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-elementtype

height

The height of an element within a free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-height

loading_animation

The loading animation configuration of a free-form layout element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-loadinganimation

rendering_rules

The rendering rules that determine when an element should be displayed within a free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-renderingrules

selected_border_style

The border style configuration of a free-form layout element.

This border style is used when the element is selected.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-selectedborderstyle

visibility

The visibility of an element within a free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-visibility

width

The width of an element within a free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-width

x_axis_location

The x-axis coordinate of the element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-xaxislocation

y_axis_location

The y-axis coordinate of the element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutelement.html#cfn-quicksight-template-freeformlayoutelement-yaxislocation

FreeFormLayoutScreenCanvasSizeOptionsProperty

class CfnTemplatePropsMixin.FreeFormLayoutScreenCanvasSizeOptionsProperty(*, optimized_view_port_width=None)

Bases: object

The options that determine the sizing of the canvas used in a free-form layout.

Parameters:

optimized_view_port_width (Optional[str]) – The width that the view port will be optimized for when the layout renders.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutscreencanvassizeoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

free_form_layout_screen_canvas_size_options_property = quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutScreenCanvasSizeOptionsProperty(
    optimized_view_port_width="optimizedViewPortWidth"
)

Attributes

optimized_view_port_width

The width that the view port will be optimized for when the layout renders.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformlayoutscreencanvassizeoptions.html#cfn-quicksight-template-freeformlayoutscreencanvassizeoptions-optimizedviewportwidth

FreeFormSectionLayoutConfigurationProperty

class CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(*, elements=None)

Bases: object

The free-form layout configuration of a section.

Parameters:

elements (Union[IResolvable, Sequence[Union[IResolvable, FreeFormLayoutElementProperty, Dict[str, Any]]], None]) – The elements that are included in the free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformsectionlayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

free_form_section_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
    elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
        background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
            color="color",
            visibility="visibility"
        ),
        border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
            color="color",
            visibility="visibility"
        ),
        element_id="elementId",
        element_type="elementType",
        height="height",
        loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
            visibility="visibility"
        ),
        rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
            configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                visibility="visibility"
            ),
            expression="expression"
        )],
        selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
            color="color",
            visibility="visibility"
        ),
        visibility="visibility",
        width="width",
        x_axis_location="xAxisLocation",
        y_axis_location="yAxisLocation"
    )]
)

Attributes

elements

The elements that are included in the free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-freeformsectionlayoutconfiguration.html#cfn-quicksight-template-freeformsectionlayoutconfiguration-elements

FunnelChartAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.FunnelChartAggregatedFieldWellsProperty(*, category=None, values=None)

Bases: object

The field well configuration of a FunnelChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category

The category field wells of a funnel chart.

Values are grouped by category fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartaggregatedfieldwells.html#cfn-quicksight-template-funnelchartaggregatedfieldwells-category

values

The value field wells of a funnel chart.

Values are aggregated based on categories.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartaggregatedfieldwells.html#cfn-quicksight-template-funnelchartaggregatedfieldwells-values

FunnelChartConfigurationProperty

class CfnTemplatePropsMixin.FunnelChartConfigurationProperty(*, category_label_options=None, data_label_options=None, field_wells=None, interactions=None, sort_configuration=None, tooltip=None, value_label_options=None, visual_palette=None)

Bases: object

The configuration of a FunnelChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category_label_options

The label options of the categories that are displayed in a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-categorylabeloptions

data_label_options

The options that determine the presentation of the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-datalabeloptions

field_wells

The field well configuration of a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-interactions

sort_configuration

The sort configuration of a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-sortconfiguration

tooltip

The tooltip configuration of a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-tooltip

value_label_options

The label options for the values that are displayed in a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-valuelabeloptions

visual_palette

The visual palette configuration of a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartconfiguration.html#cfn-quicksight-template-funnelchartconfiguration-visualpalette

FunnelChartDataLabelOptionsProperty

class CfnTemplatePropsMixin.FunnelChartDataLabelOptionsProperty(*, category_label_visibility=None, label_color=None, label_font_configuration=None, measure_data_label_style=None, measure_label_visibility=None, position=None, visibility=None)

Bases: object

The options that determine the presentation of the data labels.

Parameters:

  • category_label_visibility (Optional[str]) – The visibility of the category labels within the data labels.

  • label_color (Optional[str]) – The color of the data label text.

  • label_font_configuration (Union[IResolvable, FontConfigurationProperty, Dict[str, Any], None]) – The font configuration for the data labels. Only the FontSize attribute of the font configuration is used for data labels.

  • measure_data_label_style (Optional[str]) – Determines the style of the metric labels.

  • measure_label_visibility (Optional[str]) – The visibility of the measure labels within the data labels.

  • position (Optional[str]) – Determines the positioning of the data label relative to a section of the funnel.

  • visibility (Optional[str]) – The visibility option that determines if data labels are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

funnel_chart_data_label_options_property = quicksight_mixins.CfnTemplatePropsMixin.FunnelChartDataLabelOptionsProperty(
    category_label_visibility="categoryLabelVisibility",
    label_color="labelColor",
    label_font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    ),
    measure_data_label_style="measureDataLabelStyle",
    measure_label_visibility="measureLabelVisibility",
    position="position",
    visibility="visibility"
)

Attributes

category_label_visibility

The visibility of the category labels within the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-categorylabelvisibility

label_color

The color of the data label text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-labelcolor

label_font_configuration

The font configuration for the data labels.

Only the FontSize attribute of the font configuration is used for data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-labelfontconfiguration

measure_data_label_style

Determines the style of the metric labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-measuredatalabelstyle

measure_label_visibility

The visibility of the measure labels within the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-measurelabelvisibility

position

Determines the positioning of the data label relative to a section of the funnel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-position

visibility

The visibility option that determines if data labels are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartdatalabeloptions.html#cfn-quicksight-template-funnelchartdatalabeloptions-visibility

FunnelChartFieldWellsProperty

class CfnTemplatePropsMixin.FunnelChartFieldWellsProperty(*, funnel_chart_aggregated_field_wells=None)

Bases: object

The field well configuration of a FunnelChartVisual .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

funnel_chart_aggregated_field_wells (Union[IResolvable, FunnelChartAggregatedFieldWellsProperty, Dict[str, Any], None]) – The field well configuration of a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
funnel_chart_aggregated_field_wells

The field well configuration of a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartfieldwells.html#cfn-quicksight-template-funnelchartfieldwells-funnelchartaggregatedfieldwells

FunnelChartSortConfigurationProperty

class CfnTemplatePropsMixin.FunnelChartSortConfigurationProperty(*, category_items_limit=None, category_sort=None)

Bases: object

The sort configuration of a FunnelChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

funnel_chart_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.FunnelChartSortConfigurationProperty(
    category_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

category_items_limit

The limit on the number of categories displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartsortconfiguration.html#cfn-quicksight-template-funnelchartsortconfiguration-categoryitemslimit

category_sort

The sort configuration of the category fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartsortconfiguration.html#cfn-quicksight-template-funnelchartsortconfiguration-categorysort

FunnelChartVisualProperty

class CfnTemplatePropsMixin.FunnelChartVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A funnel chart.

For more information, see Using funnel charts in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration of a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-funnelchartvisual.html#cfn-quicksight-template-funnelchartvisual-visualid

GaugeChartArcConditionalFormattingProperty

class CfnTemplatePropsMixin.GaugeChartArcConditionalFormattingProperty(*, foreground_color=None)

Bases: object

The options that determine the presentation of the arc of a GaugeChartVisual .

Parameters:

foreground_color (Union[IResolvable, ConditionalFormattingColorProperty, Dict[str, Any], None]) – The conditional formatting of the arc foreground color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartarcconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

gauge_chart_arc_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.GaugeChartArcConditionalFormattingProperty(
    foreground_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    )
)

Attributes

foreground_color

The conditional formatting of the arc foreground color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartarcconditionalformatting.html#cfn-quicksight-template-gaugechartarcconditionalformatting-foregroundcolor

GaugeChartColorConfigurationProperty

class CfnTemplatePropsMixin.GaugeChartColorConfigurationProperty(*, background_color=None, foreground_color=None)

Bases: object

The color configuration of a GaugeChartVisual .

Parameters:

  • background_color (Optional[str]) – The background color configuration of a GaugeChartVisual .

  • foreground_color (Optional[str]) – The foreground color configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartcolorconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

gauge_chart_color_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.GaugeChartColorConfigurationProperty(
    background_color="backgroundColor",
    foreground_color="foregroundColor"
)

Attributes

background_color

The background color configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartcolorconfiguration.html#cfn-quicksight-template-gaugechartcolorconfiguration-backgroundcolor

foreground_color

The foreground color configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartcolorconfiguration.html#cfn-quicksight-template-gaugechartcolorconfiguration-foregroundcolor

GaugeChartConditionalFormattingOptionProperty

class CfnTemplatePropsMixin.GaugeChartConditionalFormattingOptionProperty(*, arc=None, primary_value=None)

Bases: object

Conditional formatting options of a GaugeChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconditionalformattingoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

gauge_chart_conditional_formatting_option_property = quicksight_mixins.CfnTemplatePropsMixin.GaugeChartConditionalFormattingOptionProperty(
    arc=quicksight_mixins.CfnTemplatePropsMixin.GaugeChartArcConditionalFormattingProperty(
        foreground_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        )
    ),
    primary_value=quicksight_mixins.CfnTemplatePropsMixin.GaugeChartPrimaryValueConditionalFormattingProperty(
        icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
            custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                color="color",
                display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                ),
                expression="expression",
                icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                )
            ),
            icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                expression="expression",
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        )
    )
)

Attributes

arc

The options that determine the presentation of the arc of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconditionalformattingoption.html#cfn-quicksight-template-gaugechartconditionalformattingoption-arc

primary_value

The conditional formatting for the primary value of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconditionalformattingoption.html#cfn-quicksight-template-gaugechartconditionalformattingoption-primaryvalue

GaugeChartConditionalFormattingProperty

class CfnTemplatePropsMixin.GaugeChartConditionalFormattingProperty(*, conditional_formatting_options=None)

Bases: object

The conditional formatting of a GaugeChartVisual .

Parameters:

conditional_formatting_options (Union[IResolvable, Sequence[Union[IResolvable, GaugeChartConditionalFormattingOptionProperty, Dict[str, Any]]], None]) – Conditional formatting options of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

gauge_chart_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.GaugeChartConditionalFormattingProperty(
    conditional_formatting_options=[quicksight_mixins.CfnTemplatePropsMixin.GaugeChartConditionalFormattingOptionProperty(
        arc=quicksight_mixins.CfnTemplatePropsMixin.GaugeChartArcConditionalFormattingProperty(
            foreground_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            )
        ),
        primary_value=quicksight_mixins.CfnTemplatePropsMixin.GaugeChartPrimaryValueConditionalFormattingProperty(
            icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
                custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                    color="color",
                    display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    ),
                    expression="expression",
                    icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    )
                ),
                icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                    expression="expression",
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            )
        )
    )]
)

Attributes

conditional_formatting_options

Conditional formatting options of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconditionalformatting.html#cfn-quicksight-template-gaugechartconditionalformatting-conditionalformattingoptions

GaugeChartConfigurationProperty

class CfnTemplatePropsMixin.GaugeChartConfigurationProperty(*, color_configuration=None, data_labels=None, field_wells=None, gauge_chart_options=None, interactions=None, tooltip_options=None, visual_palette=None)

Bases: object

The configuration of a GaugeChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
color_configuration

The color configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-colorconfiguration

data_labels

The data label configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-datalabels

field_wells

The field well configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-fieldwells

gauge_chart_options

The options that determine the presentation of the GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-gaugechartoptions

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-interactions

tooltip_options

The tooltip configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-tooltipoptions

visual_palette

The visual palette configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartconfiguration.html#cfn-quicksight-template-gaugechartconfiguration-visualpalette

GaugeChartFieldWellsProperty

class CfnTemplatePropsMixin.GaugeChartFieldWellsProperty(*, target_values=None, values=None)

Bases: object

The field well configuration of a GaugeChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
target_values

The target value field wells of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartfieldwells.html#cfn-quicksight-template-gaugechartfieldwells-targetvalues

values

The value field wells of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartfieldwells.html#cfn-quicksight-template-gaugechartfieldwells-values

GaugeChartOptionsProperty

class CfnTemplatePropsMixin.GaugeChartOptionsProperty(*, arc=None, arc_axis=None, comparison=None, primary_value_display_type=None, primary_value_font_configuration=None)

Bases: object

The options that determine the presentation of the GaugeChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

gauge_chart_options_property = quicksight_mixins.CfnTemplatePropsMixin.GaugeChartOptionsProperty(
    arc=quicksight_mixins.CfnTemplatePropsMixin.ArcConfigurationProperty(
        arc_angle=123,
        arc_thickness="arcThickness"
    ),
    arc_axis=quicksight_mixins.CfnTemplatePropsMixin.ArcAxisConfigurationProperty(
        range=quicksight_mixins.CfnTemplatePropsMixin.ArcAxisDisplayRangeProperty(
            max=123,
            min=123
        ),
        reserve_range=123
    ),
    comparison=quicksight_mixins.CfnTemplatePropsMixin.ComparisonConfigurationProperty(
        comparison_format=quicksight_mixins.CfnTemplatePropsMixin.ComparisonFormatConfigurationProperty(
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        ),
        comparison_method="comparisonMethod"
    ),
    primary_value_display_type="primaryValueDisplayType",
    primary_value_font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    )
)

Attributes

arc

The arc configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html#cfn-quicksight-template-gaugechartoptions-arc

arc_axis

The arc axis configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html#cfn-quicksight-template-gaugechartoptions-arcaxis

comparison

The comparison configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html#cfn-quicksight-template-gaugechartoptions-comparison

primary_value_display_type

The options that determine the primary value display type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html#cfn-quicksight-template-gaugechartoptions-primaryvaluedisplaytype

primary_value_font_configuration

The options that determine the primary value font configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartoptions.html#cfn-quicksight-template-gaugechartoptions-primaryvaluefontconfiguration

GaugeChartPrimaryValueConditionalFormattingProperty

class CfnTemplatePropsMixin.GaugeChartPrimaryValueConditionalFormattingProperty(*, icon=None, text_color=None)

Bases: object

The conditional formatting for the primary value of a GaugeChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartprimaryvalueconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

gauge_chart_primary_value_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.GaugeChartPrimaryValueConditionalFormattingProperty(
    icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
        custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
            color="color",
            display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                icon_display_option="iconDisplayOption"
            ),
            expression="expression",
            icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                icon="icon",
                unicode_icon="unicodeIcon"
            )
        ),
        icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
            expression="expression",
            icon_set_type="iconSetType"
        )
    ),
    text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    )
)

Attributes

icon

The conditional formatting of the primary value icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartprimaryvalueconditionalformatting.html#cfn-quicksight-template-gaugechartprimaryvalueconditionalformatting-icon

text_color

The conditional formatting of the primary value text color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartprimaryvalueconditionalformatting.html#cfn-quicksight-template-gaugechartprimaryvalueconditionalformatting-textcolor

GaugeChartVisualProperty

class CfnTemplatePropsMixin.GaugeChartVisualProperty(*, actions=None, chart_configuration=None, conditional_formatting=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A gauge chart.

For more information, see Using gauge charts in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-chartconfiguration

conditional_formatting

The conditional formatting of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-conditionalformatting

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gaugechartvisual.html#cfn-quicksight-template-gaugechartvisual-visualid

GeospatialCoordinateBoundsProperty

class CfnTemplatePropsMixin.GeospatialCoordinateBoundsProperty(*, east=None, north=None, south=None, west=None)

Bases: object

The bound options (north, south, west, east) of the geospatial window options.

Parameters:

  • east (Union[int, float, None]) – The longitude of the east bound of the geospatial coordinate bounds.

  • north (Union[int, float, None]) – The latitude of the north bound of the geospatial coordinate bounds.

  • south (Union[int, float, None]) – The latitude of the south bound of the geospatial coordinate bounds.

  • west (Union[int, float, None]) – The longitude of the west bound of the geospatial coordinate bounds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialcoordinatebounds.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

geospatial_coordinate_bounds_property = quicksight_mixins.CfnTemplatePropsMixin.GeospatialCoordinateBoundsProperty(
    east=123,
    north=123,
    south=123,
    west=123
)

Attributes

east

The longitude of the east bound of the geospatial coordinate bounds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialcoordinatebounds.html#cfn-quicksight-template-geospatialcoordinatebounds-east

north

The latitude of the north bound of the geospatial coordinate bounds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialcoordinatebounds.html#cfn-quicksight-template-geospatialcoordinatebounds-north

south

The latitude of the south bound of the geospatial coordinate bounds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialcoordinatebounds.html#cfn-quicksight-template-geospatialcoordinatebounds-south

west

The longitude of the west bound of the geospatial coordinate bounds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialcoordinatebounds.html#cfn-quicksight-template-geospatialcoordinatebounds-west

GeospatialHeatmapColorScaleProperty

class CfnTemplatePropsMixin.GeospatialHeatmapColorScaleProperty(*, colors=None)

Bases: object

The color scale specification for the heatmap point style.

Parameters:

colors (Union[IResolvable, Sequence[Union[IResolvable, GeospatialHeatmapDataColorProperty, Dict[str, Any]]], None]) – The list of colors to be used in heatmap point style.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapcolorscale.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

geospatial_heatmap_color_scale_property = quicksight_mixins.CfnTemplatePropsMixin.GeospatialHeatmapColorScaleProperty(
    colors=[quicksight_mixins.CfnTemplatePropsMixin.GeospatialHeatmapDataColorProperty(
        color="color"
    )]
)

Attributes

colors

The list of colors to be used in heatmap point style.

See:

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

GeospatialHeatmapConfigurationProperty

class CfnTemplatePropsMixin.GeospatialHeatmapConfigurationProperty(*, heatmap_color=None)

Bases: object

The heatmap configuration of the geospatial point style.

Parameters:

heatmap_color (Union[IResolvable, GeospatialHeatmapColorScaleProperty, Dict[str, Any], None]) – The color scale specification for the heatmap point style.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

geospatial_heatmap_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.GeospatialHeatmapConfigurationProperty(
    heatmap_color=quicksight_mixins.CfnTemplatePropsMixin.GeospatialHeatmapColorScaleProperty(
        colors=[quicksight_mixins.CfnTemplatePropsMixin.GeospatialHeatmapDataColorProperty(
            color="color"
        )]
    )
)

Attributes

heatmap_color

The color scale specification for the heatmap point style.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapconfiguration.html#cfn-quicksight-template-geospatialheatmapconfiguration-heatmapcolor

GeospatialHeatmapDataColorProperty

class CfnTemplatePropsMixin.GeospatialHeatmapDataColorProperty(*, color=None)

Bases: object

The color to be used in the heatmap point style.

Parameters:

color (Optional[str]) – The hex color to be used in the heatmap point style.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapdatacolor.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

geospatial_heatmap_data_color_property = quicksight_mixins.CfnTemplatePropsMixin.GeospatialHeatmapDataColorProperty(
    color="color"
)

Attributes

color

The hex color to be used in the heatmap point style.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialheatmapdatacolor.html#cfn-quicksight-template-geospatialheatmapdatacolor-color

GeospatialMapAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.GeospatialMapAggregatedFieldWellsProperty(*, colors=None, geospatial=None, values=None)

Bases: object

The aggregated field wells for a geospatial map.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
colors

The color field wells of a geospatial map.

See:

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

geospatial

The geospatial field wells of a geospatial map.

Values are grouped by geospatial fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapaggregatedfieldwells.html#cfn-quicksight-template-geospatialmapaggregatedfieldwells-geospatial

values

The size field wells of a geospatial map.

Values are aggregated based on geospatial fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapaggregatedfieldwells.html#cfn-quicksight-template-geospatialmapaggregatedfieldwells-values

GeospatialMapConfigurationProperty

class CfnTemplatePropsMixin.GeospatialMapConfigurationProperty(*, field_wells=None, legend=None, map_style_options=None, point_style_options=None, tooltip=None, visual_palette=None, window_options=None)

Bases: object

The configuration of a GeospatialMapVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-fieldwells

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-legend

map_style_options

The map style options of the geospatial map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-mapstyleoptions

point_style_options

The point style options of the geospatial map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-pointstyleoptions

tooltip

The tooltip display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-tooltip

visual_palette

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-visualpalette

Type:

see

window_options

The window options of the geospatial map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapconfiguration.html#cfn-quicksight-template-geospatialmapconfiguration-windowoptions

GeospatialMapFieldWellsProperty

class CfnTemplatePropsMixin.GeospatialMapFieldWellsProperty(*, geospatial_map_aggregated_field_wells=None)

Bases: object

The field wells of a GeospatialMapVisual .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

geospatial_map_aggregated_field_wells (Union[IResolvable, GeospatialMapAggregatedFieldWellsProperty, Dict[str, Any], None]) – The aggregated field well for a geospatial map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
geospatial_map_aggregated_field_wells

The aggregated field well for a geospatial map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapfieldwells.html#cfn-quicksight-template-geospatialmapfieldwells-geospatialmapaggregatedfieldwells

GeospatialMapStyleOptionsProperty

class CfnTemplatePropsMixin.GeospatialMapStyleOptionsProperty(*, base_map_style=None)

Bases: object

The map style options of the geospatial map.

Parameters:

base_map_style (Optional[str]) – The base map style of the geospatial map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapstyleoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

geospatial_map_style_options_property = quicksight_mixins.CfnTemplatePropsMixin.GeospatialMapStyleOptionsProperty(
    base_map_style="baseMapStyle"
)

Attributes

base_map_style

The base map style of the geospatial map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapstyleoptions.html#cfn-quicksight-template-geospatialmapstyleoptions-basemapstyle

GeospatialMapVisualProperty

class CfnTemplatePropsMixin.GeospatialMapVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialmapvisual.html#cfn-quicksight-template-geospatialmapvisual-visualid

GeospatialPointStyleOptionsProperty

class CfnTemplatePropsMixin.GeospatialPointStyleOptionsProperty(*, cluster_marker_configuration=None, heatmap_configuration=None, selected_point_style=None)

Bases: object

The point style of the geospatial map.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialpointstyleoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

geospatial_point_style_options_property = quicksight_mixins.CfnTemplatePropsMixin.GeospatialPointStyleOptionsProperty(
    cluster_marker_configuration=quicksight_mixins.CfnTemplatePropsMixin.ClusterMarkerConfigurationProperty(
        cluster_marker=quicksight_mixins.CfnTemplatePropsMixin.ClusterMarkerProperty(
            simple_cluster_marker=quicksight_mixins.CfnTemplatePropsMixin.SimpleClusterMarkerProperty(
                color="color"
            )
        )
    ),
    heatmap_configuration=quicksight_mixins.CfnTemplatePropsMixin.GeospatialHeatmapConfigurationProperty(
        heatmap_color=quicksight_mixins.CfnTemplatePropsMixin.GeospatialHeatmapColorScaleProperty(
            colors=[quicksight_mixins.CfnTemplatePropsMixin.GeospatialHeatmapDataColorProperty(
                color="color"
            )]
        )
    ),
    selected_point_style="selectedPointStyle"
)

Attributes

cluster_marker_configuration

The cluster marker configuration of the geospatial point style.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialpointstyleoptions.html#cfn-quicksight-template-geospatialpointstyleoptions-clustermarkerconfiguration

heatmap_configuration

The heatmap configuration of the geospatial point style.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialpointstyleoptions.html#cfn-quicksight-template-geospatialpointstyleoptions-heatmapconfiguration

selected_point_style

The selected point styles (point, cluster) of the geospatial map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialpointstyleoptions.html#cfn-quicksight-template-geospatialpointstyleoptions-selectedpointstyle

GeospatialWindowOptionsProperty

class CfnTemplatePropsMixin.GeospatialWindowOptionsProperty(*, bounds=None, map_zoom_mode=None)

Bases: object

The window options of the geospatial map visual.

Parameters:

  • bounds (Union[IResolvable, GeospatialCoordinateBoundsProperty, Dict[str, Any], None]) – The bounds options (north, south, west, east) of the geospatial window options.

  • map_zoom_mode (Optional[str]) – The map zoom modes (manual, auto) of the geospatial window options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialwindowoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

geospatial_window_options_property = quicksight_mixins.CfnTemplatePropsMixin.GeospatialWindowOptionsProperty(
    bounds=quicksight_mixins.CfnTemplatePropsMixin.GeospatialCoordinateBoundsProperty(
        east=123,
        north=123,
        south=123,
        west=123
    ),
    map_zoom_mode="mapZoomMode"
)

Attributes

bounds

The bounds options (north, south, west, east) of the geospatial window options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialwindowoptions.html#cfn-quicksight-template-geospatialwindowoptions-bounds

map_zoom_mode

The map zoom modes (manual, auto) of the geospatial window options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-geospatialwindowoptions.html#cfn-quicksight-template-geospatialwindowoptions-mapzoommode

GlobalTableBorderOptionsProperty

class CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(*, side_specific_border=None, uniform_border=None)

Bases: object

Determines the border options for a table visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-globaltableborderoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

global_table_border_options_property = quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
    side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
        bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        ),
        inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        ),
        inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        ),
        left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        ),
        right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        ),
        top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        )
    ),
    uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    )
)

Attributes

side_specific_border

Determines the options for side specific border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-globaltableborderoptions.html#cfn-quicksight-template-globaltableborderoptions-sidespecificborder

uniform_border

Determines the options for uniform border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-globaltableborderoptions.html#cfn-quicksight-template-globaltableborderoptions-uniformborder

GradientColorProperty

class CfnTemplatePropsMixin.GradientColorProperty(*, stops=None)

Bases: object

Determines the gradient color settings.

Parameters:

stops (Union[IResolvable, Sequence[Union[IResolvable, GradientStopProperty, Dict[str, Any]]], None]) – The list of gradient color stops.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientcolor.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

gradient_color_property = quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
        color="color",
        data_value=123,
        gradient_offset=123
    )]
)

Attributes

stops

The list of gradient color stops.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientcolor.html#cfn-quicksight-template-gradientcolor-stops

GradientStopProperty

class CfnTemplatePropsMixin.GradientStopProperty(*, color=None, data_value=None, gradient_offset=None)

Bases: object

Determines the gradient stop configuration.

Parameters:

  • color (Optional[str]) – Determines the color.

  • data_value (Union[int, float, None]) – Determines the data value.

  • gradient_offset (Union[int, float, None]) – Determines gradient offset value. Default: - 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientstop.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

gradient_stop_property = quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
    color="color",
    data_value=123,
    gradient_offset=123
)

Attributes

color

Determines the color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientstop.html#cfn-quicksight-template-gradientstop-color

data_value

Determines the data value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientstop.html#cfn-quicksight-template-gradientstop-datavalue

gradient_offset

Determines gradient offset value.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gradientstop.html#cfn-quicksight-template-gradientstop-gradientoffset

GridLayoutCanvasSizeOptionsProperty

class CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(*, screen_canvas_size_options=None)

Bases: object

Configuration options for the canvas of a grid layout.

Parameters:

screen_canvas_size_options (Union[IResolvable, GridLayoutScreenCanvasSizeOptionsProperty, Dict[str, Any], None]) – The options that determine the sizing of the canvas used in a grid layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutcanvassizeoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

grid_layout_canvas_size_options_property = quicksight_mixins.CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(
    screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
        optimized_view_port_width="optimizedViewPortWidth",
        resize_option="resizeOption"
    )
)

Attributes

screen_canvas_size_options

The options that determine the sizing of the canvas used in a grid layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutcanvassizeoptions.html#cfn-quicksight-template-gridlayoutcanvassizeoptions-screencanvassizeoptions

GridLayoutConfigurationProperty

class CfnTemplatePropsMixin.GridLayoutConfigurationProperty(*, canvas_size_options=None, elements=None)

Bases: object

The configuration for a grid layout. Also called a tiled layout.

Visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

grid_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.GridLayoutConfigurationProperty(
    canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(
        screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
            optimized_view_port_width="optimizedViewPortWidth",
            resize_option="resizeOption"
        )
    ),
    elements=[quicksight_mixins.CfnTemplatePropsMixin.GridLayoutElementProperty(
        column_index=123,
        column_span=123,
        element_id="elementId",
        element_type="elementType",
        row_index=123,
        row_span=123
    )]
)

Attributes

canvas_size_options

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutconfiguration.html#cfn-quicksight-template-gridlayoutconfiguration-canvassizeoptions

Type:

see

elements

The elements that are included in a grid layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutconfiguration.html#cfn-quicksight-template-gridlayoutconfiguration-elements

GridLayoutElementProperty

class CfnTemplatePropsMixin.GridLayoutElementProperty(*, column_index=None, column_span=None, element_id=None, element_type=None, row_index=None, row_span=None)

Bases: object

An element within a grid layout.

Parameters:

  • column_index (Union[int, float, None]) – The column index for the upper left corner of an element.

  • column_span (Union[int, float, None]) – The width of a grid element expressed as a number of grid columns.

  • element_id (Optional[str]) – A unique identifier for an element within a grid layout.

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

  • row_index (Union[int, float, None]) – The row index for the upper left corner of an element.

  • row_span (Union[int, float, None]) – The height of a grid element expressed as a number of grid rows.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

grid_layout_element_property = quicksight_mixins.CfnTemplatePropsMixin.GridLayoutElementProperty(
    column_index=123,
    column_span=123,
    element_id="elementId",
    element_type="elementType",
    row_index=123,
    row_span=123
)

Attributes

column_index

The column index for the upper left corner of an element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-columnindex

column_span

The width of a grid element expressed as a number of grid columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-columnspan

element_id

A unique identifier for an element within a grid layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-elementid

element_type

The type of element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-elementtype

row_index

The row index for the upper left corner of an element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-rowindex

row_span

The height of a grid element expressed as a number of grid rows.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutelement.html#cfn-quicksight-template-gridlayoutelement-rowspan

GridLayoutScreenCanvasSizeOptionsProperty

class CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(*, optimized_view_port_width=None, resize_option=None)

Bases: object

The options that determine the sizing of the canvas used in a grid layout.

Parameters:

  • optimized_view_port_width (Optional[str]) – The width that the view port will be optimized for when the layout renders.

  • resize_option (Optional[str]) – This value determines the layout behavior when the viewport is resized. - FIXED : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called Classic . - RESPONSIVE : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called Tiled .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutscreencanvassizeoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

grid_layout_screen_canvas_size_options_property = quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
    optimized_view_port_width="optimizedViewPortWidth",
    resize_option="resizeOption"
)

Attributes

optimized_view_port_width

The width that the view port will be optimized for when the layout renders.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-template-gridlayoutscreencanvassizeoptions-optimizedviewportwidth

resize_option

This value determines the layout behavior when the viewport is resized.

  • FIXED : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called Classic .

  • RESPONSIVE : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called Tiled .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-template-gridlayoutscreencanvassizeoptions-resizeoption

GrowthRateComputationProperty

class CfnTemplatePropsMixin.GrowthRateComputationProperty(*, computation_id=None, name=None, period_size=None, time=None, value=None)

Bases: object

The growth rate computation configuration.

Parameters:

  • computation_id (Optional[str]) – The ID for a computation.

  • name (Optional[str]) – The name of a computation.

  • period_size (Union[int, float, None]) – The period size setup of a growth rate computation. Default: - 0

  • time (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The time field that is used in a computation.

  • value (Union[IResolvable, MeasureFieldProperty, Dict[str, Any], None]) – The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html#cfn-quicksight-template-growthratecomputation-computationid

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html#cfn-quicksight-template-growthratecomputation-name

period_size

The period size setup of a growth rate computation.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html#cfn-quicksight-template-growthratecomputation-periodsize

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html#cfn-quicksight-template-growthratecomputation-time

value

The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-growthratecomputation.html#cfn-quicksight-template-growthratecomputation-value

HeaderFooterSectionConfigurationProperty

class CfnTemplatePropsMixin.HeaderFooterSectionConfigurationProperty(*, layout=None, section_id=None, style=None)

Bases: object

The configuration of a header or footer section.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-headerfootersectionconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

header_footer_section_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.HeaderFooterSectionConfigurationProperty(
    layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
        free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
            elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                element_id="elementId",
                element_type="elementType",
                height="height",
                loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                    visibility="visibility"
                ),
                rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                    configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                        visibility="visibility"
                    ),
                    expression="expression"
                )],
                selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                visibility="visibility",
                width="width",
                x_axis_location="xAxisLocation",
                y_axis_location="yAxisLocation"
            )]
        )
    ),
    section_id="sectionId",
    style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
        height="height",
        padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
            bottom="bottom",
            left="left",
            right="right",
            top="top"
        )
    )
)

Attributes

layout

The layout configuration of the header or footer section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-headerfootersectionconfiguration.html#cfn-quicksight-template-headerfootersectionconfiguration-layout

section_id

The unique identifier of the header or footer section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-headerfootersectionconfiguration.html#cfn-quicksight-template-headerfootersectionconfiguration-sectionid

style

The style options of a header or footer section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-headerfootersectionconfiguration.html#cfn-quicksight-template-headerfootersectionconfiguration-style

HeatMapAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.HeatMapAggregatedFieldWellsProperty(*, columns=None, rows=None, values=None)

Bases: object

The aggregated field wells of a heat map.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
columns

The columns field well of a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapaggregatedfieldwells.html#cfn-quicksight-template-heatmapaggregatedfieldwells-columns

rows

The rows field well of a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapaggregatedfieldwells.html#cfn-quicksight-template-heatmapaggregatedfieldwells-rows

values

The values field well of a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapaggregatedfieldwells.html#cfn-quicksight-template-heatmapaggregatedfieldwells-values

HeatMapConfigurationProperty

class CfnTemplatePropsMixin.HeatMapConfigurationProperty(*, color_scale=None, column_label_options=None, data_labels=None, field_wells=None, interactions=None, legend=None, row_label_options=None, sort_configuration=None, tooltip=None)

Bases: object

The configuration of a heat map.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
color_scale

The color options (gradient color, point of divergence) in a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-colorscale

column_label_options

The label options of the column that is displayed in a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-columnlabeloptions

data_labels

The options that determine if visual data labels are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-datalabels

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-interactions

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-legend

row_label_options

The label options of the row that is displayed in a heat map .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-rowlabeloptions

sort_configuration

The sort configuration of a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-sortconfiguration

tooltip

The tooltip display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapconfiguration.html#cfn-quicksight-template-heatmapconfiguration-tooltip

HeatMapFieldWellsProperty

class CfnTemplatePropsMixin.HeatMapFieldWellsProperty(*, heat_map_aggregated_field_wells=None)

Bases: object

The field well configuration of a heat map.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

heat_map_aggregated_field_wells (Union[IResolvable, HeatMapAggregatedFieldWellsProperty, Dict[str, Any], None]) – The aggregated field wells of a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
heat_map_aggregated_field_wells

The aggregated field wells of a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapfieldwells.html#cfn-quicksight-template-heatmapfieldwells-heatmapaggregatedfieldwells

HeatMapSortConfigurationProperty

class CfnTemplatePropsMixin.HeatMapSortConfigurationProperty(*, heat_map_column_items_limit_configuration=None, heat_map_column_sort=None, heat_map_row_items_limit_configuration=None, heat_map_row_sort=None)

Bases: object

The sort configuration of a heat map.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

heat_map_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.HeatMapSortConfigurationProperty(
    heat_map_column_items_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    heat_map_column_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    heat_map_row_items_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    heat_map_row_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

heat_map_column_items_limit_configuration

The limit on the number of columns that are displayed in a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapsortconfiguration.html#cfn-quicksight-template-heatmapsortconfiguration-heatmapcolumnitemslimitconfiguration

heat_map_column_sort

The column sort configuration for heat map for columns that aren’t a part of a field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapsortconfiguration.html#cfn-quicksight-template-heatmapsortconfiguration-heatmapcolumnsort

heat_map_row_items_limit_configuration

The limit on the number of rows that are displayed in a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapsortconfiguration.html#cfn-quicksight-template-heatmapsortconfiguration-heatmaprowitemslimitconfiguration

heat_map_row_sort

The field sort configuration of the rows fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapsortconfiguration.html#cfn-quicksight-template-heatmapsortconfiguration-heatmaprowsort

HeatMapVisualProperty

class CfnTemplatePropsMixin.HeatMapVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A heat map.

For more information, see Using heat maps in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration of a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-heatmapvisual.html#cfn-quicksight-template-heatmapvisual-visualid

HistogramAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.HistogramAggregatedFieldWellsProperty(*, values=None)

Bases: object

The field well configuration of a histogram.

Parameters:

values (Union[IResolvable, Sequence[Union[IResolvable, MeasureFieldProperty, Dict[str, Any]]], None]) – The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramaggregatedfieldwells.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

histogram_aggregated_field_wells_property = quicksight_mixins.CfnTemplatePropsMixin.HistogramAggregatedFieldWellsProperty(
    values=[quicksight_mixins.CfnTemplatePropsMixin.MeasureFieldProperty(
        calculated_measure_field=quicksight_mixins.CfnTemplatePropsMixin.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight_mixins.CfnTemplatePropsMixin.CategoricalMeasureFieldProperty(
            aggregation_function="aggregationFunction",
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight_mixins.CfnTemplatePropsMixin.DateMeasureFieldProperty(
            aggregation_function="aggregationFunction",
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight_mixins.CfnTemplatePropsMixin.NumericalMeasureFieldProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
                format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        )
    )]
)

Attributes

values

The value field wells of a histogram.

Values are aggregated by COUNT or DISTINCT_COUNT .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramaggregatedfieldwells.html#cfn-quicksight-template-histogramaggregatedfieldwells-values

HistogramBinOptionsProperty

class CfnTemplatePropsMixin.HistogramBinOptionsProperty(*, bin_count=None, bin_width=None, selected_bin_type=None, start_value=None)

Bases: object

The options that determine the presentation of histogram bins.

Parameters:

  • bin_count (Union[IResolvable, BinCountOptionsProperty, Dict[str, Any], None]) – The options that determine the bin count of a histogram.

  • bin_width (Union[IResolvable, BinWidthOptionsProperty, Dict[str, Any], None]) – The options that determine the bin width of a histogram.

  • selected_bin_type (Optional[str]) – The options that determine the selected bin type.

  • start_value (Union[int, float, None]) – The options that determine the bin start value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogrambinoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

histogram_bin_options_property = quicksight_mixins.CfnTemplatePropsMixin.HistogramBinOptionsProperty(
    bin_count=quicksight_mixins.CfnTemplatePropsMixin.BinCountOptionsProperty(
        value=123
    ),
    bin_width=quicksight_mixins.CfnTemplatePropsMixin.BinWidthOptionsProperty(
        bin_count_limit=123,
        value=123
    ),
    selected_bin_type="selectedBinType",
    start_value=123
)

Attributes

bin_count

The options that determine the bin count of a histogram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogrambinoptions.html#cfn-quicksight-template-histogrambinoptions-bincount

bin_width

The options that determine the bin width of a histogram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogrambinoptions.html#cfn-quicksight-template-histogrambinoptions-binwidth

selected_bin_type

The options that determine the selected bin type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogrambinoptions.html#cfn-quicksight-template-histogrambinoptions-selectedbintype

start_value

The options that determine the bin start value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogrambinoptions.html#cfn-quicksight-template-histogrambinoptions-startvalue

HistogramConfigurationProperty

class CfnTemplatePropsMixin.HistogramConfigurationProperty(*, bin_options=None, data_labels=None, field_wells=None, interactions=None, tooltip=None, visual_palette=None, x_axis_display_options=None, x_axis_label_options=None, y_axis_display_options=None)

Bases: object

The configuration for a HistogramVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
bin_options

The options that determine the presentation of histogram bins.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-binoptions

data_labels

The data label configuration of a histogram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-datalabels

field_wells

The field well configuration of a histogram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-interactions

tooltip

The tooltip configuration of a histogram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-tooltip

visual_palette

The visual palette configuration of a histogram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-visualpalette

x_axis_display_options

The options that determine the presentation of the x-axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-xaxisdisplayoptions

x_axis_label_options

The options that determine the presentation of the x-axis label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-xaxislabeloptions

y_axis_display_options

The options that determine the presentation of the y-axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramconfiguration.html#cfn-quicksight-template-histogramconfiguration-yaxisdisplayoptions

HistogramFieldWellsProperty

class CfnTemplatePropsMixin.HistogramFieldWellsProperty(*, histogram_aggregated_field_wells=None)

Bases: object

The field well configuration of a histogram.

Parameters:

histogram_aggregated_field_wells (Union[IResolvable, HistogramAggregatedFieldWellsProperty, Dict[str, Any], None]) – The field well configuration of a histogram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramfieldwells.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

histogram_field_wells_property = quicksight_mixins.CfnTemplatePropsMixin.HistogramFieldWellsProperty(
    histogram_aggregated_field_wells=quicksight_mixins.CfnTemplatePropsMixin.HistogramAggregatedFieldWellsProperty(
        values=[quicksight_mixins.CfnTemplatePropsMixin.MeasureFieldProperty(
            calculated_measure_field=quicksight_mixins.CfnTemplatePropsMixin.CalculatedMeasureFieldProperty(
                expression="expression",
                field_id="fieldId"
            ),
            categorical_measure_field=quicksight_mixins.CfnTemplatePropsMixin.CategoricalMeasureFieldProperty(
                aggregation_function="aggregationFunction",
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",
                format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                    grouping_style="groupingStyle",
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                    grouping_style="groupingStyle",
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                    grouping_style="groupingStyle",
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            date_measure_field=quicksight_mixins.CfnTemplatePropsMixin.DateMeasureFieldProperty(
                aggregation_function="aggregationFunction",
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",
                format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
                    date_time_format="dateTimeFormat",
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                    grouping_style="groupingStyle",
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                    grouping_style="groupingStyle",
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                    grouping_style="groupingStyle",
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            numerical_measure_field=quicksight_mixins.CfnTemplatePropsMixin.NumericalMeasureFieldProperty(
                aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                ),
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",
                format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
                    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                    grouping_style="groupingStyle",
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                    grouping_style="groupingStyle",
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                    grouping_style="groupingStyle",
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            )
        )]
    )
)

Attributes

histogram_aggregated_field_wells

The field well configuration of a histogram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramfieldwells.html#cfn-quicksight-template-histogramfieldwells-histogramaggregatedfieldwells

HistogramVisualProperty

class CfnTemplatePropsMixin.HistogramVisualProperty(*, actions=None, chart_configuration=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A histogram.

For more information, see Using histograms in the Amazon Quick Suite User Guide .

Parameters:

  • actions (Union[IResolvable, Sequence[Union[IResolvable, VisualCustomActionProperty, Dict[str, Any]]], None]) – The list of custom actions that are configured for a visual.

  • chart_configuration (Union[IResolvable, HistogramConfigurationProperty, Dict[str, Any], None]) – The configuration for a HistogramVisual .

  • subtitle (Union[IResolvable, VisualSubtitleLabelOptionsProperty, Dict[str, Any], None]) – The subtitle that is displayed on the visual.

  • title (Union[IResolvable, VisualTitleLabelOptionsProperty, Dict[str, Any], None]) – The title that is displayed on the visual.

  • visual_content_alt_text (Optional[str]) – The alt text for the visual.

  • visual_id (Optional[str]) – The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration for a HistogramVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-chartconfiguration

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-histogramvisual.html#cfn-quicksight-template-histogramvisual-visualid

ImageCustomActionOperationProperty

class CfnTemplatePropsMixin.ImageCustomActionOperationProperty(*, navigation_operation=None, set_parameters_operation=None, url_operation=None)

Bases: object

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomactionoperation.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

image_custom_action_operation_property = quicksight_mixins.CfnTemplatePropsMixin.ImageCustomActionOperationProperty(
    navigation_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionNavigationOperationProperty(
        local_navigation_configuration=quicksight_mixins.CfnTemplatePropsMixin.LocalNavigationConfigurationProperty(
            target_sheet_id="targetSheetId"
        )
    ),
    set_parameters_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionSetParametersOperationProperty(
        parameter_value_configurations=[quicksight_mixins.CfnTemplatePropsMixin.SetParameterValueConfigurationProperty(
            destination_parameter_name="destinationParameterName",
            value=quicksight_mixins.CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(
                custom_values_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
                    custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
                        date_time_values=["dateTimeValues"],
                        decimal_values=[123],
                        integer_values=[123],
                        string_values=["stringValues"]
                    ),
                    include_null_value=False
                ),
                select_all_value_options="selectAllValueOptions",
                source_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_field="sourceField",
                source_parameter_name="sourceParameterName"
            )
        )]
    ),
    url_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionURLOperationProperty(
        url_target="urlTarget",
        url_template="urlTemplate"
    )
)

Attributes

navigation_operation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomactionoperation.html#cfn-quicksight-template-imagecustomactionoperation-navigationoperation

Type:

see

set_parameters_operation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomactionoperation.html#cfn-quicksight-template-imagecustomactionoperation-setparametersoperation

Type:

see

url_operation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomactionoperation.html#cfn-quicksight-template-imagecustomactionoperation-urloperation

Type:

see

ImageCustomActionProperty

class CfnTemplatePropsMixin.ImageCustomActionProperty(*, action_operations=None, custom_action_id=None, name=None, status=None, trigger=None)

Bases: object

A custom action defined on an image.

Parameters:

  • action_operations (Union[IResolvable, Sequence[Union[IResolvable, ImageCustomActionOperationProperty, Dict[str, Any]]], None]) – A list of ImageCustomActionOperations . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

  • custom_action_id (Optional[str]) – The ID of the custom action.

  • name (Optional[str]) – The name of the custom action.

  • status (Optional[str]) – The status of the custom action.

  • trigger (Optional[str]) – The trigger of the VisualCustomAction . Valid values are defined as follows: - CLICK : Initiates a custom action by a left pointer click on a data point. - MENU : Initiates a custom action by right pointer click from the menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

image_custom_action_property = quicksight_mixins.CfnTemplatePropsMixin.ImageCustomActionProperty(
    action_operations=[quicksight_mixins.CfnTemplatePropsMixin.ImageCustomActionOperationProperty(
        navigation_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionNavigationOperationProperty(
            local_navigation_configuration=quicksight_mixins.CfnTemplatePropsMixin.LocalNavigationConfigurationProperty(
                target_sheet_id="targetSheetId"
            )
        ),
        set_parameters_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionSetParametersOperationProperty(
            parameter_value_configurations=[quicksight_mixins.CfnTemplatePropsMixin.SetParameterValueConfigurationProperty(
                destination_parameter_name="destinationParameterName",
                value=quicksight_mixins.CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(
                    custom_values_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
                        custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
                            date_time_values=["dateTimeValues"],
                            decimal_values=[123],
                            integer_values=[123],
                            string_values=["stringValues"]
                        ),
                        include_null_value=False
                    ),
                    select_all_value_options="selectAllValueOptions",
                    source_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    ),
                    source_field="sourceField",
                    source_parameter_name="sourceParameterName"
                )
            )]
        ),
        url_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionURLOperationProperty(
            url_target="urlTarget",
            url_template="urlTemplate"
        )
    )],
    custom_action_id="customActionId",
    name="name",
    status="status",
    trigger="trigger"
)

Attributes

action_operations

A list of ImageCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-actionoperations

custom_action_id

The ID of the custom action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-customactionid

name

The name of the custom action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-name

status

The status of the custom action.

See:

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

trigger

The trigger of the VisualCustomAction .

Valid values are defined as follows:

  • CLICK : Initiates a custom action by a left pointer click on a data point.

  • MENU : Initiates a custom action by right pointer click from the menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagecustomaction.html#cfn-quicksight-template-imagecustomaction-trigger

ImageInteractionOptionsProperty

class CfnTemplatePropsMixin.ImageInteractionOptionsProperty(*, image_menu_option=None)

Bases: object

The general image interactions setup for image publish options.

Parameters:

image_menu_option (Union[IResolvable, ImageMenuOptionProperty, Dict[str, Any], None]) – The menu options for the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imageinteractionoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

image_interaction_options_property = quicksight_mixins.CfnTemplatePropsMixin.ImageInteractionOptionsProperty(
    image_menu_option=quicksight_mixins.CfnTemplatePropsMixin.ImageMenuOptionProperty(
        availability_status="availabilityStatus"
    )
)

Attributes

image_menu_option

The menu options for the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imageinteractionoptions.html#cfn-quicksight-template-imageinteractionoptions-imagemenuoption

ImageMenuOptionProperty

class CfnTemplatePropsMixin.ImageMenuOptionProperty(*, availability_status=None)

Bases: object

The menu options for the interactions of an image.

Parameters:

availability_status (Optional[str]) – The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagemenuoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

image_menu_option_property = quicksight_mixins.CfnTemplatePropsMixin.ImageMenuOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

The availability status of the image menu.

If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-imagemenuoption.html#cfn-quicksight-template-imagemenuoption-availabilitystatus

InnerFilterProperty

class CfnTemplatePropsMixin.InnerFilterProperty(*, category_inner_filter=None)

Bases: object

The InnerFilter defines the subset of data to be used with the NestedFilter .

Parameters:

category_inner_filter (Union[IResolvable, CategoryInnerFilterProperty, Dict[str, Any], None]) – A CategoryInnerFilter filters text values for the NestedFilter .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-innerfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

inner_filter_property = quicksight_mixins.CfnTemplatePropsMixin.InnerFilterProperty(
    category_inner_filter=quicksight_mixins.CfnTemplatePropsMixin.CategoryInnerFilterProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        configuration=quicksight_mixins.CfnTemplatePropsMixin.CategoryFilterConfigurationProperty(
            custom_filter_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomFilterConfigurationProperty(
                category_value="categoryValue",
                match_operator="matchOperator",
                null_option="nullOption",
                parameter_name="parameterName",
                select_all_options="selectAllOptions"
            ),
            custom_filter_list_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomFilterListConfigurationProperty(
                category_values=["categoryValues"],
                match_operator="matchOperator",
                null_option="nullOption",
                select_all_options="selectAllOptions"
            ),
            filter_list_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterListConfigurationProperty(
                category_values=["categoryValues"],
                match_operator="matchOperator",
                null_option="nullOption",
                select_all_options="selectAllOptions"
            )
        ),
        default_filter_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
            control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
                default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
                    commit_mode="commitMode",
                    display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                        date_icon_visibility=date_icon_visibility,
                        date_time_format="dateTimeFormat",
                        helper_text_visibility=helper_text_visibility,
                        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_family="fontFamily",
                                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                    absolute="absolute",
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    ),
                    type="type"
                ),
                default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
                    commit_mode="commitMode",
                    display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                            visibility="visibility"
                        ),
                        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_family="fontFamily",
                                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                    absolute="absolute",
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    ),
                    selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                        values=["values"]
                    ),
                    type="type"
                ),
                default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
                    display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                            visibility="visibility"
                        ),
                        select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                            visibility="visibility"
                        ),
                        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_family="fontFamily",
                                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                    absolute="absolute",
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    ),
                    selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                        values=["values"]
                    ),
                    type="type"
                ),
                default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
                    commit_mode="commitMode",
                    display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                        date_time_format="dateTimeFormat",
                        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_family="fontFamily",
                                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                    absolute="absolute",
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    )
                ),
                default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
                    display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_family="fontFamily",
                                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                    absolute="absolute",
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    ),
                    maximum_value=123,
                    minimum_value=123,
                    step_size=123,
                    type="type"
                ),
                default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
                    delimiter="delimiter",
                    display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                            visibility="visibility"
                        ),
                        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_family="fontFamily",
                                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                    absolute="absolute",
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    )
                ),
                default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
                    display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                            visibility="visibility"
                        ),
                        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_family="fontFamily",
                                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                    absolute="absolute",
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    )
                )
            ),
            title="title"
        )
    )
)

Attributes

category_inner_filter

A CategoryInnerFilter filters text values for the NestedFilter .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-innerfilter.html#cfn-quicksight-template-innerfilter-categoryinnerfilter

InsightConfigurationProperty

class CfnTemplatePropsMixin.InsightConfigurationProperty(*, computations=None, custom_narrative=None, interactions=None)

Bases: object

The configuration of an insight visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
computations

The computations configurations of the insight visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightconfiguration.html#cfn-quicksight-template-insightconfiguration-computations

custom_narrative

The custom narrative of the insight visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightconfiguration.html#cfn-quicksight-template-insightconfiguration-customnarrative

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightconfiguration.html#cfn-quicksight-template-insightconfiguration-interactions

InsightVisualProperty

class CfnTemplatePropsMixin.InsightVisualProperty(*, actions=None, data_set_identifier=None, insight_configuration=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

An insight visual.

For more information, see Working with insights in the Amazon Quick Suite User Guide .

Parameters:

  • actions (Union[IResolvable, Sequence[Union[IResolvable, VisualCustomActionProperty, Dict[str, Any]]], None]) – The list of custom actions that are configured for a visual.

  • data_set_identifier (Optional[str]) – The dataset that is used in the insight visual.

  • insight_configuration (Union[IResolvable, InsightConfigurationProperty, Dict[str, Any], None]) – The configuration of an insight visual.

  • subtitle (Union[IResolvable, VisualSubtitleLabelOptionsProperty, Dict[str, Any], None]) – The subtitle that is displayed on the visual.

  • title (Union[IResolvable, VisualTitleLabelOptionsProperty, Dict[str, Any], None]) – The title that is displayed on the visual.

  • visual_content_alt_text (Optional[str]) – The alt text for the visual.

  • visual_id (Optional[str]) – The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

data_set_identifier

The dataset that is used in the insight visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-datasetidentifier

insight_configuration

The configuration of an insight visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-insightconfiguration

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-insightvisual.html#cfn-quicksight-template-insightvisual-visualid

IntegerDefaultValuesProperty

class CfnTemplatePropsMixin.IntegerDefaultValuesProperty(*, dynamic_value=None, static_values=None)

Bases: object

The default values of the IntegerParameterDeclaration .

Parameters:

  • dynamic_value (Union[IResolvable, DynamicDefaultValueProperty, Dict[str, Any], None]) – The dynamic value of the IntegerDefaultValues . Different defaults are displayed according to users, groups, and values mapping.

  • static_values (Union[Sequence[Union[int, float]], IResolvable, None]) – The static values of the IntegerDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerdefaultvalues.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

integer_default_values_property = quicksight_mixins.CfnTemplatePropsMixin.IntegerDefaultValuesProperty(
    dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
        default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    ),
    static_values=[123]
)

Attributes

dynamic_value

The dynamic value of the IntegerDefaultValues .

Different defaults are displayed according to users, groups, and values mapping.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerdefaultvalues.html#cfn-quicksight-template-integerdefaultvalues-dynamicvalue

static_values

The static values of the IntegerDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerdefaultvalues.html#cfn-quicksight-template-integerdefaultvalues-staticvalues

IntegerParameterDeclarationProperty

class CfnTemplatePropsMixin.IntegerParameterDeclarationProperty(*, default_values=None, mapped_data_set_parameters=None, name=None, parameter_value_type=None, value_when_unset=None)

Bases: object

A parameter declaration for the Integer data type.

Parameters:

  • default_values (Union[IResolvable, IntegerDefaultValuesProperty, Dict[str, Any], None]) – The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

  • mapped_data_set_parameters (Union[IResolvable, Sequence[Union[IResolvable, MappedDataSetParameterProperty, Dict[str, Any]]], None])

  • name (Optional[str]) – The name of the parameter that is being declared.

  • parameter_value_type (Optional[str]) – The value type determines whether the parameter is a single-value or multi-value parameter.

  • value_when_unset (Union[IResolvable, IntegerValueWhenUnsetConfigurationProperty, Dict[str, Any], None]) – A parameter declaration for the Integer data type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

integer_parameter_declaration_property = quicksight_mixins.CfnTemplatePropsMixin.IntegerParameterDeclarationProperty(
    default_values=quicksight_mixins.CfnTemplatePropsMixin.IntegerDefaultValuesProperty(
        dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
            default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        static_values=[123]
    ),
    mapped_data_set_parameters=[quicksight_mixins.CfnTemplatePropsMixin.MappedDataSetParameterProperty(
        data_set_identifier="dataSetIdentifier",
        data_set_parameter_name="dataSetParameterName"
    )],
    name="name",
    parameter_value_type="parameterValueType",
    value_when_unset=quicksight_mixins.CfnTemplatePropsMixin.IntegerValueWhenUnsetConfigurationProperty(
        custom_value=123,
        value_when_unset_option="valueWhenUnsetOption"
    )
)

Attributes

default_values

The default values of a parameter.

If the parameter is a single-value parameter, a maximum of one default value can be provided.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html#cfn-quicksight-template-integerparameterdeclaration-defaultvalues

mapped_data_set_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html#cfn-quicksight-template-integerparameterdeclaration-mappeddatasetparameters

Type:

see

name

The name of the parameter that is being declared.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html#cfn-quicksight-template-integerparameterdeclaration-name

parameter_value_type

The value type determines whether the parameter is a single-value or multi-value parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html#cfn-quicksight-template-integerparameterdeclaration-parametervaluetype

value_when_unset

A parameter declaration for the Integer data type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integerparameterdeclaration.html#cfn-quicksight-template-integerparameterdeclaration-valuewhenunset

IntegerValueWhenUnsetConfigurationProperty

class CfnTemplatePropsMixin.IntegerValueWhenUnsetConfigurationProperty(*, custom_value=None, value_when_unset_option=None)

Bases: object

A parameter declaration for the Integer data type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • custom_value (Union[int, float, None]) – A custom value that’s used when the value of a parameter isn’t set.

  • value_when_unset_option (Optional[str]) – The built-in options for default values. The value can be one of the following:. - RECOMMENDED : The recommended value. - NULL : The NULL value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integervaluewhenunsetconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

integer_value_when_unset_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.IntegerValueWhenUnsetConfigurationProperty(
    custom_value=123,
    value_when_unset_option="valueWhenUnsetOption"
)

Attributes

custom_value

A custom value that’s used when the value of a parameter isn’t set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integervaluewhenunsetconfiguration.html#cfn-quicksight-template-integervaluewhenunsetconfiguration-customvalue

value_when_unset_option

.

  • RECOMMENDED : The recommended value.

  • NULL : The NULL value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-integervaluewhenunsetconfiguration.html#cfn-quicksight-template-integervaluewhenunsetconfiguration-valuewhenunsetoption

Type:

The built-in options for default values. The value can be one of the following

ItemsLimitConfigurationProperty

class CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(*, items_limit=None, other_categories=None)

Bases: object

The limit configuration of the visual display for an axis.

Parameters:

  • items_limit (Union[int, float, None]) – The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

  • other_categories (Optional[str]) – The Show other of an axis in the chart. Choose one of the following options:. - INCLUDE - EXCLUDE

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-itemslimitconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

items_limit_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
    items_limit=123,
    other_categories="otherCategories"
)

Attributes

items_limit

The limit on how many items of a field are showed in the chart.

For example, the number of slices that are displayed in a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-itemslimitconfiguration.html#cfn-quicksight-template-itemslimitconfiguration-itemslimit

other_categories

.

  • INCLUDE

  • EXCLUDE

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-itemslimitconfiguration.html#cfn-quicksight-template-itemslimitconfiguration-othercategories

Type:

The Show other of an axis in the chart. Choose one of the following options

KPIActualValueConditionalFormattingProperty

class CfnTemplatePropsMixin.KPIActualValueConditionalFormattingProperty(*, icon=None, text_color=None)

Bases: object

The conditional formatting for the actual value of a KPI visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiactualvalueconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pIActual_value_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.KPIActualValueConditionalFormattingProperty(
    icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
        custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
            color="color",
            display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                icon_display_option="iconDisplayOption"
            ),
            expression="expression",
            icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                icon="icon",
                unicode_icon="unicodeIcon"
            )
        ),
        icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
            expression="expression",
            icon_set_type="iconSetType"
        )
    ),
    text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    )
)

Attributes

icon

The conditional formatting of the actual value’s icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiactualvalueconditionalformatting.html#cfn-quicksight-template-kpiactualvalueconditionalformatting-icon

text_color

The conditional formatting of the actual value’s text color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiactualvalueconditionalformatting.html#cfn-quicksight-template-kpiactualvalueconditionalformatting-textcolor

KPIComparisonValueConditionalFormattingProperty

class CfnTemplatePropsMixin.KPIComparisonValueConditionalFormattingProperty(*, icon=None, text_color=None)

Bases: object

The conditional formatting for the comparison value of a KPI visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpicomparisonvalueconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pIComparison_value_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.KPIComparisonValueConditionalFormattingProperty(
    icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
        custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
            color="color",
            display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                icon_display_option="iconDisplayOption"
            ),
            expression="expression",
            icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                icon="icon",
                unicode_icon="unicodeIcon"
            )
        ),
        icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
            expression="expression",
            icon_set_type="iconSetType"
        )
    ),
    text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    )
)

Attributes

icon

The conditional formatting of the comparison value’s icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpicomparisonvalueconditionalformatting.html#cfn-quicksight-template-kpicomparisonvalueconditionalformatting-icon

text_color

The conditional formatting of the comparison value’s text color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpicomparisonvalueconditionalformatting.html#cfn-quicksight-template-kpicomparisonvalueconditionalformatting-textcolor

KPIConditionalFormattingOptionProperty

class CfnTemplatePropsMixin.KPIConditionalFormattingOptionProperty(*, actual_value=None, comparison_value=None, primary_value=None, progress_bar=None)

Bases: object

The conditional formatting options of a KPI visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pIConditional_formatting_option_property = quicksight_mixins.CfnTemplatePropsMixin.KPIConditionalFormattingOptionProperty(
    actual_value=quicksight_mixins.CfnTemplatePropsMixin.KPIActualValueConditionalFormattingProperty(
        icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
            custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                color="color",
                display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                ),
                expression="expression",
                icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                )
            ),
            icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                expression="expression",
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        )
    ),
    comparison_value=quicksight_mixins.CfnTemplatePropsMixin.KPIComparisonValueConditionalFormattingProperty(
        icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
            custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                color="color",
                display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                ),
                expression="expression",
                icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                )
            ),
            icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                expression="expression",
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        )
    ),
    primary_value=quicksight_mixins.CfnTemplatePropsMixin.KPIPrimaryValueConditionalFormattingProperty(
        icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
            custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                color="color",
                display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                ),
                expression="expression",
                icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                )
            ),
            icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                expression="expression",
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        )
    ),
    progress_bar=quicksight_mixins.CfnTemplatePropsMixin.KPIProgressBarConditionalFormattingProperty(
        foreground_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        )
    )
)

Attributes

actual_value

The conditional formatting for the actual value of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-actualvalue

comparison_value

The conditional formatting for the comparison value of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-comparisonvalue

primary_value

The conditional formatting for the primary value of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-primaryvalue

progress_bar

The conditional formatting for the progress bar of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformattingoption.html#cfn-quicksight-template-kpiconditionalformattingoption-progressbar

KPIConditionalFormattingProperty

class CfnTemplatePropsMixin.KPIConditionalFormattingProperty(*, conditional_formatting_options=None)

Bases: object

The conditional formatting of a KPI visual.

Parameters:

conditional_formatting_options (Union[IResolvable, Sequence[Union[IResolvable, KPIConditionalFormattingOptionProperty, Dict[str, Any]]], None]) – The conditional formatting options of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pIConditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.KPIConditionalFormattingProperty(
    conditional_formatting_options=[quicksight_mixins.CfnTemplatePropsMixin.KPIConditionalFormattingOptionProperty(
        actual_value=quicksight_mixins.CfnTemplatePropsMixin.KPIActualValueConditionalFormattingProperty(
            icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
                custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                    color="color",
                    display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    ),
                    expression="expression",
                    icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    )
                ),
                icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                    expression="expression",
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            )
        ),
        comparison_value=quicksight_mixins.CfnTemplatePropsMixin.KPIComparisonValueConditionalFormattingProperty(
            icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
                custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                    color="color",
                    display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    ),
                    expression="expression",
                    icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    )
                ),
                icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                    expression="expression",
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            )
        ),
        primary_value=quicksight_mixins.CfnTemplatePropsMixin.KPIPrimaryValueConditionalFormattingProperty(
            icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
                custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                    color="color",
                    display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    ),
                    expression="expression",
                    icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    )
                ),
                icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                    expression="expression",
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            )
        ),
        progress_bar=quicksight_mixins.CfnTemplatePropsMixin.KPIProgressBarConditionalFormattingProperty(
            foreground_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            )
        )
    )]
)

Attributes

conditional_formatting_options

The conditional formatting options of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconditionalformatting.html#cfn-quicksight-template-kpiconditionalformatting-conditionalformattingoptions

KPIConfigurationProperty

class CfnTemplatePropsMixin.KPIConfigurationProperty(*, field_wells=None, interactions=None, kpi_options=None, sort_configuration=None)

Bases: object

The configuration of a KPI visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
field_wells

The field well configuration of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconfiguration.html#cfn-quicksight-template-kpiconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconfiguration.html#cfn-quicksight-template-kpiconfiguration-interactions

kpi_options

The options that determine the presentation of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconfiguration.html#cfn-quicksight-template-kpiconfiguration-kpioptions

sort_configuration

The sort configuration of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiconfiguration.html#cfn-quicksight-template-kpiconfiguration-sortconfiguration

KPIFieldWellsProperty

class CfnTemplatePropsMixin.KPIFieldWellsProperty(*, target_values=None, trend_groups=None, values=None)

Bases: object

The field well configuration of a KPI visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpifieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
target_values

The target value field wells of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpifieldwells.html#cfn-quicksight-template-kpifieldwells-targetvalues

trend_groups

The trend group field wells of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpifieldwells.html#cfn-quicksight-template-kpifieldwells-trendgroups

values

The value field wells of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpifieldwells.html#cfn-quicksight-template-kpifieldwells-values

KPIOptionsProperty

class CfnTemplatePropsMixin.KPIOptionsProperty(*, comparison=None, primary_value_display_type=None, primary_value_font_configuration=None, progress_bar=None, secondary_value=None, secondary_value_font_configuration=None, sparkline=None, trend_arrows=None, visual_layout_options=None)

Bases: object

The options that determine the presentation of a KPI visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pIOptions_property = quicksight_mixins.CfnTemplatePropsMixin.KPIOptionsProperty(
    comparison=quicksight_mixins.CfnTemplatePropsMixin.ComparisonConfigurationProperty(
        comparison_format=quicksight_mixins.CfnTemplatePropsMixin.ComparisonFormatConfigurationProperty(
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        ),
        comparison_method="comparisonMethod"
    ),
    primary_value_display_type="primaryValueDisplayType",
    primary_value_font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    ),
    progress_bar=quicksight_mixins.CfnTemplatePropsMixin.ProgressBarOptionsProperty(
        visibility="visibility"
    ),
    secondary_value=quicksight_mixins.CfnTemplatePropsMixin.SecondaryValueOptionsProperty(
        visibility="visibility"
    ),
    secondary_value_font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    ),
    sparkline=quicksight_mixins.CfnTemplatePropsMixin.KPISparklineOptionsProperty(
        color="color",
        tooltip_visibility="tooltipVisibility",
        type="type",
        visibility="visibility"
    ),
    trend_arrows=quicksight_mixins.CfnTemplatePropsMixin.TrendArrowOptionsProperty(
        visibility="visibility"
    ),
    visual_layout_options=quicksight_mixins.CfnTemplatePropsMixin.KPIVisualLayoutOptionsProperty(
        standard_layout=quicksight_mixins.CfnTemplatePropsMixin.KPIVisualStandardLayoutProperty(
            type="type"
        )
    )
)

Attributes

comparison

The comparison configuration of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-comparison

primary_value_display_type

The options that determine the primary value display type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-primaryvaluedisplaytype

primary_value_font_configuration

The options that determine the primary value font configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-primaryvaluefontconfiguration

progress_bar

The options that determine the presentation of the progress bar of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-progressbar

secondary_value

The options that determine the presentation of the secondary value of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-secondaryvalue

secondary_value_font_configuration

The options that determine the secondary value font configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-secondaryvaluefontconfiguration

sparkline

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-sparkline

trend_arrows

The options that determine the presentation of trend arrows in a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-trendarrows

visual_layout_options

The options that determine the layout a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpioptions.html#cfn-quicksight-template-kpioptions-visuallayoutoptions

KPIPrimaryValueConditionalFormattingProperty

class CfnTemplatePropsMixin.KPIPrimaryValueConditionalFormattingProperty(*, icon=None, text_color=None)

Bases: object

The conditional formatting for the primary value of a KPI visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiprimaryvalueconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pIPrimary_value_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.KPIPrimaryValueConditionalFormattingProperty(
    icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
        custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
            color="color",
            display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                icon_display_option="iconDisplayOption"
            ),
            expression="expression",
            icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                icon="icon",
                unicode_icon="unicodeIcon"
            )
        ),
        icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
            expression="expression",
            icon_set_type="iconSetType"
        )
    ),
    text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    )
)

Attributes

icon

The conditional formatting of the primary value’s icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiprimaryvalueconditionalformatting.html#cfn-quicksight-template-kpiprimaryvalueconditionalformatting-icon

text_color

The conditional formatting of the primary value’s text color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiprimaryvalueconditionalformatting.html#cfn-quicksight-template-kpiprimaryvalueconditionalformatting-textcolor

KPIProgressBarConditionalFormattingProperty

class CfnTemplatePropsMixin.KPIProgressBarConditionalFormattingProperty(*, foreground_color=None)

Bases: object

The conditional formatting for the progress bar of a KPI visual.

Parameters:

foreground_color (Union[IResolvable, ConditionalFormattingColorProperty, Dict[str, Any], None]) – The conditional formatting of the progress bar’s foreground color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiprogressbarconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pIProgress_bar_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.KPIProgressBarConditionalFormattingProperty(
    foreground_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    )
)

Attributes

foreground_color

The conditional formatting of the progress bar’s foreground color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpiprogressbarconditionalformatting.html#cfn-quicksight-template-kpiprogressbarconditionalformatting-foregroundcolor

KPISortConfigurationProperty

class CfnTemplatePropsMixin.KPISortConfigurationProperty(*, trend_group_sort=None)

Bases: object

The sort configuration of a KPI visual.

Parameters:

trend_group_sort (Union[IResolvable, Sequence[Union[IResolvable, FieldSortOptionsProperty, Dict[str, Any]]], None]) – The sort configuration of the trend group fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pISort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.KPISortConfigurationProperty(
    trend_group_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

trend_group_sort

The sort configuration of the trend group fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisortconfiguration.html#cfn-quicksight-template-kpisortconfiguration-trendgroupsort

KPISparklineOptionsProperty

class CfnTemplatePropsMixin.KPISparklineOptionsProperty(*, color=None, tooltip_visibility=None, type=None, visibility=None)

Bases: object

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

Parameters:

  • color (Optional[str]) – The color of the sparkline.

  • tooltip_visibility (Optional[str]) – The tooltip visibility of the sparkline.

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

  • visibility (Optional[str]) – The visibility of the sparkline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pISparkline_options_property = quicksight_mixins.CfnTemplatePropsMixin.KPISparklineOptionsProperty(
    color="color",
    tooltip_visibility="tooltipVisibility",
    type="type",
    visibility="visibility"
)

Attributes

color

The color of the sparkline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-color

tooltip_visibility

The tooltip visibility of the sparkline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-tooltipvisibility

type

The type of the sparkline.

See:

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

visibility

The visibility of the sparkline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpisparklineoptions.html#cfn-quicksight-template-kpisparklineoptions-visibility

KPIVisualLayoutOptionsProperty

class CfnTemplatePropsMixin.KPIVisualLayoutOptionsProperty(*, standard_layout=None)

Bases: object

The options that determine the layout a KPI visual.

Parameters:

standard_layout (Union[IResolvable, KPIVisualStandardLayoutProperty, Dict[str, Any], None]) – The standard layout of the KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisuallayoutoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pIVisual_layout_options_property = quicksight_mixins.CfnTemplatePropsMixin.KPIVisualLayoutOptionsProperty(
    standard_layout=quicksight_mixins.CfnTemplatePropsMixin.KPIVisualStandardLayoutProperty(
        type="type"
    )
)

Attributes

standard_layout

The standard layout of the KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisuallayoutoptions.html#cfn-quicksight-template-kpivisuallayoutoptions-standardlayout

KPIVisualProperty

class CfnTemplatePropsMixin.KPIVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, conditional_formatting=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-columnhierarchies

conditional_formatting

The conditional formatting of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-conditionalformatting

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisual.html#cfn-quicksight-template-kpivisual-visualid

KPIVisualStandardLayoutProperty

class CfnTemplatePropsMixin.KPIVisualStandardLayoutProperty(*, type=None)

Bases: object

The standard layout of the KPI visual.

Parameters:

type (Optional[str]) – The standard layout type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-kpivisualstandardlayout.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

k_pIVisual_standard_layout_property = quicksight_mixins.CfnTemplatePropsMixin.KPIVisualStandardLayoutProperty(
    type="type"
)

Attributes

type

The standard layout type.

See:

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

LabelOptionsProperty

class CfnTemplatePropsMixin.LabelOptionsProperty(*, custom_label=None, font_configuration=None, visibility=None)

Bases: object

The share label options for the labels.

Parameters:

  • custom_label (Optional[str]) – The text for the label.

  • font_configuration (Union[IResolvable, FontConfigurationProperty, Dict[str, Any], None]) – The font configuration of the label.

  • visibility (Optional[str]) – Determines whether or not the label is visible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-labeloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

label_options_property = quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
    custom_label="customLabel",
    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    ),
    visibility="visibility"
)

Attributes

custom_label

The text for the label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-labeloptions.html#cfn-quicksight-template-labeloptions-customlabel

font_configuration

The font configuration of the label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-labeloptions.html#cfn-quicksight-template-labeloptions-fontconfiguration

visibility

Determines whether or not the label is visible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-labeloptions.html#cfn-quicksight-template-labeloptions-visibility

LayoutConfigurationProperty

class CfnTemplatePropsMixin.LayoutConfigurationProperty(*, free_form_layout=None, grid_layout=None, section_based_layout=None)

Bases: object

The configuration that determines what the type of layout will be used on a sheet.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • free_form_layout (Union[IResolvable, FreeFormLayoutConfigurationProperty, Dict[str, Any], None]) – A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

  • grid_layout (Union[IResolvable, GridLayoutConfigurationProperty, Dict[str, Any], None]) – A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE .

  • section_based_layout (Union[IResolvable, SectionBasedLayoutConfigurationProperty, Dict[str, Any], None]) – A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.LayoutConfigurationProperty(
    free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutConfigurationProperty(
        canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutCanvasSizeOptionsProperty(
            screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutScreenCanvasSizeOptionsProperty(
                optimized_view_port_width="optimizedViewPortWidth"
            )
        ),
        elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
            background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                color="color",
                visibility="visibility"
            ),
            border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                color="color",
                visibility="visibility"
            ),
            element_id="elementId",
            element_type="elementType",
            height="height",
            loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                visibility="visibility"
            ),
            rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                    visibility="visibility"
                ),
                expression="expression"
            )],
            selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                color="color",
                visibility="visibility"
            ),
            visibility="visibility",
            width="width",
            x_axis_location="xAxisLocation",
            y_axis_location="yAxisLocation"
        )]
    ),
    grid_layout=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutConfigurationProperty(
        canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(
            screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
                optimized_view_port_width="optimizedViewPortWidth",
                resize_option="resizeOption"
            )
        ),
        elements=[quicksight_mixins.CfnTemplatePropsMixin.GridLayoutElementProperty(
            column_index=123,
            column_span=123,
            element_id="elementId",
            element_type="elementType",
            row_index=123,
            row_span=123
        )]
    ),
    section_based_layout=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutConfigurationProperty(
        body_sections=[quicksight_mixins.CfnTemplatePropsMixin.BodySectionConfigurationProperty(
            content=quicksight_mixins.CfnTemplatePropsMixin.BodySectionContentProperty(
                layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
                    free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
                        elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                            background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            element_id="elementId",
                            element_type="elementType",
                            height="height",
                            loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                                visibility="visibility"
                            ),
                            rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                                configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                                    visibility="visibility"
                                ),
                                expression="expression"
                            )],
                            selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            visibility="visibility",
                            width="width",
                            x_axis_location="xAxisLocation",
                            y_axis_location="yAxisLocation"
                        )]
                    )
                )
            ),
            page_break_configuration=quicksight_mixins.CfnTemplatePropsMixin.SectionPageBreakConfigurationProperty(
                after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
                    status="status"
                )
            ),
            repeat_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatConfigurationProperty(
                dimension_configurations=[quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatDimensionConfigurationProperty(
                    dynamic_category_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicCategoryDimensionConfigurationProperty(
                        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                            column_name="columnName",
                            data_set_identifier="dataSetIdentifier"
                        ),
                        limit=123,
                        sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                                    simple_attribute_aggregation="simpleAttributeAggregation",
                                    value_for_multiple_values="valueForMultipleValues"
                                ),
                                categorical_aggregation_function="categoricalAggregationFunction",
                                date_aggregation_function="dateAggregationFunction",
                                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                                        percentile_value=123
                                    ),
                                    simple_numerical_aggregation="simpleNumericalAggregation"
                                )
                            ),
                            direction="direction",
                            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                                column_name="columnName",
                                data_set_identifier="dataSetIdentifier"
                            )
                        )]
                    ),
                    dynamic_numeric_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicNumericDimensionConfigurationProperty(
                        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                            column_name="columnName",
                            data_set_identifier="dataSetIdentifier"
                        ),
                        limit=123,
                        sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                                    simple_attribute_aggregation="simpleAttributeAggregation",
                                    value_for_multiple_values="valueForMultipleValues"
                                ),
                                categorical_aggregation_function="categoricalAggregationFunction",
                                date_aggregation_function="dateAggregationFunction",
                                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                                        percentile_value=123
                                    ),
                                    simple_numerical_aggregation="simpleNumericalAggregation"
                                )
                            ),
                            direction="direction",
                            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                                column_name="columnName",
                                data_set_identifier="dataSetIdentifier"
                            )
                        )]
                    )
                )],
                non_repeating_visuals=["nonRepeatingVisuals"],
                page_break_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatPageBreakConfigurationProperty(
                    after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
                        status="status"
                    )
                )
            ),
            section_id="sectionId",
            style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
                height="height",
                padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                    bottom="bottom",
                    left="left",
                    right="right",
                    top="top"
                )
            )
        )],
        canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutCanvasSizeOptionsProperty(
            paper_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
                paper_margin=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                    bottom="bottom",
                    left="left",
                    right="right",
                    top="top"
                ),
                paper_orientation="paperOrientation",
                paper_size="paperSize"
            )
        ),
        footer_sections=[quicksight_mixins.CfnTemplatePropsMixin.HeaderFooterSectionConfigurationProperty(
            layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
                free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
                    elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                        background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        element_id="elementId",
                        element_type="elementType",
                        height="height",
                        loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                            visibility="visibility"
                        ),
                        rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                            configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                                visibility="visibility"
                            ),
                            expression="expression"
                        )],
                        selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        visibility="visibility",
                        width="width",
                        x_axis_location="xAxisLocation",
                        y_axis_location="yAxisLocation"
                    )]
                )
            ),
            section_id="sectionId",
            style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
                height="height",
                padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                    bottom="bottom",
                    left="left",
                    right="right",
                    top="top"
                )
            )
        )],
        header_sections=[quicksight_mixins.CfnTemplatePropsMixin.HeaderFooterSectionConfigurationProperty(
            layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
                free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
                    elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                        background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        element_id="elementId",
                        element_type="elementType",
                        height="height",
                        loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                            visibility="visibility"
                        ),
                        rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                            configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                                visibility="visibility"
                            ),
                            expression="expression"
                        )],
                        selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        visibility="visibility",
                        width="width",
                        x_axis_location="xAxisLocation",
                        y_axis_location="yAxisLocation"
                    )]
                )
            ),
            section_id="sectionId",
            style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
                height="height",
                padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                    bottom="bottom",
                    left="left",
                    right="right",
                    top="top"
                )
            )
        )]
    )
)

Attributes

free_form_layout

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layoutconfiguration.html#cfn-quicksight-template-layoutconfiguration-freeformlayout

grid_layout

A type of layout that can be used on a sheet.

In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layoutconfiguration.html#cfn-quicksight-template-layoutconfiguration-gridlayout

section_based_layout

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layoutconfiguration.html#cfn-quicksight-template-layoutconfiguration-sectionbasedlayout

LayoutProperty

class CfnTemplatePropsMixin.LayoutProperty(*, configuration=None)

Bases: object

A Layout defines the placement of elements within a sheet.

For more information, see Types of layout in the Amazon Quick Suite User Guide .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

configuration (Union[IResolvable, LayoutConfigurationProperty, Dict[str, Any], None]) – The configuration that determines what the type of layout for a sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-layout.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

layout_property = quicksight_mixins.CfnTemplatePropsMixin.LayoutProperty(
    configuration=quicksight_mixins.CfnTemplatePropsMixin.LayoutConfigurationProperty(
        free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutConfigurationProperty(
            canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutCanvasSizeOptionsProperty(
                screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutScreenCanvasSizeOptionsProperty(
                    optimized_view_port_width="optimizedViewPortWidth"
                )
            ),
            elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                element_id="elementId",
                element_type="elementType",
                height="height",
                loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                    visibility="visibility"
                ),
                rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                    configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                        visibility="visibility"
                    ),
                    expression="expression"
                )],
                selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                visibility="visibility",
                width="width",
                x_axis_location="xAxisLocation",
                y_axis_location="yAxisLocation"
            )]
        ),
        grid_layout=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutConfigurationProperty(
            canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(
                screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
                    optimized_view_port_width="optimizedViewPortWidth",
                    resize_option="resizeOption"
                )
            ),
            elements=[quicksight_mixins.CfnTemplatePropsMixin.GridLayoutElementProperty(
                column_index=123,
                column_span=123,
                element_id="elementId",
                element_type="elementType",
                row_index=123,
                row_span=123
            )]
        ),
        section_based_layout=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutConfigurationProperty(
            body_sections=[quicksight_mixins.CfnTemplatePropsMixin.BodySectionConfigurationProperty(
                content=quicksight_mixins.CfnTemplatePropsMixin.BodySectionContentProperty(
                    layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
                        free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
                            elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                                background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                                    color="color",
                                    visibility="visibility"
                                ),
                                border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                                    color="color",
                                    visibility="visibility"
                                ),
                                element_id="elementId",
                                element_type="elementType",
                                height="height",
                                loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                                    visibility="visibility"
                                ),
                                rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                                    configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                                        visibility="visibility"
                                    ),
                                    expression="expression"
                                )],
                                selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                                    color="color",
                                    visibility="visibility"
                                ),
                                visibility="visibility",
                                width="width",
                                x_axis_location="xAxisLocation",
                                y_axis_location="yAxisLocation"
                            )]
                        )
                    )
                ),
                page_break_configuration=quicksight_mixins.CfnTemplatePropsMixin.SectionPageBreakConfigurationProperty(
                    after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
                        status="status"
                    )
                ),
                repeat_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatConfigurationProperty(
                    dimension_configurations=[quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatDimensionConfigurationProperty(
                        dynamic_category_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicCategoryDimensionConfigurationProperty(
                            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                                column_name="columnName",
                                data_set_identifier="dataSetIdentifier"
                            ),
                            limit=123,
                            sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                                aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                                    attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                                        simple_attribute_aggregation="simpleAttributeAggregation",
                                        value_for_multiple_values="valueForMultipleValues"
                                    ),
                                    categorical_aggregation_function="categoricalAggregationFunction",
                                    date_aggregation_function="dateAggregationFunction",
                                    numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                                        percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                                            percentile_value=123
                                        ),
                                        simple_numerical_aggregation="simpleNumericalAggregation"
                                    )
                                ),
                                direction="direction",
                                sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                                    column_name="columnName",
                                    data_set_identifier="dataSetIdentifier"
                                )
                            )]
                        ),
                        dynamic_numeric_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicNumericDimensionConfigurationProperty(
                            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                                column_name="columnName",
                                data_set_identifier="dataSetIdentifier"
                            ),
                            limit=123,
                            sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                                aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                                    attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                                        simple_attribute_aggregation="simpleAttributeAggregation",
                                        value_for_multiple_values="valueForMultipleValues"
                                    ),
                                    categorical_aggregation_function="categoricalAggregationFunction",
                                    date_aggregation_function="dateAggregationFunction",
                                    numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                                        percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                                            percentile_value=123
                                        ),
                                        simple_numerical_aggregation="simpleNumericalAggregation"
                                    )
                                ),
                                direction="direction",
                                sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                                    column_name="columnName",
                                    data_set_identifier="dataSetIdentifier"
                                )
                            )]
                        )
                    )],
                    non_repeating_visuals=["nonRepeatingVisuals"],
                    page_break_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatPageBreakConfigurationProperty(
                        after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
                            status="status"
                        )
                    )
                ),
                section_id="sectionId",
                style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
                    height="height",
                    padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                        bottom="bottom",
                        left="left",
                        right="right",
                        top="top"
                    )
                )
            )],
            canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutCanvasSizeOptionsProperty(
                paper_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
                    paper_margin=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                        bottom="bottom",
                        left="left",
                        right="right",
                        top="top"
                    ),
                    paper_orientation="paperOrientation",
                    paper_size="paperSize"
                )
            ),
            footer_sections=[quicksight_mixins.CfnTemplatePropsMixin.HeaderFooterSectionConfigurationProperty(
                layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
                    free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
                        elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                            background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            element_id="elementId",
                            element_type="elementType",
                            height="height",
                            loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                                visibility="visibility"
                            ),
                            rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                                configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                                    visibility="visibility"
                                ),
                                expression="expression"
                            )],
                            selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            visibility="visibility",
                            width="width",
                            x_axis_location="xAxisLocation",
                            y_axis_location="yAxisLocation"
                        )]
                    )
                ),
                section_id="sectionId",
                style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
                    height="height",
                    padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                        bottom="bottom",
                        left="left",
                        right="right",
                        top="top"
                    )
                )
            )],
            header_sections=[quicksight_mixins.CfnTemplatePropsMixin.HeaderFooterSectionConfigurationProperty(
                layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
                    free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
                        elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                            background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            element_id="elementId",
                            element_type="elementType",
                            height="height",
                            loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                                visibility="visibility"
                            ),
                            rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                                configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                                    visibility="visibility"
                                ),
                                expression="expression"
                            )],
                            selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            visibility="visibility",
                            width="width",
                            x_axis_location="xAxisLocation",
                            y_axis_location="yAxisLocation"
                        )]
                    )
                ),
                section_id="sectionId",
                style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
                    height="height",
                    padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                        bottom="bottom",
                        left="left",
                        right="right",
                        top="top"
                    )
                )
            )]
        )
    )
)

Attributes

configuration

The configuration that determines what the type of layout for a sheet.

See:

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

LegendOptionsProperty

class CfnTemplatePropsMixin.LegendOptionsProperty(*, height=None, position=None, title=None, value_font_configuration=None, visibility=None, width=None)

Bases: object

The options for the legend setup of a visual.

Parameters:

  • height (Optional[str]) – The height of the legend. If this value is omitted, a default height is used when rendering.

  • position (Optional[str]) – The positions for the legend. Choose one of the following options:. - AUTO - RIGHT - BOTTOM - LEFT

  • title (Union[IResolvable, LabelOptionsProperty, Dict[str, Any], None]) – The custom title for the legend.

  • value_font_configuration (Union[IResolvable, FontConfigurationProperty, Dict[str, Any], None])

  • visibility (Optional[str]) – Determines whether or not the legend is visible.

  • width (Optional[str]) – The width of the legend. If this value is omitted, a default width is used when rendering.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

legend_options_property = quicksight_mixins.CfnTemplatePropsMixin.LegendOptionsProperty(
    height="height",
    position="position",
    title=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        visibility="visibility"
    ),
    value_font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    ),
    visibility="visibility",
    width="width"
)

Attributes

height

The height of the legend.

If this value is omitted, a default height is used when rendering.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-height

position

.

  • AUTO

  • RIGHT

  • BOTTOM

  • LEFT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-position

Type:

The positions for the legend. Choose one of the following options

title

The custom title for the legend.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-title

value_font_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-valuefontconfiguration

Type:

see

visibility

Determines whether or not the legend is visible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-visibility

width

The width of the legend.

If this value is omitted, a default width is used when rendering.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-legendoptions.html#cfn-quicksight-template-legendoptions-width

LineChartAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.LineChartAggregatedFieldWellsProperty(*, category=None, colors=None, small_multiples=None, values=None)

Bases: object

The field well configuration of a line chart.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category

The category field wells of a line chart.

Values are grouped by category fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartaggregatedfieldwells.html#cfn-quicksight-template-linechartaggregatedfieldwells-category

colors

The color field wells of a line chart.

Values are grouped by category fields.

See:

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

small_multiples

The small multiples field well of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartaggregatedfieldwells.html#cfn-quicksight-template-linechartaggregatedfieldwells-smallmultiples

values

The value field wells of a line chart.

Values are aggregated based on categories.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartaggregatedfieldwells.html#cfn-quicksight-template-linechartaggregatedfieldwells-values

LineChartConfigurationProperty

class CfnTemplatePropsMixin.LineChartConfigurationProperty(*, contribution_analysis_defaults=None, data_labels=None, default_series_settings=None, field_wells=None, forecast_configurations=None, interactions=None, legend=None, primary_y_axis_display_options=None, primary_y_axis_label_options=None, reference_lines=None, secondary_y_axis_display_options=None, secondary_y_axis_label_options=None, series=None, single_axis_options=None, small_multiples_options=None, sort_configuration=None, tooltip=None, type=None, visual_palette=None, x_axis_display_options=None, x_axis_label_options=None)

Bases: object

The configuration of a line chart.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
contribution_analysis_defaults

The default configuration of a line chart’s contribution analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-contributionanalysisdefaults

data_labels

The data label configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-datalabels

default_series_settings

The options that determine the default presentation of all line series in LineChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-defaultseriessettings

field_wells

The field well configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-fieldwells

forecast_configurations

The forecast configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-forecastconfigurations

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-interactions

legend

The legend configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-legend

primary_y_axis_display_options

The series axis configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-primaryyaxisdisplayoptions

primary_y_axis_label_options

The options that determine the presentation of the y-axis label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-primaryyaxislabeloptions

reference_lines

The reference lines configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-referencelines

secondary_y_axis_display_options

The series axis configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-secondaryyaxisdisplayoptions

secondary_y_axis_label_options

The options that determine the presentation of the secondary y-axis label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-secondaryyaxislabeloptions

series

The series item configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-series

single_axis_options

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-singleaxisoptions

Type:

see

small_multiples_options

The small multiples setup for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-smallmultiplesoptions

sort_configuration

The sort configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-sortconfiguration

tooltip

The tooltip configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-tooltip

type

Determines the type of the line chart.

See:

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

visual_palette

The visual palette configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-visualpalette

x_axis_display_options

The options that determine the presentation of the x-axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-xaxisdisplayoptions

x_axis_label_options

The options that determine the presentation of the x-axis label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartconfiguration.html#cfn-quicksight-template-linechartconfiguration-xaxislabeloptions

LineChartDefaultSeriesSettingsProperty

class CfnTemplatePropsMixin.LineChartDefaultSeriesSettingsProperty(*, axis_binding=None, line_style_settings=None, marker_style_settings=None)

Bases: object

The options that determine the default presentation of all line series in LineChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartdefaultseriessettings.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

line_chart_default_series_settings_property = quicksight_mixins.CfnTemplatePropsMixin.LineChartDefaultSeriesSettingsProperty(
    axis_binding="axisBinding",
    line_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartLineStyleSettingsProperty(
        line_interpolation="lineInterpolation",
        line_style="lineStyle",
        line_visibility="lineVisibility",
        line_width="lineWidth"
    ),
    marker_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartMarkerStyleSettingsProperty(
        marker_color="markerColor",
        marker_shape="markerShape",
        marker_size="markerSize",
        marker_visibility="markerVisibility"
    )
)

Attributes

axis_binding

The axis to which you are binding all line series to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartdefaultseriessettings.html#cfn-quicksight-template-linechartdefaultseriessettings-axisbinding

line_style_settings

Line styles options for all line series in the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartdefaultseriessettings.html#cfn-quicksight-template-linechartdefaultseriessettings-linestylesettings

marker_style_settings

Marker styles options for all line series in the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartdefaultseriessettings.html#cfn-quicksight-template-linechartdefaultseriessettings-markerstylesettings

LineChartFieldWellsProperty

class CfnTemplatePropsMixin.LineChartFieldWellsProperty(*, line_chart_aggregated_field_wells=None)

Bases: object

The field well configuration of a line chart.

Parameters:

line_chart_aggregated_field_wells (Union[IResolvable, LineChartAggregatedFieldWellsProperty, Dict[str, Any], None]) – The field well configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
line_chart_aggregated_field_wells

The field well configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartfieldwells.html#cfn-quicksight-template-linechartfieldwells-linechartaggregatedfieldwells

LineChartLineStyleSettingsProperty

class CfnTemplatePropsMixin.LineChartLineStyleSettingsProperty(*, line_interpolation=None, line_style=None, line_visibility=None, line_width=None)

Bases: object

Line styles options for a line series in LineChartVisual .

Parameters:

  • line_interpolation (Optional[str]) – Interpolation style for line series. - LINEAR : Show as default, linear style. - SMOOTH : Show as a smooth curve. - STEPPED : Show steps in line.

  • line_style (Optional[str]) – Line style for line series. - SOLID : Show as a solid line. - DOTTED : Show as a dotted line. - DASHED : Show as a dashed line.

  • line_visibility (Optional[str]) – Configuration option that determines whether to show the line for the series.

  • line_width (Optional[str]) – Width that determines the line thickness.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartlinestylesettings.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

line_chart_line_style_settings_property = quicksight_mixins.CfnTemplatePropsMixin.LineChartLineStyleSettingsProperty(
    line_interpolation="lineInterpolation",
    line_style="lineStyle",
    line_visibility="lineVisibility",
    line_width="lineWidth"
)

Attributes

line_interpolation

Interpolation style for line series.

  • LINEAR : Show as default, linear style.

  • SMOOTH : Show as a smooth curve.

  • STEPPED : Show steps in line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartlinestylesettings.html#cfn-quicksight-template-linechartlinestylesettings-lineinterpolation

line_style

Line style for line series.

  • SOLID : Show as a solid line.

  • DOTTED : Show as a dotted line.

  • DASHED : Show as a dashed line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartlinestylesettings.html#cfn-quicksight-template-linechartlinestylesettings-linestyle

line_visibility

Configuration option that determines whether to show the line for the series.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartlinestylesettings.html#cfn-quicksight-template-linechartlinestylesettings-linevisibility

line_width

Width that determines the line thickness.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartlinestylesettings.html#cfn-quicksight-template-linechartlinestylesettings-linewidth

LineChartMarkerStyleSettingsProperty

class CfnTemplatePropsMixin.LineChartMarkerStyleSettingsProperty(*, marker_color=None, marker_shape=None, marker_size=None, marker_visibility=None)

Bases: object

Marker styles options for a line series in LineChartVisual .

Parameters:

  • marker_color (Optional[str]) – Color of marker in the series.

  • marker_shape (Optional[str]) – Shape option for markers in the series. - CIRCLE : Show marker as a circle. - TRIANGLE : Show marker as a triangle. - SQUARE : Show marker as a square. - DIAMOND : Show marker as a diamond. - ROUNDED_SQUARE : Show marker as a rounded square.

  • marker_size (Optional[str]) – Size of marker in the series.

  • marker_visibility (Optional[str]) – Configuration option that determines whether to show the markers in the series.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartmarkerstylesettings.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

line_chart_marker_style_settings_property = quicksight_mixins.CfnTemplatePropsMixin.LineChartMarkerStyleSettingsProperty(
    marker_color="markerColor",
    marker_shape="markerShape",
    marker_size="markerSize",
    marker_visibility="markerVisibility"
)

Attributes

marker_color

Color of marker in the series.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartmarkerstylesettings.html#cfn-quicksight-template-linechartmarkerstylesettings-markercolor

marker_shape

Shape option for markers in the series.

  • CIRCLE : Show marker as a circle.

  • TRIANGLE : Show marker as a triangle.

  • SQUARE : Show marker as a square.

  • DIAMOND : Show marker as a diamond.

  • ROUNDED_SQUARE : Show marker as a rounded square.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartmarkerstylesettings.html#cfn-quicksight-template-linechartmarkerstylesettings-markershape

marker_size

Size of marker in the series.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartmarkerstylesettings.html#cfn-quicksight-template-linechartmarkerstylesettings-markersize

marker_visibility

Configuration option that determines whether to show the markers in the series.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartmarkerstylesettings.html#cfn-quicksight-template-linechartmarkerstylesettings-markervisibility

LineChartSeriesSettingsProperty

class CfnTemplatePropsMixin.LineChartSeriesSettingsProperty(*, line_style_settings=None, marker_style_settings=None)

Bases: object

The options that determine the presentation of a line series in the visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartseriessettings.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

line_chart_series_settings_property = quicksight_mixins.CfnTemplatePropsMixin.LineChartSeriesSettingsProperty(
    line_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartLineStyleSettingsProperty(
        line_interpolation="lineInterpolation",
        line_style="lineStyle",
        line_visibility="lineVisibility",
        line_width="lineWidth"
    ),
    marker_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartMarkerStyleSettingsProperty(
        marker_color="markerColor",
        marker_shape="markerShape",
        marker_size="markerSize",
        marker_visibility="markerVisibility"
    )
)

Attributes

line_style_settings

Line styles options for a line series in LineChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartseriessettings.html#cfn-quicksight-template-linechartseriessettings-linestylesettings

marker_style_settings

Marker styles options for a line series in LineChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartseriessettings.html#cfn-quicksight-template-linechartseriessettings-markerstylesettings

LineChartSortConfigurationProperty

class CfnTemplatePropsMixin.LineChartSortConfigurationProperty(*, category_items_limit_configuration=None, category_sort=None, color_items_limit_configuration=None, small_multiples_limit_configuration=None, small_multiples_sort=None)

Bases: object

The sort configuration of a line chart.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

line_chart_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.LineChartSortConfigurationProperty(
    category_items_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    color_items_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    small_multiples_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    small_multiples_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

category_items_limit_configuration

The limit on the number of categories that are displayed in a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html#cfn-quicksight-template-linechartsortconfiguration-categoryitemslimitconfiguration

category_sort

The sort configuration of the category fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html#cfn-quicksight-template-linechartsortconfiguration-categorysort

color_items_limit_configuration

The limit on the number of lines that are displayed in a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html#cfn-quicksight-template-linechartsortconfiguration-coloritemslimitconfiguration

small_multiples_limit_configuration

The limit on the number of small multiples panels that are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html#cfn-quicksight-template-linechartsortconfiguration-smallmultipleslimitconfiguration

small_multiples_sort

The sort configuration of the small multiples field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartsortconfiguration.html#cfn-quicksight-template-linechartsortconfiguration-smallmultiplessort

LineChartVisualProperty

class CfnTemplatePropsMixin.LineChartVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A line chart.

For more information, see Using line charts in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-linechartvisual.html#cfn-quicksight-template-linechartvisual-visualid

LineSeriesAxisDisplayOptionsProperty

class CfnTemplatePropsMixin.LineSeriesAxisDisplayOptionsProperty(*, axis_options=None, missing_data_configurations=None)

Bases: object

The series axis configuration of a line chart.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-lineseriesaxisdisplayoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# data_driven: Any

line_series_axis_display_options_property = quicksight_mixins.CfnTemplatePropsMixin.LineSeriesAxisDisplayOptionsProperty(
    axis_options=quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayOptionsProperty(
        axis_line_visibility="axisLineVisibility",
        axis_offset="axisOffset",
        data_options=quicksight_mixins.CfnTemplatePropsMixin.AxisDataOptionsProperty(
            date_axis_options=quicksight_mixins.CfnTemplatePropsMixin.DateAxisOptionsProperty(
                missing_date_visibility="missingDateVisibility"
            ),
            numeric_axis_options=quicksight_mixins.CfnTemplatePropsMixin.NumericAxisOptionsProperty(
                range=quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayRangeProperty(
                    data_driven=data_driven,
                    min_max=quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayMinMaxRangeProperty(
                        maximum=123,
                        minimum=123
                    )
                ),
                scale=quicksight_mixins.CfnTemplatePropsMixin.AxisScaleProperty(
                    linear=quicksight_mixins.CfnTemplatePropsMixin.AxisLinearScaleProperty(
                        step_count=123,
                        step_size=123
                    ),
                    logarithmic=quicksight_mixins.CfnTemplatePropsMixin.AxisLogarithmicScaleProperty(
                        base=123
                    )
                )
            )
        ),
        grid_line_visibility="gridLineVisibility",
        scrollbar_options=quicksight_mixins.CfnTemplatePropsMixin.ScrollBarOptionsProperty(
            visibility="visibility",
            visible_range=quicksight_mixins.CfnTemplatePropsMixin.VisibleRangeOptionsProperty(
                percent_range=quicksight_mixins.CfnTemplatePropsMixin.PercentVisibleRangeProperty(
                    from=123,
                    to=123
                )
            )
        ),
        tick_label_options=quicksight_mixins.CfnTemplatePropsMixin.AxisTickLabelOptionsProperty(
            label_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            ),
            rotation_angle=123
        )
    ),
    missing_data_configurations=[quicksight_mixins.CfnTemplatePropsMixin.MissingDataConfigurationProperty(
        treatment_option="treatmentOption"
    )]
)

Attributes

axis_options

The options that determine the presentation of the line series axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-lineseriesaxisdisplayoptions.html#cfn-quicksight-template-lineseriesaxisdisplayoptions-axisoptions

missing_data_configurations

The configuration options that determine how missing data is treated during the rendering of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-lineseriesaxisdisplayoptions.html#cfn-quicksight-template-lineseriesaxisdisplayoptions-missingdataconfigurations

ListControlDisplayOptionsProperty

class CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(*, info_icon_label_options=None, search_options=None, select_all_options=None, title_options=None)

Bases: object

The display options of a control.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontroldisplayoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

list_control_display_options_property = quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
        visibility="visibility"
    ),
    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
        visibility="visibility"
    ),
    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        visibility="visibility"
    )
)

Attributes

info_icon_label_options

The configuration of info icon label options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontroldisplayoptions.html#cfn-quicksight-template-listcontroldisplayoptions-infoiconlabeloptions

search_options

The configuration of the search options in a list control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontroldisplayoptions.html#cfn-quicksight-template-listcontroldisplayoptions-searchoptions

select_all_options

The configuration of the Select all options in a list control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontroldisplayoptions.html#cfn-quicksight-template-listcontroldisplayoptions-selectalloptions

title_options

The options to configure the title visibility, name, and font size.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontroldisplayoptions.html#cfn-quicksight-template-listcontroldisplayoptions-titleoptions

ListControlSearchOptionsProperty

class CfnTemplatePropsMixin.ListControlSearchOptionsProperty(*, visibility=None)

Bases: object

The configuration of the search options in a list control.

Parameters:

visibility (Optional[str]) – The visibility configuration of the search options in a list control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontrolsearchoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

list_control_search_options_property = quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility configuration of the search options in a list control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontrolsearchoptions.html#cfn-quicksight-template-listcontrolsearchoptions-visibility

ListControlSelectAllOptionsProperty

class CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(*, visibility=None)

Bases: object

The configuration of the Select all options in a list control.

Parameters:

visibility (Optional[str]) – The visibility configuration of the Select all options in a list control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontrolselectalloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

list_control_select_all_options_property = quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility configuration of the Select all options in a list control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-listcontrolselectalloptions.html#cfn-quicksight-template-listcontrolselectalloptions-visibility

LoadingAnimationProperty

class CfnTemplatePropsMixin.LoadingAnimationProperty(*, visibility=None)

Bases: object

The configuration of loading animation in free-form layout.

Parameters:

visibility (Optional[str]) – The visibility configuration of LoadingAnimation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-loadinganimation.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

loading_animation_property = quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility configuration of LoadingAnimation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-loadinganimation.html#cfn-quicksight-template-loadinganimation-visibility

LocalNavigationConfigurationProperty

class CfnTemplatePropsMixin.LocalNavigationConfigurationProperty(*, target_sheet_id=None)

Bases: object

The navigation configuration for CustomActionNavigationOperation .

Parameters:

target_sheet_id (Optional[str]) – The sheet that is targeted for navigation in the same analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-localnavigationconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

local_navigation_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.LocalNavigationConfigurationProperty(
    target_sheet_id="targetSheetId"
)

Attributes

target_sheet_id

The sheet that is targeted for navigation in the same analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-localnavigationconfiguration.html#cfn-quicksight-template-localnavigationconfiguration-targetsheetid

LongFormatTextProperty

class CfnTemplatePropsMixin.LongFormatTextProperty(*, plain_text=None, rich_text=None)

Bases: object

The text format for a subtitle.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • plain_text (Optional[str]) – Plain text format.

  • rich_text (Optional[str]) – Rich text. Examples of rich text include bold, underline, and italics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-longformattext.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

long_format_text_property = quicksight_mixins.CfnTemplatePropsMixin.LongFormatTextProperty(
    plain_text="plainText",
    rich_text="richText"
)

Attributes

plain_text

Plain text format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-longformattext.html#cfn-quicksight-template-longformattext-plaintext

rich_text

Rich text.

Examples of rich text include bold, underline, and italics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-longformattext.html#cfn-quicksight-template-longformattext-richtext

MappedDataSetParameterProperty

class CfnTemplatePropsMixin.MappedDataSetParameterProperty(*, data_set_identifier=None, data_set_parameter_name=None)

Bases: object

A dataset parameter that is mapped to an analysis parameter.

Parameters:

  • data_set_identifier (Optional[str]) – A unique name that identifies a dataset within the analysis or dashboard.

  • data_set_parameter_name (Optional[str]) – The name of the dataset parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-mappeddatasetparameter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

mapped_data_set_parameter_property = quicksight_mixins.CfnTemplatePropsMixin.MappedDataSetParameterProperty(
    data_set_identifier="dataSetIdentifier",
    data_set_parameter_name="dataSetParameterName"
)

Attributes

data_set_identifier

A unique name that identifies a dataset within the analysis or dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-mappeddatasetparameter.html#cfn-quicksight-template-mappeddatasetparameter-datasetidentifier

data_set_parameter_name

The name of the dataset parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-mappeddatasetparameter.html#cfn-quicksight-template-mappeddatasetparameter-datasetparametername

MaximumLabelTypeProperty

class CfnTemplatePropsMixin.MaximumLabelTypeProperty(*, visibility=None)

Bases: object

The maximum label of a data path label.

Parameters:

visibility (Optional[str]) – The visibility of the maximum label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumlabeltype.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

maximum_label_type_property = quicksight_mixins.CfnTemplatePropsMixin.MaximumLabelTypeProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility of the maximum label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumlabeltype.html#cfn-quicksight-template-maximumlabeltype-visibility

MaximumMinimumComputationProperty

class CfnTemplatePropsMixin.MaximumMinimumComputationProperty(*, computation_id=None, name=None, time=None, type=None, value=None)

Bases: object

The maximum and minimum computation configuration.

Parameters:

  • computation_id (Optional[str]) – The ID for a computation.

  • name (Optional[str]) – The name of a computation.

  • time (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The time field that is used in a computation.

  • type (Optional[str]) – The type of computation. Choose one of the following options:. - MAXIMUM: A maximum computation. - MINIMUM: A minimum computation.

  • value (Union[IResolvable, MeasureFieldProperty, Dict[str, Any], None]) – The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html#cfn-quicksight-template-maximumminimumcomputation-computationid

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html#cfn-quicksight-template-maximumminimumcomputation-name

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html#cfn-quicksight-template-maximumminimumcomputation-time

type

.

  • MAXIMUM: A maximum computation.

  • MINIMUM: A minimum computation.

See:

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

Type:

The type of computation. Choose one of the following options

value

The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-maximumminimumcomputation.html#cfn-quicksight-template-maximumminimumcomputation-value

MeasureFieldProperty

class CfnTemplatePropsMixin.MeasureFieldProperty(*, calculated_measure_field=None, categorical_measure_field=None, date_measure_field=None, numerical_measure_field=None)

Bases: object

The measure (metric) type field.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-measurefield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

measure_field_property = quicksight_mixins.CfnTemplatePropsMixin.MeasureFieldProperty(
    calculated_measure_field=quicksight_mixins.CfnTemplatePropsMixin.CalculatedMeasureFieldProperty(
        expression="expression",
        field_id="fieldId"
    ),
    categorical_measure_field=quicksight_mixins.CfnTemplatePropsMixin.CategoricalMeasureFieldProperty(
        aggregation_function="aggregationFunction",
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        )
    ),
    date_measure_field=quicksight_mixins.CfnTemplatePropsMixin.DateMeasureFieldProperty(
        aggregation_function="aggregationFunction",
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
            date_time_format="dateTimeFormat",
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        )
    ),
    numerical_measure_field=quicksight_mixins.CfnTemplatePropsMixin.NumericalMeasureFieldProperty(
        aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        ),
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        )
    )
)

Attributes

calculated_measure_field

The calculated measure field only used in pivot tables.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-measurefield.html#cfn-quicksight-template-measurefield-calculatedmeasurefield

categorical_measure_field

The measure type field with categorical type columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-measurefield.html#cfn-quicksight-template-measurefield-categoricalmeasurefield

date_measure_field

The measure type field with date type columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-measurefield.html#cfn-quicksight-template-measurefield-datemeasurefield

numerical_measure_field

The measure type field with numerical type columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-measurefield.html#cfn-quicksight-template-measurefield-numericalmeasurefield

MetricComparisonComputationProperty

class CfnTemplatePropsMixin.MetricComparisonComputationProperty(*, computation_id=None, from_value=None, name=None, target_value=None, time=None)

Bases: object

The metric comparison computation configuration.

Parameters:

  • computation_id (Optional[str]) – The ID for a computation.

  • from_value (Union[IResolvable, MeasureFieldProperty, Dict[str, Any], None]) – The field that is used in a metric comparison from value setup.

  • name (Optional[str]) – The name of a computation.

  • target_value (Union[IResolvable, MeasureFieldProperty, Dict[str, Any], None]) – The field that is used in a metric comparison to value setup.

  • time (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html#cfn-quicksight-template-metriccomparisoncomputation-computationid

from_value

The field that is used in a metric comparison from value setup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html#cfn-quicksight-template-metriccomparisoncomputation-fromvalue

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html#cfn-quicksight-template-metriccomparisoncomputation-name

target_value

The field that is used in a metric comparison to value setup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html#cfn-quicksight-template-metriccomparisoncomputation-targetvalue

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-metriccomparisoncomputation.html#cfn-quicksight-template-metriccomparisoncomputation-time

MinimumLabelTypeProperty

class CfnTemplatePropsMixin.MinimumLabelTypeProperty(*, visibility=None)

Bases: object

The minimum label of a data path label.

Parameters:

visibility (Optional[str]) – The visibility of the minimum label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-minimumlabeltype.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

minimum_label_type_property = quicksight_mixins.CfnTemplatePropsMixin.MinimumLabelTypeProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility of the minimum label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-minimumlabeltype.html#cfn-quicksight-template-minimumlabeltype-visibility

MissingDataConfigurationProperty

class CfnTemplatePropsMixin.MissingDataConfigurationProperty(*, treatment_option=None)

Bases: object

The configuration options that determine how missing data is treated during the rendering of a line chart.

Parameters:

treatment_option (Optional[str]) – The treatment option that determines how missing data should be rendered. Choose from the following options:. - INTERPOLATE : Interpolate missing values between the prior and the next known value. - SHOW_AS_ZERO : Show missing values as the value 0 . - SHOW_AS_BLANK : Display a blank space when rendering missing data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-missingdataconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

missing_data_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.MissingDataConfigurationProperty(
    treatment_option="treatmentOption"
)

Attributes

treatment_option

.

  • INTERPOLATE : Interpolate missing values between the prior and the next known value.

  • SHOW_AS_ZERO : Show missing values as the value 0 .

  • SHOW_AS_BLANK : Display a blank space when rendering missing data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-missingdataconfiguration.html#cfn-quicksight-template-missingdataconfiguration-treatmentoption

Type:

The treatment option that determines how missing data should be rendered. Choose from the following options

NegativeValueConfigurationProperty

class CfnTemplatePropsMixin.NegativeValueConfigurationProperty(*, display_mode=None)

Bases: object

The options that determine the negative value configuration.

Parameters:

display_mode (Optional[str]) – Determines the display mode of the negative value configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-negativevalueconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

negative_value_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
    display_mode="displayMode"
)

Attributes

display_mode

Determines the display mode of the negative value configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-negativevalueconfiguration.html#cfn-quicksight-template-negativevalueconfiguration-displaymode

NestedFilterProperty

class CfnTemplatePropsMixin.NestedFilterProperty(*, column=None, filter_id=None, include_inner_set=None, inner_filter=None)

Bases: object

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

Parameters:

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the filter is applied to.

  • filter_id (Optional[str]) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • include_inner_set (Union[bool, IResolvable, None]) – A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter. Default: - false

  • inner_filter (Union[IResolvable, InnerFilterProperty, Dict[str, Any], None]) – The InnerFilter defines the subset of data to be used with the NestedFilter .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

nested_filter_property = quicksight_mixins.CfnTemplatePropsMixin.NestedFilterProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    filter_id="filterId",
    include_inner_set=False,
    inner_filter=quicksight_mixins.CfnTemplatePropsMixin.InnerFilterProperty(
        category_inner_filter=quicksight_mixins.CfnTemplatePropsMixin.CategoryInnerFilterProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            configuration=quicksight_mixins.CfnTemplatePropsMixin.CategoryFilterConfigurationProperty(
                custom_filter_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomFilterConfigurationProperty(
                    category_value="categoryValue",
                    match_operator="matchOperator",
                    null_option="nullOption",
                    parameter_name="parameterName",
                    select_all_options="selectAllOptions"
                ),
                custom_filter_list_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomFilterListConfigurationProperty(
                    category_values=["categoryValues"],
                    match_operator="matchOperator",
                    null_option="nullOption",
                    select_all_options="selectAllOptions"
                ),
                filter_list_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterListConfigurationProperty(
                    category_values=["categoryValues"],
                    match_operator="matchOperator",
                    null_option="nullOption",
                    select_all_options="selectAllOptions"
                )
            ),
            default_filter_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
                control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
                    default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
                        commit_mode="commitMode",
                        display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                            date_icon_visibility=date_icon_visibility,
                            date_time_format="dateTimeFormat",
                            helper_text_visibility=helper_text_visibility,
                            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_family="fontFamily",
                                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                        absolute="absolute",
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        ),
                        type="type"
                    ),
                    default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
                        commit_mode="commitMode",
                        display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                                visibility="visibility"
                            ),
                            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_family="fontFamily",
                                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                        absolute="absolute",
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        ),
                        selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                            values=["values"]
                        ),
                        type="type"
                    ),
                    default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
                        display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                                visibility="visibility"
                            ),
                            select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                                visibility="visibility"
                            ),
                            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_family="fontFamily",
                                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                        absolute="absolute",
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        ),
                        selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                            values=["values"]
                        ),
                        type="type"
                    ),
                    default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
                        commit_mode="commitMode",
                        display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                            date_time_format="dateTimeFormat",
                            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_family="fontFamily",
                                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                        absolute="absolute",
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        )
                    ),
                    default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
                        display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_family="fontFamily",
                                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                        absolute="absolute",
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        ),
                        maximum_value=123,
                        minimum_value=123,
                        step_size=123,
                        type="type"
                    ),
                    default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
                        delimiter="delimiter",
                        display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                                visibility="visibility"
                            ),
                            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_family="fontFamily",
                                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                        absolute="absolute",
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        )
                    ),
                    default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
                        display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                                visibility="visibility"
                            ),
                            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_family="fontFamily",
                                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                        absolute="absolute",
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        )
                    )
                ),
                title="title"
            )
        )
    )
)

Attributes

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-column

filter_id

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-filterid

include_inner_set

A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.

Default:

  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-includeinnerset

inner_filter

The InnerFilter defines the subset of data to be used with the NestedFilter .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nestedfilter.html#cfn-quicksight-template-nestedfilter-innerfilter

NullValueFormatConfigurationProperty

class CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(*, null_string=None)

Bases: object

The options that determine the null value format configuration.

Parameters:

null_string (Optional[str]) – Determines the null string of null values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nullvalueformatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

null_value_format_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
    null_string="nullString"
)

Attributes

null_string

Determines the null string of null values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-nullvalueformatconfiguration.html#cfn-quicksight-template-nullvalueformatconfiguration-nullstring

NumberDisplayFormatConfigurationProperty

class CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(*, decimal_places_configuration=None, negative_value_configuration=None, null_value_format_configuration=None, number_scale=None, prefix=None, separator_configuration=None, suffix=None)

Bases: object

The options that determine the number display format configuration.

Parameters:

  • decimal_places_configuration (Union[IResolvable, DecimalPlacesConfigurationProperty, Dict[str, Any], None]) – The option that determines the decimal places configuration.

  • negative_value_configuration (Union[IResolvable, NegativeValueConfigurationProperty, Dict[str, Any], None]) – The options that determine the negative value configuration.

  • null_value_format_configuration (Union[IResolvable, NullValueFormatConfigurationProperty, Dict[str, Any], None]) – The options that determine the null value format configuration.

  • number_scale (Optional[str]) – Determines the number scale value of the number format.

  • prefix (Optional[str]) – Determines the prefix value of the number format.

  • separator_configuration (Union[IResolvable, NumericSeparatorConfigurationProperty, Dict[str, Any], None]) – The options that determine the numeric separator configuration.

  • suffix (Optional[str]) – Determines the suffix value of the number format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

number_display_format_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
        decimal_places=123
    ),
    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
        display_mode="displayMode"
    ),
    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    number_scale="numberScale",
    prefix="prefix",
    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
        decimal_separator="decimalSeparator",
        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
            grouping_style="groupingStyle",
            symbol="symbol",
            visibility="visibility"
        )
    ),
    suffix="suffix"
)

Attributes

decimal_places_configuration

The option that determines the decimal places configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-decimalplacesconfiguration

negative_value_configuration

The options that determine the negative value configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-negativevalueconfiguration

null_value_format_configuration

The options that determine the null value format configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-nullvalueformatconfiguration

number_scale

Determines the number scale value of the number format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-numberscale

prefix

Determines the prefix value of the number format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-prefix

separator_configuration

The options that determine the numeric separator configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-separatorconfiguration

suffix

Determines the suffix value of the number format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberdisplayformatconfiguration.html#cfn-quicksight-template-numberdisplayformatconfiguration-suffix

NumberFormatConfigurationProperty

class CfnTemplatePropsMixin.NumberFormatConfigurationProperty(*, format_configuration=None)

Bases: object

Formatting configuration for number fields.

Parameters:

format_configuration (Union[IResolvable, NumericFormatConfigurationProperty, Dict[str, Any], None]) – The options that determine the numeric format configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberformatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

number_format_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
        currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix",
            symbol="symbol"
        ),
        number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        )
    )
)

Attributes

format_configuration

The options that determine the numeric format configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numberformatconfiguration.html#cfn-quicksight-template-numberformatconfiguration-formatconfiguration

NumericAxisOptionsProperty

class CfnTemplatePropsMixin.NumericAxisOptionsProperty(*, range=None, scale=None)

Bases: object

The options for an axis with a numeric field.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaxisoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# data_driven: Any

numeric_axis_options_property = quicksight_mixins.CfnTemplatePropsMixin.NumericAxisOptionsProperty(
    range=quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayRangeProperty(
        data_driven=data_driven,
        min_max=quicksight_mixins.CfnTemplatePropsMixin.AxisDisplayMinMaxRangeProperty(
            maximum=123,
            minimum=123
        )
    ),
    scale=quicksight_mixins.CfnTemplatePropsMixin.AxisScaleProperty(
        linear=quicksight_mixins.CfnTemplatePropsMixin.AxisLinearScaleProperty(
            step_count=123,
            step_size=123
        ),
        logarithmic=quicksight_mixins.CfnTemplatePropsMixin.AxisLogarithmicScaleProperty(
            base=123
        )
    )
)

Attributes

range

The range setup of a numeric axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaxisoptions.html#cfn-quicksight-template-numericaxisoptions-range

scale

The scale setup of a numeric axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaxisoptions.html#cfn-quicksight-template-numericaxisoptions-scale

NumericEqualityDrillDownFilterProperty

class CfnTemplatePropsMixin.NumericEqualityDrillDownFilterProperty(*, column=None, value=None)

Bases: object

The numeric equality type drill down filter.

Parameters:

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the filter is applied to.

  • value (Union[int, float, None]) – The value of the double input numeric drill down filter. Default: - 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalitydrilldownfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

numeric_equality_drill_down_filter_property = quicksight_mixins.CfnTemplatePropsMixin.NumericEqualityDrillDownFilterProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    value=123
)

Attributes

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalitydrilldownfilter.html#cfn-quicksight-template-numericequalitydrilldownfilter-column

value

The value of the double input numeric drill down filter.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalitydrilldownfilter.html#cfn-quicksight-template-numericequalitydrilldownfilter-value

NumericEqualityFilterProperty

class CfnTemplatePropsMixin.NumericEqualityFilterProperty(*, aggregation_function=None, column=None, default_filter_control_configuration=None, filter_id=None, match_operator=None, null_option=None, parameter_name=None, select_all_options=None, value=None)

Bases: object

A NumericEqualityFilter filters values that are equal to the specified value.

Parameters:

  • aggregation_function (Union[IResolvable, AggregationFunctionProperty, Dict[str, Any], None]) – The aggregation function of the filter.

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the filter is applied to.

  • default_filter_control_configuration (Union[IResolvable, DefaultFilterControlConfigurationProperty, Dict[str, Any], None]) – The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

  • filter_id (Optional[str]) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • match_operator (Optional[str]) – The match operator that is used to determine if a filter should be applied.

  • null_option (Optional[str]) – This option determines how null values should be treated when filtering data. - ALL_VALUES : Include null values in filtered results. - NULLS_ONLY : Only include null values in filtered results. - NON_NULLS_ONLY : Exclude null values from filtered results.

  • parameter_name (Optional[str]) – The parameter whose value should be used for the filter value.

  • select_all_options (Optional[str]) – Select all of the values. Null is not the assigned value of select all. - FILTER_ALL_VALUES

  • value (Union[int, float, None]) – The input value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

numeric_equality_filter_property = quicksight_mixins.CfnTemplatePropsMixin.NumericEqualityFilterProperty(
    aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    ),
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    default_filter_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
        control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                    date_icon_visibility=date_icon_visibility,
                    date_time_format="dateTimeFormat",
                    helper_text_visibility=helper_text_visibility,
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                maximum_value=123,
                minimum_value=123,
                step_size=123,
                type="type"
            ),
            default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    filter_id="filterId",
    match_operator="matchOperator",
    null_option="nullOption",
    parameter_name="parameterName",
    select_all_options="selectAllOptions",
    value=123
)

Attributes

aggregation_function

The aggregation function of the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-aggregationfunction

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-column

default_filter_control_configuration

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-defaultfiltercontrolconfiguration

filter_id

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-filterid

match_operator

The match operator that is used to determine if a filter should be applied.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-matchoperator

null_option

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.

  • NULLS_ONLY : Only include null values in filtered results.

  • NON_NULLS_ONLY : Exclude null values from filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-nulloption

parameter_name

The parameter whose value should be used for the filter value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-parametername

select_all_options

Select all of the values. Null is not the assigned value of select all.

  • FILTER_ALL_VALUES

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-selectalloptions

value

The input value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericequalityfilter.html#cfn-quicksight-template-numericequalityfilter-value

NumericFormatConfigurationProperty

class CfnTemplatePropsMixin.NumericFormatConfigurationProperty(*, currency_display_format_configuration=None, number_display_format_configuration=None, percentage_display_format_configuration=None)

Bases: object

The options that determine the numeric format configuration.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericformatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

numeric_format_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
            decimal_places=123
        ),
        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
            display_mode="displayMode"
        ),
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        number_scale="numberScale",
        prefix="prefix",
        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
            decimal_separator="decimalSeparator",
            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                grouping_style="groupingStyle",
                symbol="symbol",
                visibility="visibility"
            )
        ),
        suffix="suffix",
        symbol="symbol"
    ),
    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
            decimal_places=123
        ),
        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
            display_mode="displayMode"
        ),
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        number_scale="numberScale",
        prefix="prefix",
        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
            decimal_separator="decimalSeparator",
            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                grouping_style="groupingStyle",
                symbol="symbol",
                visibility="visibility"
            )
        ),
        suffix="suffix"
    ),
    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
            decimal_places=123
        ),
        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
            display_mode="displayMode"
        ),
        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        prefix="prefix",
        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
            decimal_separator="decimalSeparator",
            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                grouping_style="groupingStyle",
                symbol="symbol",
                visibility="visibility"
            )
        ),
        suffix="suffix"
    )
)

Attributes

currency_display_format_configuration

The options that determine the currency display format configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericformatconfiguration.html#cfn-quicksight-template-numericformatconfiguration-currencydisplayformatconfiguration

number_display_format_configuration

The options that determine the number display format configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericformatconfiguration.html#cfn-quicksight-template-numericformatconfiguration-numberdisplayformatconfiguration

percentage_display_format_configuration

The options that determine the percentage display format configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericformatconfiguration.html#cfn-quicksight-template-numericformatconfiguration-percentagedisplayformatconfiguration

NumericRangeFilterProperty

class CfnTemplatePropsMixin.NumericRangeFilterProperty(*, aggregation_function=None, column=None, default_filter_control_configuration=None, filter_id=None, include_maximum=None, include_minimum=None, null_option=None, range_maximum=None, range_minimum=None, select_all_options=None)

Bases: object

A NumericRangeFilter filters values that are within the value range.

Parameters:

  • aggregation_function (Union[IResolvable, AggregationFunctionProperty, Dict[str, Any], None]) – The aggregation function of the filter.

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the filter is applied to.

  • default_filter_control_configuration (Union[IResolvable, DefaultFilterControlConfigurationProperty, Dict[str, Any], None]) – The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

  • filter_id (Optional[str]) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • include_maximum (Union[bool, IResolvable, None]) – Determines whether the maximum value in the filter value range should be included in the filtered results.

  • include_minimum (Union[bool, IResolvable, None]) – Determines whether the minimum value in the filter value range should be included in the filtered results.

  • null_option (Optional[str]) – This option determines how null values should be treated when filtering data. - ALL_VALUES : Include null values in filtered results. - NULLS_ONLY : Only include null values in filtered results. - NON_NULLS_ONLY : Exclude null values from filtered results.

  • range_maximum (Union[IResolvable, NumericRangeFilterValueProperty, Dict[str, Any], None]) – The maximum value for the filter value range.

  • range_minimum (Union[IResolvable, NumericRangeFilterValueProperty, Dict[str, Any], None]) – The minimum value for the filter value range.

  • select_all_options (Optional[str]) – Select all of the values. Null is not the assigned value of select all. - FILTER_ALL_VALUES

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

numeric_range_filter_property = quicksight_mixins.CfnTemplatePropsMixin.NumericRangeFilterProperty(
    aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    ),
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    default_filter_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
        control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                    date_icon_visibility=date_icon_visibility,
                    date_time_format="dateTimeFormat",
                    helper_text_visibility=helper_text_visibility,
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                maximum_value=123,
                minimum_value=123,
                step_size=123,
                type="type"
            ),
            default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    filter_id="filterId",
    include_maximum=False,
    include_minimum=False,
    null_option="nullOption",
    range_maximum=quicksight_mixins.CfnTemplatePropsMixin.NumericRangeFilterValueProperty(
        parameter="parameter",
        static_value=123
    ),
    range_minimum=quicksight_mixins.CfnTemplatePropsMixin.NumericRangeFilterValueProperty(
        parameter="parameter",
        static_value=123
    ),
    select_all_options="selectAllOptions"
)

Attributes

aggregation_function

The aggregation function of the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-aggregationfunction

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-column

default_filter_control_configuration

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-defaultfiltercontrolconfiguration

filter_id

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-filterid

include_maximum

Determines whether the maximum value in the filter value range should be included in the filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-includemaximum

include_minimum

Determines whether the minimum value in the filter value range should be included in the filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-includeminimum

null_option

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.

  • NULLS_ONLY : Only include null values in filtered results.

  • NON_NULLS_ONLY : Exclude null values from filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-nulloption

range_maximum

The maximum value for the filter value range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-rangemaximum

range_minimum

The minimum value for the filter value range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-rangeminimum

select_all_options

Select all of the values. Null is not the assigned value of select all.

  • FILTER_ALL_VALUES

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-selectalloptions

NumericRangeFilterValueProperty

class CfnTemplatePropsMixin.NumericRangeFilterValueProperty(*, parameter=None, static_value=None)

Bases: object

The value input pf the numeric range filter.

Parameters:

  • parameter (Optional[str]) – The parameter that is used in the numeric range.

  • static_value (Union[int, float, None]) – The static value of the numeric range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefiltervalue.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

numeric_range_filter_value_property = quicksight_mixins.CfnTemplatePropsMixin.NumericRangeFilterValueProperty(
    parameter="parameter",
    static_value=123
)

Attributes

parameter

The parameter that is used in the numeric range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefiltervalue.html#cfn-quicksight-template-numericrangefiltervalue-parameter

static_value

The static value of the numeric range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericrangefiltervalue.html#cfn-quicksight-template-numericrangefiltervalue-staticvalue

NumericSeparatorConfigurationProperty

class CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(*, decimal_separator=None, thousands_separator=None)

Bases: object

The options that determine the numeric separator configuration.

Parameters:

  • decimal_separator (Optional[str]) – Determines the decimal separator.

  • thousands_separator (Union[IResolvable, ThousandSeparatorOptionsProperty, Dict[str, Any], None]) – The options that determine the thousands separator configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericseparatorconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

numeric_separator_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
    decimal_separator="decimalSeparator",
    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
        grouping_style="groupingStyle",
        symbol="symbol",
        visibility="visibility"
    )
)

Attributes

decimal_separator

Determines the decimal separator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericseparatorconfiguration.html#cfn-quicksight-template-numericseparatorconfiguration-decimalseparator

thousands_separator

The options that determine the thousands separator configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericseparatorconfiguration.html#cfn-quicksight-template-numericseparatorconfiguration-thousandsseparator

NumericalAggregationFunctionProperty

class CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(*, percentile_aggregation=None, simple_numerical_aggregation=None)

Bases: object

Aggregation for numerical values.

Parameters:

  • percentile_aggregation (Union[IResolvable, PercentileAggregationProperty, Dict[str, Any], None]) – An aggregation based on the percentile of values in a dimension or measure.

  • simple_numerical_aggregation (Optional[str]) – Built-in aggregation functions for numerical values. - SUM : The sum of a dimension or measure. - AVERAGE : The average of a dimension or measure. - MIN : The minimum value of a dimension or measure. - MAX : The maximum value of a dimension or measure. - COUNT : The count of a dimension or measure. - DISTINCT_COUNT : The count of distinct values in a dimension or measure. - VAR : The variance of a dimension or measure. - VARP : The partitioned variance of a dimension or measure. - STDEV : The standard deviation of a dimension or measure. - STDEVP : The partitioned standard deviation of a dimension or measure. - MEDIAN : The median value of a dimension or measure.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalaggregationfunction.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

numerical_aggregation_function_property = quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
        percentile_value=123
    ),
    simple_numerical_aggregation="simpleNumericalAggregation"
)

Attributes

percentile_aggregation

An aggregation based on the percentile of values in a dimension or measure.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalaggregationfunction.html#cfn-quicksight-template-numericalaggregationfunction-percentileaggregation

simple_numerical_aggregation

Built-in aggregation functions for numerical values.

  • SUM : The sum of a dimension or measure.

  • AVERAGE : The average of a dimension or measure.

  • MIN : The minimum value of a dimension or measure.

  • MAX : The maximum value of a dimension or measure.

  • COUNT : The count of a dimension or measure.

  • DISTINCT_COUNT : The count of distinct values in a dimension or measure.

  • VAR : The variance of a dimension or measure.

  • VARP : The partitioned variance of a dimension or measure.

  • STDEV : The standard deviation of a dimension or measure.

  • STDEVP : The partitioned standard deviation of a dimension or measure.

  • MEDIAN : The median value of a dimension or measure.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalaggregationfunction.html#cfn-quicksight-template-numericalaggregationfunction-simplenumericalaggregation

NumericalDimensionFieldProperty

class CfnTemplatePropsMixin.NumericalDimensionFieldProperty(*, column=None, field_id=None, format_configuration=None, hierarchy_id=None)

Bases: object

The dimension type field with numerical type columns.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaldimensionfield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

numerical_dimension_field_property = quicksight_mixins.CfnTemplatePropsMixin.NumericalDimensionFieldProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",
    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    ),
    hierarchy_id="hierarchyId"
)

Attributes

column

The column that is used in the NumericalDimensionField .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaldimensionfield.html#cfn-quicksight-template-numericaldimensionfield-column

field_id

The custom field ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaldimensionfield.html#cfn-quicksight-template-numericaldimensionfield-fieldid

format_configuration

The format configuration of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaldimensionfield.html#cfn-quicksight-template-numericaldimensionfield-formatconfiguration

hierarchy_id

The custom hierarchy ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericaldimensionfield.html#cfn-quicksight-template-numericaldimensionfield-hierarchyid

NumericalMeasureFieldProperty

class CfnTemplatePropsMixin.NumericalMeasureFieldProperty(*, aggregation_function=None, column=None, field_id=None, format_configuration=None)

Bases: object

The measure type field with numerical type columns.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalmeasurefield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

numerical_measure_field_property = quicksight_mixins.CfnTemplatePropsMixin.NumericalMeasureFieldProperty(
    aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
        percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
            percentile_value=123
        ),
        simple_numerical_aggregation="simpleNumericalAggregation"
    ),
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",
    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    )
)

Attributes

aggregation_function

The aggregation function of the measure field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalmeasurefield.html#cfn-quicksight-template-numericalmeasurefield-aggregationfunction

column

The column that is used in the NumericalMeasureField .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalmeasurefield.html#cfn-quicksight-template-numericalmeasurefield-column

field_id

The custom field ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalmeasurefield.html#cfn-quicksight-template-numericalmeasurefield-fieldid

format_configuration

The format configuration of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-numericalmeasurefield.html#cfn-quicksight-template-numericalmeasurefield-formatconfiguration

PaginationConfigurationProperty

class CfnTemplatePropsMixin.PaginationConfigurationProperty(*, page_number=None, page_size=None)

Bases: object

The pagination configuration for a table visual or boxplot.

Parameters:

  • page_number (Union[int, float, None]) – Indicates the page number.

  • page_size (Union[int, float, None]) – Indicates how many items render in one page.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paginationconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pagination_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.PaginationConfigurationProperty(
    page_number=123,
    page_size=123
)

Attributes

page_number

Indicates the page number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paginationconfiguration.html#cfn-quicksight-template-paginationconfiguration-pagenumber

page_size

Indicates how many items render in one page.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paginationconfiguration.html#cfn-quicksight-template-paginationconfiguration-pagesize

PanelConfigurationProperty

class CfnTemplatePropsMixin.PanelConfigurationProperty(*, background_color=None, background_visibility=None, border_color=None, border_style=None, border_thickness=None, border_visibility=None, gutter_spacing=None, gutter_visibility=None, title=None)

Bases: object

A collection of options that configure how each panel displays in a small multiples chart.

Parameters:

  • background_color (Optional[str]) – Sets the background color for each panel.

  • background_visibility (Optional[str]) – Determines whether or not a background for each small multiples panel is rendered.

  • border_color (Optional[str]) – Sets the line color of panel borders.

  • border_style (Optional[str]) – Sets the line style of panel borders.

  • border_thickness (Optional[str]) – Sets the line thickness of panel borders.

  • border_visibility (Optional[str]) – Determines whether or not each panel displays a border.

  • gutter_spacing (Optional[str]) – Sets the total amount of negative space to display between sibling panels.

  • gutter_visibility (Optional[str]) – Determines whether or not negative space between sibling panels is rendered.

  • title (Union[IResolvable, PanelTitleOptionsProperty, Dict[str, Any], None]) – Configures the title display within each small multiples panel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

panel_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.PanelConfigurationProperty(
    background_color="backgroundColor",
    background_visibility="backgroundVisibility",
    border_color="borderColor",
    border_style="borderStyle",
    border_thickness="borderThickness",
    border_visibility="borderVisibility",
    gutter_spacing="gutterSpacing",
    gutter_visibility="gutterVisibility",
    title=quicksight_mixins.CfnTemplatePropsMixin.PanelTitleOptionsProperty(
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        horizontal_text_alignment="horizontalTextAlignment",
        visibility="visibility"
    )
)

Attributes

background_color

Sets the background color for each panel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-backgroundcolor

background_visibility

Determines whether or not a background for each small multiples panel is rendered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-backgroundvisibility

border_color

Sets the line color of panel borders.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-bordercolor

border_style

Sets the line style of panel borders.

See:

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

border_thickness

Sets the line thickness of panel borders.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-borderthickness

border_visibility

Determines whether or not each panel displays a border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-bordervisibility

gutter_spacing

Sets the total amount of negative space to display between sibling panels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-gutterspacing

gutter_visibility

Determines whether or not negative space between sibling panels is rendered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-guttervisibility

title

Configures the title display within each small multiples panel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-panelconfiguration.html#cfn-quicksight-template-panelconfiguration-title

PanelTitleOptionsProperty

class CfnTemplatePropsMixin.PanelTitleOptionsProperty(*, font_configuration=None, horizontal_text_alignment=None, visibility=None)

Bases: object

The options that determine the title styles for each small multiples panel.

Parameters:

  • font_configuration (Union[IResolvable, FontConfigurationProperty, Dict[str, Any], None])

  • horizontal_text_alignment (Optional[str]) – Sets the horizontal text alignment of the title within each panel.

  • visibility (Optional[str]) – Determines whether or not panel titles are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paneltitleoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

panel_title_options_property = quicksight_mixins.CfnTemplatePropsMixin.PanelTitleOptionsProperty(
    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    ),
    horizontal_text_alignment="horizontalTextAlignment",
    visibility="visibility"
)

Attributes

font_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paneltitleoptions.html#cfn-quicksight-template-paneltitleoptions-fontconfiguration

Type:

see

horizontal_text_alignment

Sets the horizontal text alignment of the title within each panel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paneltitleoptions.html#cfn-quicksight-template-paneltitleoptions-horizontaltextalignment

visibility

Determines whether or not panel titles are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-paneltitleoptions.html#cfn-quicksight-template-paneltitleoptions-visibility

ParameterControlProperty

class CfnTemplatePropsMixin.ParameterControlProperty(*, date_time_picker=None, dropdown=None, list=None, slider=None, text_area=None, text_field=None)

Bases: object

The control of a parameter that users can interact with in a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

parameter_control_property = quicksight_mixins.CfnTemplatePropsMixin.ParameterControlProperty(
    date_time_picker=quicksight_mixins.CfnTemplatePropsMixin.ParameterDateTimePickerControlProperty(
        display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
            date_icon_visibility=date_icon_visibility,
            date_time_format="dateTimeFormat",
            helper_text_visibility=helper_text_visibility,
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        parameter_control_id="parameterControlId",
        source_parameter_name="sourceParameterName",
        title="title"
    ),
    dropdown=quicksight_mixins.CfnTemplatePropsMixin.ParameterDropDownControlProperty(
        cascading_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
            source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
                column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_sheet_control_id="sourceSheetControlId"
            )]
        ),
        commit_mode="commitMode",
        display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        parameter_control_id="parameterControlId",
        selectable_values=quicksight_mixins.CfnTemplatePropsMixin.ParameterSelectableValuesProperty(
            link_to_data_set_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            values=["values"]
        ),
        source_parameter_name="sourceParameterName",
        title="title",
        type="type"
    ),
    list=quicksight_mixins.CfnTemplatePropsMixin.ParameterListControlProperty(
        cascading_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
            source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
                column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_sheet_control_id="sourceSheetControlId"
            )]
        ),
        display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                visibility="visibility"
            ),
            select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        parameter_control_id="parameterControlId",
        selectable_values=quicksight_mixins.CfnTemplatePropsMixin.ParameterSelectableValuesProperty(
            link_to_data_set_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            values=["values"]
        ),
        source_parameter_name="sourceParameterName",
        title="title",
        type="type"
    ),
    slider=quicksight_mixins.CfnTemplatePropsMixin.ParameterSliderControlProperty(
        display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        maximum_value=123,
        minimum_value=123,
        parameter_control_id="parameterControlId",
        source_parameter_name="sourceParameterName",
        step_size=123,
        title="title"
    ),
    text_area=quicksight_mixins.CfnTemplatePropsMixin.ParameterTextAreaControlProperty(
        delimiter="delimiter",
        display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        parameter_control_id="parameterControlId",
        source_parameter_name="sourceParameterName",
        title="title"
    ),
    text_field=quicksight_mixins.CfnTemplatePropsMixin.ParameterTextFieldControlProperty(
        display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
            info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        parameter_control_id="parameterControlId",
        source_parameter_name="sourceParameterName",
        title="title"
    )
)

Attributes

date_time_picker

A control from a date parameter that specifies date and time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-datetimepicker

dropdown

A control to display a dropdown list with buttons that are used to select a single value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-dropdown

list

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-list

slider

A control to display a horizontal toggle bar.

This is used to change a value by sliding the toggle.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-slider

text_area

A control to display a text box that is used to enter multiple entries.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-textarea

text_field

A control to display a text box that is used to enter a single entry.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametercontrol.html#cfn-quicksight-template-parametercontrol-textfield

ParameterDateTimePickerControlProperty

class CfnTemplatePropsMixin.ParameterDateTimePickerControlProperty(*, display_options=None, parameter_control_id=None, source_parameter_name=None, title=None)

Bases: object

A control from a date parameter that specifies date and time.

Parameters:

  • display_options (Union[IResolvable, DateTimePickerControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • parameter_control_id (Optional[str]) – The ID of the ParameterDateTimePickerControl .

  • source_parameter_name (Optional[str]) – The name of the ParameterDateTimePickerControl .

  • title (Optional[str]) – The title of the ParameterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdatetimepickercontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

parameter_date_time_picker_control_property = quicksight_mixins.CfnTemplatePropsMixin.ParameterDateTimePickerControlProperty(
    display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
        date_icon_visibility=date_icon_visibility,
        date_time_format="dateTimeFormat",
        helper_text_visibility=helper_text_visibility,
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    title="title"
)

Attributes

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdatetimepickercontrol.html#cfn-quicksight-template-parameterdatetimepickercontrol-displayoptions

parameter_control_id

The ID of the ParameterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdatetimepickercontrol.html#cfn-quicksight-template-parameterdatetimepickercontrol-parametercontrolid

source_parameter_name

The name of the ParameterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdatetimepickercontrol.html#cfn-quicksight-template-parameterdatetimepickercontrol-sourceparametername

title

The title of the ParameterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdatetimepickercontrol.html#cfn-quicksight-template-parameterdatetimepickercontrol-title

ParameterDeclarationProperty

class CfnTemplatePropsMixin.ParameterDeclarationProperty(*, date_time_parameter_declaration=None, decimal_parameter_declaration=None, integer_parameter_declaration=None, string_parameter_declaration=None)

Bases: object

The declaration definition of a parameter.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdeclaration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

parameter_declaration_property = quicksight_mixins.CfnTemplatePropsMixin.ParameterDeclarationProperty(
    date_time_parameter_declaration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeParameterDeclarationProperty(
        default_values=quicksight_mixins.CfnTemplatePropsMixin.DateTimeDefaultValuesProperty(
            dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
                default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            rolling_date=quicksight_mixins.CfnTemplatePropsMixin.RollingDateConfigurationProperty(
                data_set_identifier="dataSetIdentifier",
                expression="expression"
            ),
            static_values=["staticValues"]
        ),
        mapped_data_set_parameters=[quicksight_mixins.CfnTemplatePropsMixin.MappedDataSetParameterProperty(
            data_set_identifier="dataSetIdentifier",
            data_set_parameter_name="dataSetParameterName"
        )],
        name="name",
        time_granularity="timeGranularity",
        value_when_unset=quicksight_mixins.CfnTemplatePropsMixin.DateTimeValueWhenUnsetConfigurationProperty(
            custom_value="customValue",
            value_when_unset_option="valueWhenUnsetOption"
        )
    ),
    decimal_parameter_declaration=quicksight_mixins.CfnTemplatePropsMixin.DecimalParameterDeclarationProperty(
        default_values=quicksight_mixins.CfnTemplatePropsMixin.DecimalDefaultValuesProperty(
            dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
                default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            static_values=[123]
        ),
        mapped_data_set_parameters=[quicksight_mixins.CfnTemplatePropsMixin.MappedDataSetParameterProperty(
            data_set_identifier="dataSetIdentifier",
            data_set_parameter_name="dataSetParameterName"
        )],
        name="name",
        parameter_value_type="parameterValueType",
        value_when_unset=quicksight_mixins.CfnTemplatePropsMixin.DecimalValueWhenUnsetConfigurationProperty(
            custom_value=123,
            value_when_unset_option="valueWhenUnsetOption"
        )
    ),
    integer_parameter_declaration=quicksight_mixins.CfnTemplatePropsMixin.IntegerParameterDeclarationProperty(
        default_values=quicksight_mixins.CfnTemplatePropsMixin.IntegerDefaultValuesProperty(
            dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
                default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            static_values=[123]
        ),
        mapped_data_set_parameters=[quicksight_mixins.CfnTemplatePropsMixin.MappedDataSetParameterProperty(
            data_set_identifier="dataSetIdentifier",
            data_set_parameter_name="dataSetParameterName"
        )],
        name="name",
        parameter_value_type="parameterValueType",
        value_when_unset=quicksight_mixins.CfnTemplatePropsMixin.IntegerValueWhenUnsetConfigurationProperty(
            custom_value=123,
            value_when_unset_option="valueWhenUnsetOption"
        )
    ),
    string_parameter_declaration=quicksight_mixins.CfnTemplatePropsMixin.StringParameterDeclarationProperty(
        default_values=quicksight_mixins.CfnTemplatePropsMixin.StringDefaultValuesProperty(
            dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
                default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            static_values=["staticValues"]
        ),
        mapped_data_set_parameters=[quicksight_mixins.CfnTemplatePropsMixin.MappedDataSetParameterProperty(
            data_set_identifier="dataSetIdentifier",
            data_set_parameter_name="dataSetParameterName"
        )],
        name="name",
        parameter_value_type="parameterValueType",
        value_when_unset=quicksight_mixins.CfnTemplatePropsMixin.StringValueWhenUnsetConfigurationProperty(
            custom_value="customValue",
            value_when_unset_option="valueWhenUnsetOption"
        )
    )
)

Attributes

date_time_parameter_declaration

A parameter declaration for the DateTime data type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdeclaration.html#cfn-quicksight-template-parameterdeclaration-datetimeparameterdeclaration

decimal_parameter_declaration

A parameter declaration for the Decimal data type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdeclaration.html#cfn-quicksight-template-parameterdeclaration-decimalparameterdeclaration

integer_parameter_declaration

A parameter declaration for the Integer data type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdeclaration.html#cfn-quicksight-template-parameterdeclaration-integerparameterdeclaration

string_parameter_declaration

A parameter declaration for the String data type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdeclaration.html#cfn-quicksight-template-parameterdeclaration-stringparameterdeclaration

ParameterDropDownControlProperty

class CfnTemplatePropsMixin.ParameterDropDownControlProperty(*, cascading_control_configuration=None, commit_mode=None, display_options=None, parameter_control_id=None, selectable_values=None, source_parameter_name=None, title=None, type=None)

Bases: object

A control to display a dropdown list with buttons that are used to select a single value.

Parameters:

  • cascading_control_configuration (Union[IResolvable, CascadingControlConfigurationProperty, Dict[str, Any], None]) – The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

  • commit_mode (Optional[str]) – The visibility configuration of the Apply button on a ParameterDropDownControl .

  • display_options (Union[IResolvable, DropDownControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • parameter_control_id (Optional[str]) – The ID of the ParameterDropDownControl .

  • selectable_values (Union[IResolvable, ParameterSelectableValuesProperty, Dict[str, Any], None]) – A list of selectable values that are used in a control.

  • source_parameter_name (Optional[str]) – The source parameter name of the ParameterDropDownControl .

  • title (Optional[str]) – The title of the ParameterDropDownControl .

  • type (Optional[str]) – The type parameter name of the ParameterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

parameter_drop_down_control_property = quicksight_mixins.CfnTemplatePropsMixin.ParameterDropDownControlProperty(
    cascading_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
        source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
            column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_sheet_control_id="sourceSheetControlId"
        )]
    ),
    commit_mode="commitMode",
    display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    parameter_control_id="parameterControlId",
    selectable_values=quicksight_mixins.CfnTemplatePropsMixin.ParameterSelectableValuesProperty(
        link_to_data_set_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        values=["values"]
    ),
    source_parameter_name="sourceParameterName",
    title="title",
    type="type"
)

Attributes

cascading_control_configuration

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-cascadingcontrolconfiguration

commit_mode

The visibility configuration of the Apply button on a ParameterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-displayoptions

parameter_control_id

The ID of the ParameterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-parametercontrolid

selectable_values

A list of selectable values that are used in a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-selectablevalues

source_parameter_name

The source parameter name of the ParameterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-sourceparametername

title

The title of the ParameterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterdropdowncontrol.html#cfn-quicksight-template-parameterdropdowncontrol-title

type

The type parameter name of the ParameterDropDownControl .

See:

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

ParameterListControlProperty

class CfnTemplatePropsMixin.ParameterListControlProperty(*, cascading_control_configuration=None, display_options=None, parameter_control_id=None, selectable_values=None, source_parameter_name=None, title=None, type=None)

Bases: object

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

Parameters:

  • cascading_control_configuration (Union[IResolvable, CascadingControlConfigurationProperty, Dict[str, Any], None]) – The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

  • display_options (Union[IResolvable, ListControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • parameter_control_id (Optional[str]) – The ID of the ParameterListControl .

  • selectable_values (Union[IResolvable, ParameterSelectableValuesProperty, Dict[str, Any], None]) – A list of selectable values that are used in a control.

  • source_parameter_name (Optional[str]) – The source parameter name of the ParameterListControl .

  • title (Optional[str]) – The title of the ParameterListControl .

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

parameter_list_control_property = quicksight_mixins.CfnTemplatePropsMixin.ParameterListControlProperty(
    cascading_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.CascadingControlConfigurationProperty(
        source_controls=[quicksight_mixins.CfnTemplatePropsMixin.CascadingControlSourceProperty(
            column_to_match=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_sheet_control_id="sourceSheetControlId"
        )]
    ),
    display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
            visibility="visibility"
        ),
        select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    parameter_control_id="parameterControlId",
    selectable_values=quicksight_mixins.CfnTemplatePropsMixin.ParameterSelectableValuesProperty(
        link_to_data_set_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        values=["values"]
    ),
    source_parameter_name="sourceParameterName",
    title="title",
    type="type"
)

Attributes

cascading_control_configuration

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-cascadingcontrolconfiguration

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-displayoptions

parameter_control_id

The ID of the ParameterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-parametercontrolid

selectable_values

A list of selectable values that are used in a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-selectablevalues

source_parameter_name

The source parameter name of the ParameterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-sourceparametername

title

The title of the ParameterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterlistcontrol.html#cfn-quicksight-template-parameterlistcontrol-title

type

The type of ParameterListControl .

See:

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

ParameterSelectableValuesProperty

class CfnTemplatePropsMixin.ParameterSelectableValuesProperty(*, link_to_data_set_column=None, values=None)

Bases: object

A list of selectable values that are used in a control.

Parameters:

  • link_to_data_set_column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column identifier that fetches values from the data set.

  • values (Optional[Sequence[str]]) – The values that are used in ParameterSelectableValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterselectablevalues.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

parameter_selectable_values_property = quicksight_mixins.CfnTemplatePropsMixin.ParameterSelectableValuesProperty(
    link_to_data_set_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    values=["values"]
)

Attributes

The column identifier that fetches values from the data set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterselectablevalues.html#cfn-quicksight-template-parameterselectablevalues-linktodatasetcolumn

values

The values that are used in ParameterSelectableValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterselectablevalues.html#cfn-quicksight-template-parameterselectablevalues-values

ParameterSliderControlProperty

class CfnTemplatePropsMixin.ParameterSliderControlProperty(*, display_options=None, maximum_value=None, minimum_value=None, parameter_control_id=None, source_parameter_name=None, step_size=None, title=None)

Bases: object

A control to display a horizontal toggle bar.

This is used to change a value by sliding the toggle.

Parameters:

  • display_options (Union[IResolvable, SliderControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • maximum_value (Union[int, float, None]) – The larger value that is displayed at the right of the slider. Default: - 0

  • minimum_value (Union[int, float, None]) – The smaller value that is displayed at the left of the slider. Default: - 0

  • parameter_control_id (Optional[str]) – The ID of the ParameterSliderControl .

  • source_parameter_name (Optional[str]) – The source parameter name of the ParameterSliderControl .

  • step_size (Union[int, float, None]) – The number of increments that the slider bar is divided into. Default: - 0

  • title (Optional[str]) – The title of the ParameterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

parameter_slider_control_property = quicksight_mixins.CfnTemplatePropsMixin.ParameterSliderControlProperty(
    display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    maximum_value=123,
    minimum_value=123,
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    step_size=123,
    title="title"
)

Attributes

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-displayoptions

maximum_value

The larger value that is displayed at the right of the slider.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-maximumvalue

minimum_value

The smaller value that is displayed at the left of the slider.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-minimumvalue

parameter_control_id

The ID of the ParameterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-parametercontrolid

source_parameter_name

The source parameter name of the ParameterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-sourceparametername

step_size

The number of increments that the slider bar is divided into.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-stepsize

title

The title of the ParameterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parameterslidercontrol.html#cfn-quicksight-template-parameterslidercontrol-title

ParameterTextAreaControlProperty

class CfnTemplatePropsMixin.ParameterTextAreaControlProperty(*, delimiter=None, display_options=None, parameter_control_id=None, source_parameter_name=None, title=None)

Bases: object

A control to display a text box that is used to enter multiple entries.

Parameters:

  • delimiter (Optional[str]) – The delimiter that is used to separate the lines in text.

  • display_options (Union[IResolvable, TextAreaControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • parameter_control_id (Optional[str]) – The ID of the ParameterTextAreaControl .

  • source_parameter_name (Optional[str]) – The source parameter name of the ParameterTextAreaControl .

  • title (Optional[str]) – The title of the ParameterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

parameter_text_area_control_property = quicksight_mixins.CfnTemplatePropsMixin.ParameterTextAreaControlProperty(
    delimiter="delimiter",
    display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    title="title"
)

Attributes

delimiter

The delimiter that is used to separate the lines in text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html#cfn-quicksight-template-parametertextareacontrol-delimiter

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html#cfn-quicksight-template-parametertextareacontrol-displayoptions

parameter_control_id

The ID of the ParameterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html#cfn-quicksight-template-parametertextareacontrol-parametercontrolid

source_parameter_name

The source parameter name of the ParameterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html#cfn-quicksight-template-parametertextareacontrol-sourceparametername

title

The title of the ParameterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextareacontrol.html#cfn-quicksight-template-parametertextareacontrol-title

ParameterTextFieldControlProperty

class CfnTemplatePropsMixin.ParameterTextFieldControlProperty(*, display_options=None, parameter_control_id=None, source_parameter_name=None, title=None)

Bases: object

A control to display a text box that is used to enter a single entry.

Parameters:

  • display_options (Union[IResolvable, TextFieldControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

  • parameter_control_id (Optional[str]) – The ID of the ParameterTextFieldControl .

  • source_parameter_name (Optional[str]) – The source parameter name of the ParameterTextFieldControl .

  • title (Optional[str]) – The title of the ParameterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextfieldcontrol.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

parameter_text_field_control_property = quicksight_mixins.CfnTemplatePropsMixin.ParameterTextFieldControlProperty(
    display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
        info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    title="title"
)

Attributes

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextfieldcontrol.html#cfn-quicksight-template-parametertextfieldcontrol-displayoptions

parameter_control_id

The ID of the ParameterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextfieldcontrol.html#cfn-quicksight-template-parametertextfieldcontrol-parametercontrolid

source_parameter_name

The source parameter name of the ParameterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextfieldcontrol.html#cfn-quicksight-template-parametertextfieldcontrol-sourceparametername

title

The title of the ParameterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-parametertextfieldcontrol.html#cfn-quicksight-template-parametertextfieldcontrol-title

PercentVisibleRangeProperty

class CfnTemplatePropsMixin.PercentVisibleRangeProperty(*, from_=None, to=None)

Bases: object

The percent range in the visible range.

Parameters:

  • from – The lower bound of the range.

  • to (Union[int, float, None]) – The top bound of the range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentvisiblerange.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

percent_visible_range_property = quicksight_mixins.CfnTemplatePropsMixin.PercentVisibleRangeProperty(
    from=123,
    to=123
)

Attributes

from_

The lower bound of the range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentvisiblerange.html#cfn-quicksight-template-percentvisiblerange-from

to

The top bound of the range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentvisiblerange.html#cfn-quicksight-template-percentvisiblerange-to

PercentageDisplayFormatConfigurationProperty

class CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(*, decimal_places_configuration=None, negative_value_configuration=None, null_value_format_configuration=None, prefix=None, separator_configuration=None, suffix=None)

Bases: object

The options that determine the percentage display format configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

percentage_display_format_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
        decimal_places=123
    ),
    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
        display_mode="displayMode"
    ),
    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    prefix="prefix",
    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
        decimal_separator="decimalSeparator",
        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
            grouping_style="groupingStyle",
            symbol="symbol",
            visibility="visibility"
        )
    ),
    suffix="suffix"
)

Attributes

decimal_places_configuration

The option that determines the decimal places configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-decimalplacesconfiguration

negative_value_configuration

The options that determine the negative value configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-negativevalueconfiguration

null_value_format_configuration

The options that determine the null value format configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-nullvalueformatconfiguration

prefix

Determines the prefix value of the percentage format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-prefix

separator_configuration

The options that determine the numeric separator configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-separatorconfiguration

suffix

Determines the suffix value of the percentage format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentagedisplayformatconfiguration.html#cfn-quicksight-template-percentagedisplayformatconfiguration-suffix

PercentileAggregationProperty

class CfnTemplatePropsMixin.PercentileAggregationProperty(*, percentile_value=None)

Bases: object

An aggregation based on the percentile of values in a dimension or measure.

Parameters:

percentile_value (Union[int, float, None]) – The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentileaggregation.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

percentile_aggregation_property = quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
    percentile_value=123
)

Attributes

percentile_value

The percentile value.

This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-percentileaggregation.html#cfn-quicksight-template-percentileaggregation-percentilevalue

PeriodOverPeriodComputationProperty

class CfnTemplatePropsMixin.PeriodOverPeriodComputationProperty(*, computation_id=None, name=None, time=None, value=None)

Bases: object

The period over period computation configuration.

Parameters:

  • computation_id (Optional[str]) – The ID for a computation.

  • name (Optional[str]) – The name of a computation.

  • time (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The time field that is used in a computation.

  • value (Union[IResolvable, MeasureFieldProperty, Dict[str, Any], None]) – The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodoverperiodcomputation.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodoverperiodcomputation.html#cfn-quicksight-template-periodoverperiodcomputation-computationid

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodoverperiodcomputation.html#cfn-quicksight-template-periodoverperiodcomputation-name

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodoverperiodcomputation.html#cfn-quicksight-template-periodoverperiodcomputation-time

value

The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodoverperiodcomputation.html#cfn-quicksight-template-periodoverperiodcomputation-value

PeriodToDateComputationProperty

class CfnTemplatePropsMixin.PeriodToDateComputationProperty(*, computation_id=None, name=None, period_time_granularity=None, time=None, value=None)

Bases: object

The period to date computation configuration.

Parameters:

  • computation_id (Optional[str]) – The ID for a computation.

  • name (Optional[str]) – The name of a computation.

  • period_time_granularity (Optional[str]) – The time granularity setup of period to date computation. Choose from the following options:. - YEAR: Year to date. - MONTH: Month to date.

  • time (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The time field that is used in a computation.

  • value (Union[IResolvable, MeasureFieldProperty, Dict[str, Any], None]) – The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html#cfn-quicksight-template-periodtodatecomputation-computationid

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html#cfn-quicksight-template-periodtodatecomputation-name

period_time_granularity

.

  • YEAR: Year to date.

  • MONTH: Month to date.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html#cfn-quicksight-template-periodtodatecomputation-periodtimegranularity

Type:

The time granularity setup of period to date computation. Choose from the following options

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html#cfn-quicksight-template-periodtodatecomputation-time

value

The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-periodtodatecomputation.html#cfn-quicksight-template-periodtodatecomputation-value

PieChartAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.PieChartAggregatedFieldWellsProperty(*, category=None, small_multiples=None, values=None)

Bases: object

The field well configuration of a pie chart.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category

The category (group/color) field wells of a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartaggregatedfieldwells.html#cfn-quicksight-template-piechartaggregatedfieldwells-category

small_multiples

The small multiples field well of a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartaggregatedfieldwells.html#cfn-quicksight-template-piechartaggregatedfieldwells-smallmultiples

values

The value field wells of a pie chart.

Values are aggregated based on categories.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartaggregatedfieldwells.html#cfn-quicksight-template-piechartaggregatedfieldwells-values

PieChartConfigurationProperty

class CfnTemplatePropsMixin.PieChartConfigurationProperty(*, category_label_options=None, contribution_analysis_defaults=None, data_labels=None, donut_options=None, field_wells=None, interactions=None, legend=None, small_multiples_options=None, sort_configuration=None, tooltip=None, value_label_options=None, visual_palette=None)

Bases: object

The configuration of a pie chart.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category_label_options

The label options of the group/color that is displayed in a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-categorylabeloptions

contribution_analysis_defaults

The contribution analysis (anomaly configuration) setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-contributionanalysisdefaults

data_labels

The options that determine if visual data labels are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-datalabels

donut_options

The options that determine the shape of the chart.

This option determines whether the chart is a pie chart or a donut chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-donutoptions

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-interactions

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-legend

small_multiples_options

The small multiples setup for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-smallmultiplesoptions

sort_configuration

The sort configuration of a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-sortconfiguration

tooltip

The tooltip display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-tooltip

value_label_options

The label options for the value that is displayed in a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-valuelabeloptions

visual_palette

The palette (chart color) display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartconfiguration.html#cfn-quicksight-template-piechartconfiguration-visualpalette

PieChartFieldWellsProperty

class CfnTemplatePropsMixin.PieChartFieldWellsProperty(*, pie_chart_aggregated_field_wells=None)

Bases: object

The field well configuration of a pie chart.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

pie_chart_aggregated_field_wells (Union[IResolvable, PieChartAggregatedFieldWellsProperty, Dict[str, Any], None]) – The field well configuration of a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
pie_chart_aggregated_field_wells

The field well configuration of a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartfieldwells.html#cfn-quicksight-template-piechartfieldwells-piechartaggregatedfieldwells

PieChartSortConfigurationProperty

class CfnTemplatePropsMixin.PieChartSortConfigurationProperty(*, category_items_limit=None, category_sort=None, small_multiples_limit_configuration=None, small_multiples_sort=None)

Bases: object

The sort configuration of a pie chart.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pie_chart_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.PieChartSortConfigurationProperty(
    category_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    small_multiples_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    small_multiples_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

category_items_limit

The limit on the number of categories that are displayed in a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartsortconfiguration.html#cfn-quicksight-template-piechartsortconfiguration-categoryitemslimit

category_sort

The sort configuration of the category fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartsortconfiguration.html#cfn-quicksight-template-piechartsortconfiguration-categorysort

small_multiples_limit_configuration

The limit on the number of small multiples panels that are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartsortconfiguration.html#cfn-quicksight-template-piechartsortconfiguration-smallmultipleslimitconfiguration

small_multiples_sort

The sort configuration of the small multiples field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartsortconfiguration.html#cfn-quicksight-template-piechartsortconfiguration-smallmultiplessort

PieChartVisualProperty

class CfnTemplatePropsMixin.PieChartVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A pie or donut chart.

The PieChartVisual structure describes a visual that is a member of the pie chart family.

The following charts can be described by using this structure:

  • Pie charts

  • Donut charts

For more information, see Using pie charts in the Amazon Quick Suite User Guide .

For more information, see Using donut charts in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration of a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-piechartvisual.html#cfn-quicksight-template-piechartvisual-visualid

PivotFieldSortOptionsProperty

class CfnTemplatePropsMixin.PivotFieldSortOptionsProperty(*, field_id=None, sort_by=None)

Bases: object

The field sort options for a pivot table sort configuration.

Parameters:

  • field_id (Optional[str]) – The field ID for the field sort options.

  • sort_by (Union[IResolvable, PivotTableSortByProperty, Dict[str, Any], None]) – The sort by field for the field sort options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivotfieldsortoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_field_sort_options_property = quicksight_mixins.CfnTemplatePropsMixin.PivotFieldSortOptionsProperty(
    field_id="fieldId",
    sort_by=quicksight_mixins.CfnTemplatePropsMixin.PivotTableSortByProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        data_path=quicksight_mixins.CfnTemplatePropsMixin.DataPathSortProperty(
            direction="direction",
            sort_paths=[quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
                data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
                    pivot_table_data_path_type="pivotTableDataPathType"
                ),
                field_id="fieldId",
                field_value="fieldValue"
            )]
        ),
        field=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )
)

Attributes

field_id

The field ID for the field sort options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivotfieldsortoptions.html#cfn-quicksight-template-pivotfieldsortoptions-fieldid

sort_by

The sort by field for the field sort options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivotfieldsortoptions.html#cfn-quicksight-template-pivotfieldsortoptions-sortby

PivotTableAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.PivotTableAggregatedFieldWellsProperty(*, columns=None, rows=None, values=None)

Bases: object

The aggregated field well for the pivot table.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
columns

The columns field well for a pivot table.

Values are grouped by columns fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableaggregatedfieldwells.html#cfn-quicksight-template-pivottableaggregatedfieldwells-columns

rows

The rows field well for a pivot table.

Values are grouped by rows fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableaggregatedfieldwells.html#cfn-quicksight-template-pivottableaggregatedfieldwells-rows

values

The values field well for a pivot table.

Values are aggregated based on rows and columns fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableaggregatedfieldwells.html#cfn-quicksight-template-pivottableaggregatedfieldwells-values

PivotTableCellConditionalFormattingProperty

class CfnTemplatePropsMixin.PivotTableCellConditionalFormattingProperty(*, field_id=None, scope=None, scopes=None, text_format=None)

Bases: object

The cell conditional formatting option for a pivot table.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablecellconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_cell_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableCellConditionalFormattingProperty(
    field_id="fieldId",
    scope=quicksight_mixins.CfnTemplatePropsMixin.PivotTableConditionalFormattingScopeProperty(
        role="role"
    ),
    scopes=[quicksight_mixins.CfnTemplatePropsMixin.PivotTableConditionalFormattingScopeProperty(
        role="role"
    )],
    text_format=quicksight_mixins.CfnTemplatePropsMixin.TextConditionalFormatProperty(
        background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        ),
        icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
            custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                color="color",
                display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                ),
                expression="expression",
                icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                )
            ),
            icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                expression="expression",
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        )
    )
)

Attributes

field_id

The field ID of the cell for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablecellconditionalformatting.html#cfn-quicksight-template-pivottablecellconditionalformatting-fieldid

scope

The scope of the cell for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablecellconditionalformatting.html#cfn-quicksight-template-pivottablecellconditionalformatting-scope

scopes

A list of cell scopes for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablecellconditionalformatting.html#cfn-quicksight-template-pivottablecellconditionalformatting-scopes

text_format

The text format of the cell for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablecellconditionalformatting.html#cfn-quicksight-template-pivottablecellconditionalformatting-textformat

PivotTableConditionalFormattingOptionProperty

class CfnTemplatePropsMixin.PivotTableConditionalFormattingOptionProperty(*, cell=None)

Bases: object

Conditional formatting options for a PivotTableVisual .

Parameters:

cell (Union[IResolvable, PivotTableCellConditionalFormattingProperty, Dict[str, Any], None]) – The cell conditional formatting option for a pivot table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformattingoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_conditional_formatting_option_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableConditionalFormattingOptionProperty(
    cell=quicksight_mixins.CfnTemplatePropsMixin.PivotTableCellConditionalFormattingProperty(
        field_id="fieldId",
        scope=quicksight_mixins.CfnTemplatePropsMixin.PivotTableConditionalFormattingScopeProperty(
            role="role"
        ),
        scopes=[quicksight_mixins.CfnTemplatePropsMixin.PivotTableConditionalFormattingScopeProperty(
            role="role"
        )],
        text_format=quicksight_mixins.CfnTemplatePropsMixin.TextConditionalFormatProperty(
            background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            ),
            icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
                custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                    color="color",
                    display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    ),
                    expression="expression",
                    icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    )
                ),
                icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                    expression="expression",
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            )
        )
    )
)

Attributes

cell

The cell conditional formatting option for a pivot table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformattingoption.html#cfn-quicksight-template-pivottableconditionalformattingoption-cell

PivotTableConditionalFormattingProperty

class CfnTemplatePropsMixin.PivotTableConditionalFormattingProperty(*, conditional_formatting_options=None)

Bases: object

The conditional formatting for a PivotTableVisual .

Parameters:

conditional_formatting_options (Union[IResolvable, Sequence[Union[IResolvable, PivotTableConditionalFormattingOptionProperty, Dict[str, Any]]], None]) – Conditional formatting options for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableConditionalFormattingProperty(
    conditional_formatting_options=[quicksight_mixins.CfnTemplatePropsMixin.PivotTableConditionalFormattingOptionProperty(
        cell=quicksight_mixins.CfnTemplatePropsMixin.PivotTableCellConditionalFormattingProperty(
            field_id="fieldId",
            scope=quicksight_mixins.CfnTemplatePropsMixin.PivotTableConditionalFormattingScopeProperty(
                role="role"
            ),
            scopes=[quicksight_mixins.CfnTemplatePropsMixin.PivotTableConditionalFormattingScopeProperty(
                role="role"
            )],
            text_format=quicksight_mixins.CfnTemplatePropsMixin.TextConditionalFormatProperty(
                background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                    gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                        color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                            stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                                color="color",
                                data_value=123,
                                gradient_offset=123
                            )]
                        ),
                        expression="expression"
                    ),
                    solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                        color="color",
                        expression="expression"
                    )
                ),
                icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
                    custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                        color="color",
                        display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                            icon_display_option="iconDisplayOption"
                        ),
                        expression="expression",
                        icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                            icon="icon",
                            unicode_icon="unicodeIcon"
                        )
                    ),
                    icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                        expression="expression",
                        icon_set_type="iconSetType"
                    )
                ),
                text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                    gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                        color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                            stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                                color="color",
                                data_value=123,
                                gradient_offset=123
                            )]
                        ),
                        expression="expression"
                    ),
                    solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                        color="color",
                        expression="expression"
                    )
                )
            )
        )
    )]
)

Attributes

conditional_formatting_options

Conditional formatting options for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformatting.html#cfn-quicksight-template-pivottableconditionalformatting-conditionalformattingoptions

PivotTableConditionalFormattingScopeProperty

class CfnTemplatePropsMixin.PivotTableConditionalFormattingScopeProperty(*, role=None)

Bases: object

The scope of the cell for conditional formatting.

Parameters:

role (Optional[str]) – The role (field, field total, grand total) of the cell for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformattingscope.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_conditional_formatting_scope_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableConditionalFormattingScopeProperty(
    role="role"
)

Attributes

role

The role (field, field total, grand total) of the cell for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconditionalformattingscope.html#cfn-quicksight-template-pivottableconditionalformattingscope-role

PivotTableConfigurationProperty

class CfnTemplatePropsMixin.PivotTableConfigurationProperty(*, field_options=None, field_wells=None, interactions=None, paginated_report_options=None, sort_configuration=None, table_options=None, total_options=None)

Bases: object

The configuration for a PivotTableVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
field_options

The field options for a pivot table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-fieldoptions

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-interactions

paginated_report_options

The paginated report options for a pivot table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-paginatedreportoptions

sort_configuration

The sort configuration for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-sortconfiguration

table_options

The table options for a pivot table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-tableoptions

total_options

The total options for a pivot table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableconfiguration.html#cfn-quicksight-template-pivottableconfiguration-totaloptions

PivotTableDataPathOptionProperty

class CfnTemplatePropsMixin.PivotTableDataPathOptionProperty(*, data_path_list=None, width=None)

Bases: object

The data path options for the pivot table field options.

Parameters:

  • data_path_list (Union[IResolvable, Sequence[Union[IResolvable, DataPathValueProperty, Dict[str, Any]]], None]) – The list of data path values for the data path options.

  • width (Optional[str]) – The width of the data path option.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabledatapathoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_data_path_option_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableDataPathOptionProperty(
    data_path_list=[quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
        data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
            pivot_table_data_path_type="pivotTableDataPathType"
        ),
        field_id="fieldId",
        field_value="fieldValue"
    )],
    width="width"
)

Attributes

data_path_list

The list of data path values for the data path options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabledatapathoption.html#cfn-quicksight-template-pivottabledatapathoption-datapathlist

width

The width of the data path option.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabledatapathoption.html#cfn-quicksight-template-pivottabledatapathoption-width

PivotTableFieldCollapseStateOptionProperty

class CfnTemplatePropsMixin.PivotTableFieldCollapseStateOptionProperty(*, state=None, target=None)

Bases: object

The collapse state options for the pivot table field options.

Parameters:

  • state (Optional[str]) – The state of the field target of a pivot table. Choose one of the following options:. - COLLAPSED - EXPANDED

  • target (Union[IResolvable, PivotTableFieldCollapseStateTargetProperty, Dict[str, Any], None]) – A tagged-union object that sets the collapse state.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestateoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_field_collapse_state_option_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableFieldCollapseStateOptionProperty(
    state="state",
    target=quicksight_mixins.CfnTemplatePropsMixin.PivotTableFieldCollapseStateTargetProperty(
        field_data_path_values=[quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
            data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
                pivot_table_data_path_type="pivotTableDataPathType"
            ),
            field_id="fieldId",
            field_value="fieldValue"
        )],
        field_id="fieldId"
    )
)

Attributes

state

.

  • COLLAPSED

  • EXPANDED

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestateoption.html#cfn-quicksight-template-pivottablefieldcollapsestateoption-state

Type:

The state of the field target of a pivot table. Choose one of the following options

target

A tagged-union object that sets the collapse state.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestateoption.html#cfn-quicksight-template-pivottablefieldcollapsestateoption-target

PivotTableFieldCollapseStateTargetProperty

class CfnTemplatePropsMixin.PivotTableFieldCollapseStateTargetProperty(*, field_data_path_values=None, field_id=None)

Bases: object

The target of a pivot table field collapse state.

Parameters:

  • field_data_path_values (Union[IResolvable, Sequence[Union[IResolvable, DataPathValueProperty, Dict[str, Any]]], None]) – The data path of the pivot table’s header. Used to set the collapse state.

  • field_id (Optional[str]) – The field ID of the pivot table that the collapse state needs to be set to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestatetarget.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_field_collapse_state_target_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableFieldCollapseStateTargetProperty(
    field_data_path_values=[quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
        data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
            pivot_table_data_path_type="pivotTableDataPathType"
        ),
        field_id="fieldId",
        field_value="fieldValue"
    )],
    field_id="fieldId"
)

Attributes

field_data_path_values

The data path of the pivot table’s header.

Used to set the collapse state.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestatetarget.html#cfn-quicksight-template-pivottablefieldcollapsestatetarget-fielddatapathvalues

field_id

The field ID of the pivot table that the collapse state needs to be set to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldcollapsestatetarget.html#cfn-quicksight-template-pivottablefieldcollapsestatetarget-fieldid

PivotTableFieldOptionProperty

class CfnTemplatePropsMixin.PivotTableFieldOptionProperty(*, custom_label=None, field_id=None, visibility=None)

Bases: object

The selected field options for the pivot table field options.

Parameters:

  • custom_label (Optional[str]) – The custom label of the pivot table field.

  • field_id (Optional[str]) – The field ID of the pivot table field.

  • visibility (Optional[str]) – The visibility of the pivot table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_field_option_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableFieldOptionProperty(
    custom_label="customLabel",
    field_id="fieldId",
    visibility="visibility"
)

Attributes

custom_label

The custom label of the pivot table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoption.html#cfn-quicksight-template-pivottablefieldoption-customlabel

field_id

The field ID of the pivot table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoption.html#cfn-quicksight-template-pivottablefieldoption-fieldid

visibility

The visibility of the pivot table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoption.html#cfn-quicksight-template-pivottablefieldoption-visibility

PivotTableFieldOptionsProperty

class CfnTemplatePropsMixin.PivotTableFieldOptionsProperty(*, collapse_state_options=None, data_path_options=None, selected_field_options=None)

Bases: object

The field options for a pivot table visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_field_options_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableFieldOptionsProperty(
    collapse_state_options=[quicksight_mixins.CfnTemplatePropsMixin.PivotTableFieldCollapseStateOptionProperty(
        state="state",
        target=quicksight_mixins.CfnTemplatePropsMixin.PivotTableFieldCollapseStateTargetProperty(
            field_data_path_values=[quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
                data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
                    pivot_table_data_path_type="pivotTableDataPathType"
                ),
                field_id="fieldId",
                field_value="fieldValue"
            )],
            field_id="fieldId"
        )
    )],
    data_path_options=[quicksight_mixins.CfnTemplatePropsMixin.PivotTableDataPathOptionProperty(
        data_path_list=[quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
            data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
                pivot_table_data_path_type="pivotTableDataPathType"
            ),
            field_id="fieldId",
            field_value="fieldValue"
        )],
        width="width"
    )],
    selected_field_options=[quicksight_mixins.CfnTemplatePropsMixin.PivotTableFieldOptionProperty(
        custom_label="customLabel",
        field_id="fieldId",
        visibility="visibility"
    )]
)

Attributes

collapse_state_options

The collapse state options for the pivot table field options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html#cfn-quicksight-template-pivottablefieldoptions-collapsestateoptions

data_path_options

The data path options for the pivot table field options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html#cfn-quicksight-template-pivottablefieldoptions-datapathoptions

selected_field_options

The selected field options for the pivot table field options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldoptions.html#cfn-quicksight-template-pivottablefieldoptions-selectedfieldoptions

PivotTableFieldSubtotalOptionsProperty

class CfnTemplatePropsMixin.PivotTableFieldSubtotalOptionsProperty(*, field_id=None)

Bases: object

The optional configuration of subtotals cells.

Parameters:

field_id (Optional[str]) – The field ID of the subtotal options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldsubtotaloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_field_subtotal_options_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableFieldSubtotalOptionsProperty(
    field_id="fieldId"
)

Attributes

field_id

The field ID of the subtotal options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldsubtotaloptions.html#cfn-quicksight-template-pivottablefieldsubtotaloptions-fieldid

PivotTableFieldWellsProperty

class CfnTemplatePropsMixin.PivotTableFieldWellsProperty(*, pivot_table_aggregated_field_wells=None)

Bases: object

The field wells for a pivot table visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

pivot_table_aggregated_field_wells (Union[IResolvable, PivotTableAggregatedFieldWellsProperty, Dict[str, Any], None]) – The aggregated field well for the pivot table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
pivot_table_aggregated_field_wells

The aggregated field well for the pivot table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablefieldwells.html#cfn-quicksight-template-pivottablefieldwells-pivottableaggregatedfieldwells

PivotTableOptionsProperty

class CfnTemplatePropsMixin.PivotTableOptionsProperty(*, cell_style=None, collapsed_row_dimensions_visibility=None, column_header_style=None, column_names_visibility=None, default_cell_width=None, metric_placement=None, row_alternate_color_options=None, row_field_names_style=None, row_header_style=None, rows_label_options=None, rows_layout=None, single_metric_visibility=None, toggle_buttons_visibility=None)

Bases: object

The table options for a pivot table visual.

Parameters:

  • cell_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – The table cell style of cells.

  • collapsed_row_dimensions_visibility (Optional[str]) – The visibility setting of a pivot table’s collapsed row dimension fields. If the value of this structure is HIDDEN , all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE .

  • column_header_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – The table cell style of the column header.

  • column_names_visibility (Optional[str]) – The visibility of the column names.

  • default_cell_width (Optional[str]) – The default cell width of the pivot table.

  • metric_placement (Optional[str]) – The metric placement (row, column) options.

  • row_alternate_color_options (Union[IResolvable, RowAlternateColorOptionsProperty, Dict[str, Any], None]) – The row alternate color options (widget status, row alternate colors).

  • row_field_names_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – The table cell style of row field names.

  • row_header_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – The table cell style of the row headers.

  • rows_label_options (Union[IResolvable, PivotTableRowsLabelOptionsProperty, Dict[str, Any], None]) – The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY .

  • rows_layout (Optional[str]) – The layout for the row dimension headers of a pivot table. Choose one of the following options. - TABULAR : (Default) Each row field is displayed in a separate column. - HIERARCHY : All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.

  • single_metric_visibility (Optional[str]) – The visibility of the single metric options.

  • toggle_buttons_visibility (Optional[str]) – Determines the visibility of the pivot table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_options_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableOptionsProperty(
    cell_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    collapsed_row_dimensions_visibility="collapsedRowDimensionsVisibility",
    column_header_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    column_names_visibility="columnNamesVisibility",
    default_cell_width="defaultCellWidth",
    metric_placement="metricPlacement",
    row_alternate_color_options=quicksight_mixins.CfnTemplatePropsMixin.RowAlternateColorOptionsProperty(
        row_alternate_colors=["rowAlternateColors"],
        status="status",
        use_primary_background_color="usePrimaryBackgroundColor"
    ),
    row_field_names_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    row_header_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    rows_label_options=quicksight_mixins.CfnTemplatePropsMixin.PivotTableRowsLabelOptionsProperty(
        custom_label="customLabel",
        visibility="visibility"
    ),
    rows_layout="rowsLayout",
    single_metric_visibility="singleMetricVisibility",
    toggle_buttons_visibility="toggleButtonsVisibility"
)

Attributes

cell_style

The table cell style of cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-cellstyle

collapsed_row_dimensions_visibility

The visibility setting of a pivot table’s collapsed row dimension fields.

If the value of this structure is HIDDEN , all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-collapsedrowdimensionsvisibility

column_header_style

The table cell style of the column header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-columnheaderstyle

column_names_visibility

The visibility of the column names.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-columnnamesvisibility

default_cell_width

The default cell width of the pivot table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-defaultcellwidth

metric_placement

The metric placement (row, column) options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-metricplacement

row_alternate_color_options

The row alternate color options (widget status, row alternate colors).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowalternatecoloroptions

row_field_names_style

The table cell style of row field names.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowfieldnamesstyle

row_header_style

The table cell style of the row headers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowheaderstyle

rows_label_options

The options for the label that is located above the row headers.

This option is only applicable when RowsLayout is set to HIERARCHY .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowslabeloptions

rows_layout

The layout for the row dimension headers of a pivot table. Choose one of the following options.

  • TABULAR : (Default) Each row field is displayed in a separate column.

  • HIERARCHY : All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-rowslayout

single_metric_visibility

The visibility of the single metric options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-singlemetricvisibility

toggle_buttons_visibility

Determines the visibility of the pivot table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottableoptions.html#cfn-quicksight-template-pivottableoptions-togglebuttonsvisibility

PivotTablePaginatedReportOptionsProperty

class CfnTemplatePropsMixin.PivotTablePaginatedReportOptionsProperty(*, overflow_column_header_visibility=None, vertical_overflow_visibility=None)

Bases: object

The paginated report options for a pivot table visual.

Parameters:

  • overflow_column_header_visibility (Optional[str]) – The visibility of the repeating header rows on each page.

  • vertical_overflow_visibility (Optional[str]) – The visibility of the printing table overflow across pages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablepaginatedreportoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_paginated_report_options_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTablePaginatedReportOptionsProperty(
    overflow_column_header_visibility="overflowColumnHeaderVisibility",
    vertical_overflow_visibility="verticalOverflowVisibility"
)

Attributes

overflow_column_header_visibility

The visibility of the repeating header rows on each page.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablepaginatedreportoptions.html#cfn-quicksight-template-pivottablepaginatedreportoptions-overflowcolumnheadervisibility

vertical_overflow_visibility

The visibility of the printing table overflow across pages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablepaginatedreportoptions.html#cfn-quicksight-template-pivottablepaginatedreportoptions-verticaloverflowvisibility

PivotTableRowsLabelOptionsProperty

class CfnTemplatePropsMixin.PivotTableRowsLabelOptionsProperty(*, custom_label=None, visibility=None)

Bases: object

The options for the label thta is located above the row headers.

This option is only applicable when RowsLayout is set to HIERARCHY .

Parameters:

  • custom_label (Optional[str]) – The custom label string for the rows label.

  • visibility (Optional[str]) – The visibility of the rows label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablerowslabeloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_rows_label_options_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableRowsLabelOptionsProperty(
    custom_label="customLabel",
    visibility="visibility"
)

Attributes

custom_label

The custom label string for the rows label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablerowslabeloptions.html#cfn-quicksight-template-pivottablerowslabeloptions-customlabel

visibility

The visibility of the rows label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablerowslabeloptions.html#cfn-quicksight-template-pivottablerowslabeloptions-visibility

PivotTableSortByProperty

class CfnTemplatePropsMixin.PivotTableSortByProperty(*, column=None, data_path=None, field=None)

Bases: object

The sort by field for the field sort options.

Parameters:

  • column (Union[IResolvable, ColumnSortProperty, Dict[str, Any], None]) – The column sort (field id, direction) for the pivot table sort by options.

  • data_path (Union[IResolvable, DataPathSortProperty, Dict[str, Any], None]) – The data path sort (data path value, direction) for the pivot table sort by options.

  • field (Union[IResolvable, FieldSortProperty, Dict[str, Any], None]) – The field sort (field id, direction) for the pivot table sort by options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortby.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_sort_by_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableSortByProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
        aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        ),
        direction="direction",
        sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    ),
    data_path=quicksight_mixins.CfnTemplatePropsMixin.DataPathSortProperty(
        direction="direction",
        sort_paths=[quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
            data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
                pivot_table_data_path_type="pivotTableDataPathType"
            ),
            field_id="fieldId",
            field_value="fieldValue"
        )]
    ),
    field=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
        direction="direction",
        field_id="fieldId"
    )
)

Attributes

column

The column sort (field id, direction) for the pivot table sort by options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortby.html#cfn-quicksight-template-pivottablesortby-column

data_path

The data path sort (data path value, direction) for the pivot table sort by options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortby.html#cfn-quicksight-template-pivottablesortby-datapath

field

The field sort (field id, direction) for the pivot table sort by options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortby.html#cfn-quicksight-template-pivottablesortby-field

PivotTableSortConfigurationProperty

class CfnTemplatePropsMixin.PivotTableSortConfigurationProperty(*, field_sort_options=None)

Bases: object

The sort configuration for a PivotTableVisual .

Parameters:

field_sort_options (Union[IResolvable, Sequence[Union[IResolvable, PivotFieldSortOptionsProperty, Dict[str, Any]]], None]) – The field sort options for a pivot table sort configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_table_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTableSortConfigurationProperty(
    field_sort_options=[quicksight_mixins.CfnTemplatePropsMixin.PivotFieldSortOptionsProperty(
        field_id="fieldId",
        sort_by=quicksight_mixins.CfnTemplatePropsMixin.PivotTableSortByProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                    attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                        simple_attribute_aggregation="simpleAttributeAggregation",
                        value_for_multiple_values="valueForMultipleValues"
                    ),
                    categorical_aggregation_function="categoricalAggregationFunction",
                    date_aggregation_function="dateAggregationFunction",
                    numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                        percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                            percentile_value=123
                        ),
                        simple_numerical_aggregation="simpleNumericalAggregation"
                    )
                ),
                direction="direction",
                sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            data_path=quicksight_mixins.CfnTemplatePropsMixin.DataPathSortProperty(
                direction="direction",
                sort_paths=[quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
                    data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
                        pivot_table_data_path_type="pivotTableDataPathType"
                    ),
                    field_id="fieldId",
                    field_value="fieldValue"
                )]
            ),
            field=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
                direction="direction",
                field_id="fieldId"
            )
        )
    )]
)

Attributes

field_sort_options

The field sort options for a pivot table sort configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablesortconfiguration.html#cfn-quicksight-template-pivottablesortconfiguration-fieldsortoptions

PivotTableTotalOptionsProperty

class CfnTemplatePropsMixin.PivotTableTotalOptionsProperty(*, column_subtotal_options=None, column_total_options=None, row_subtotal_options=None, row_total_options=None)

Bases: object

The total options for a pivot table visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabletotaloptions.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
column_subtotal_options

The column subtotal options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabletotaloptions.html#cfn-quicksight-template-pivottabletotaloptions-columnsubtotaloptions

column_total_options

The column total options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabletotaloptions.html#cfn-quicksight-template-pivottabletotaloptions-columntotaloptions

row_subtotal_options

The row subtotal options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabletotaloptions.html#cfn-quicksight-template-pivottabletotaloptions-rowsubtotaloptions

row_total_options

The row total options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottabletotaloptions.html#cfn-quicksight-template-pivottabletotaloptions-rowtotaloptions

PivotTableVisualProperty

class CfnTemplatePropsMixin.PivotTableVisualProperty(*, actions=None, chart_configuration=None, conditional_formatting=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A pivot table.

For more information, see Using pivot tables in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-chartconfiguration

conditional_formatting

The conditional formatting for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-conditionalformatting

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottablevisual.html#cfn-quicksight-template-pivottablevisual-visualid

PivotTotalOptionsProperty

class CfnTemplatePropsMixin.PivotTotalOptionsProperty(*, custom_label=None, metric_header_cell_style=None, placement=None, scroll_status=None, total_aggregation_options=None, total_cell_style=None, totals_visibility=None, value_cell_style=None)

Bases: object

The optional configuration of totals cells in a PivotTableVisual .

Parameters:

  • custom_label (Optional[str]) – The custom label string for the total cells.

  • metric_header_cell_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – The cell styling options for the total of header cells.

  • placement (Optional[str]) – The placement (start, end) for the total cells.

  • scroll_status (Optional[str]) – The scroll status (pinned, scrolled) for the total cells.

  • total_aggregation_options (Union[IResolvable, Sequence[Union[IResolvable, TotalAggregationOptionProperty, Dict[str, Any]]], None]) – The total aggregation options for each value field.

  • total_cell_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – The cell styling options for the total cells.

  • totals_visibility (Optional[str]) – The visibility configuration for the total cells.

  • value_cell_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – The cell styling options for the totals of value cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

pivot_total_options_property = quicksight_mixins.CfnTemplatePropsMixin.PivotTotalOptionsProperty(
    custom_label="customLabel",
    metric_header_cell_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    placement="placement",
    scroll_status="scrollStatus",
    total_aggregation_options=[quicksight_mixins.CfnTemplatePropsMixin.TotalAggregationOptionProperty(
        field_id="fieldId",
        total_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.TotalAggregationFunctionProperty(
            simple_total_aggregation_function="simpleTotalAggregationFunction"
        )
    )],
    total_cell_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    totals_visibility="totalsVisibility",
    value_cell_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    )
)

Attributes

custom_label

The custom label string for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-customlabel

metric_header_cell_style

The cell styling options for the total of header cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-metricheadercellstyle

placement

The placement (start, end) for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-placement

scroll_status

The scroll status (pinned, scrolled) for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-scrollstatus

total_aggregation_options

The total aggregation options for each value field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-totalaggregationoptions

total_cell_style

The cell styling options for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-totalcellstyle

totals_visibility

The visibility configuration for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-totalsvisibility

value_cell_style

The cell styling options for the totals of value cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pivottotaloptions.html#cfn-quicksight-template-pivottotaloptions-valuecellstyle

PluginVisualConfigurationProperty

class CfnTemplatePropsMixin.PluginVisualConfigurationProperty(*, field_wells=None, sort_configuration=None, visual_options=None)

Bases: object

The plugin visual configuration.

This includes the field wells, sorting options, and persisted options of the plugin visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
field_wells

The field wells configuration of the plugin visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualconfiguration.html#cfn-quicksight-template-pluginvisualconfiguration-fieldwells

sort_configuration

The sort configuration of the plugin visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualconfiguration.html#cfn-quicksight-template-pluginvisualconfiguration-sortconfiguration

visual_options

The persisted properties of the plugin visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualconfiguration.html#cfn-quicksight-template-pluginvisualconfiguration-visualoptions

PluginVisualFieldWellProperty

class CfnTemplatePropsMixin.PluginVisualFieldWellProperty(*, axis_name=None, dimensions=None, measures=None, unaggregated=None)

Bases: object

A collection of field wells for a plugin visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualfieldwell.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
axis_name

The semantic axis name for the field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualfieldwell.html#cfn-quicksight-template-pluginvisualfieldwell-axisname

dimensions

A list of dimensions for the field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualfieldwell.html#cfn-quicksight-template-pluginvisualfieldwell-dimensions

measures

A list of measures that exist in the field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualfieldwell.html#cfn-quicksight-template-pluginvisualfieldwell-measures

unaggregated

A list of unaggregated fields that exist in the field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualfieldwell.html#cfn-quicksight-template-pluginvisualfieldwell-unaggregated

PluginVisualItemsLimitConfigurationProperty

class CfnTemplatePropsMixin.PluginVisualItemsLimitConfigurationProperty(*, items_limit=None)

Bases: object

A query limits configuration.

Parameters:

items_limit (Union[int, float, None]) – Determines how many values are be fetched at once.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualitemslimitconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

plugin_visual_items_limit_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.PluginVisualItemsLimitConfigurationProperty(
    items_limit=123
)

Attributes

items_limit

Determines how many values are be fetched at once.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualitemslimitconfiguration.html#cfn-quicksight-template-pluginvisualitemslimitconfiguration-itemslimit

PluginVisualOptionsProperty

class CfnTemplatePropsMixin.PluginVisualOptionsProperty(*, visual_properties=None)

Bases: object

The options and persisted properties for the plugin visual.

Parameters:

visual_properties (Union[IResolvable, Sequence[Union[IResolvable, PluginVisualPropertyProperty, Dict[str, Any]]], None]) – The persisted properties and their values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

plugin_visual_options_property = quicksight_mixins.CfnTemplatePropsMixin.PluginVisualOptionsProperty(
    visual_properties=[quicksight_mixins.CfnTemplatePropsMixin.PluginVisualPropertyProperty(
        name="name",
        value="value"
    )]
)

Attributes

visual_properties

The persisted properties and their values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualoptions.html#cfn-quicksight-template-pluginvisualoptions-visualproperties

PluginVisualProperty

class CfnTemplatePropsMixin.PluginVisualProperty(*, chart_configuration=None, plugin_arn=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A flexible visualization type that allows engineers to create new custom charts in Quick Sight.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
chart_configuration

A description of the plugin field wells and their persisted properties.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-chartconfiguration

plugin_arn

The Amazon Resource Name (ARN) that reflects the plugin and version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-pluginarn

subtitle

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-subtitle

Type:

see

title

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-title

Type:

see

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-visualcontentalttext

visual_id

The ID of the visual that you want to use.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisual.html#cfn-quicksight-template-pluginvisual-visualid

PluginVisualPropertyProperty

class CfnTemplatePropsMixin.PluginVisualPropertyProperty(*, name=None, value=None)

Bases: object

The key value pair of the persisted property.

Parameters:

  • name (Optional[str]) – The name of the plugin visual property.

  • value (Optional[str]) – The value of the plugin visual property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualproperty.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

plugin_visual_property_property = quicksight_mixins.CfnTemplatePropsMixin.PluginVisualPropertyProperty(
    name="name",
    value="value"
)

Attributes

name

The name of the plugin visual property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualproperty.html#cfn-quicksight-template-pluginvisualproperty-name

value

The value of the plugin visual property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualproperty.html#cfn-quicksight-template-pluginvisualproperty-value

PluginVisualSortConfigurationProperty

class CfnTemplatePropsMixin.PluginVisualSortConfigurationProperty(*, plugin_visual_table_query_sort=None)

Bases: object

Determines how the plugin visual sorts the data during query.

Parameters:

plugin_visual_table_query_sort (Union[IResolvable, PluginVisualTableQuerySortProperty, Dict[str, Any], None]) – The table query sorting options for the plugin visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

plugin_visual_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.PluginVisualSortConfigurationProperty(
    plugin_visual_table_query_sort=quicksight_mixins.CfnTemplatePropsMixin.PluginVisualTableQuerySortProperty(
        items_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.PluginVisualItemsLimitConfigurationProperty(
            items_limit=123
        ),
        row_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
            column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                    attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                        simple_attribute_aggregation="simpleAttributeAggregation",
                        value_for_multiple_values="valueForMultipleValues"
                    ),
                    categorical_aggregation_function="categoricalAggregationFunction",
                    date_aggregation_function="dateAggregationFunction",
                    numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                        percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                            percentile_value=123
                        ),
                        simple_numerical_aggregation="simpleNumericalAggregation"
                    )
                ),
                direction="direction",
                sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
                direction="direction",
                field_id="fieldId"
            )
        )]
    )
)

Attributes

plugin_visual_table_query_sort

The table query sorting options for the plugin visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualsortconfiguration.html#cfn-quicksight-template-pluginvisualsortconfiguration-pluginvisualtablequerysort

PluginVisualTableQuerySortProperty

class CfnTemplatePropsMixin.PluginVisualTableQuerySortProperty(*, items_limit_configuration=None, row_sort=None)

Bases: object

The table query sorting options for the plugin visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualtablequerysort.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

plugin_visual_table_query_sort_property = quicksight_mixins.CfnTemplatePropsMixin.PluginVisualTableQuerySortProperty(
    items_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.PluginVisualItemsLimitConfigurationProperty(
        items_limit=123
    ),
    row_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

items_limit_configuration

The maximum amount of data to be returned by a query.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualtablequerysort.html#cfn-quicksight-template-pluginvisualtablequerysort-itemslimitconfiguration

row_sort

Determines how data is sorted in the response.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-pluginvisualtablequerysort.html#cfn-quicksight-template-pluginvisualtablequerysort-rowsort

PredefinedHierarchyProperty

class CfnTemplatePropsMixin.PredefinedHierarchyProperty(*, columns=None, drill_down_filters=None, hierarchy_id=None)

Bases: object

The option that determines the hierarchy of the fields that are defined during data preparation.

These fields are available to use in any analysis that uses the data source.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-predefinedhierarchy.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

predefined_hierarchy_property = quicksight_mixins.CfnTemplatePropsMixin.PredefinedHierarchyProperty(
    columns=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    )],
    drill_down_filters=[quicksight_mixins.CfnTemplatePropsMixin.DrillDownFilterProperty(
        category_filter=quicksight_mixins.CfnTemplatePropsMixin.CategoryDrillDownFilterProperty(
            category_values=["categoryValues"],
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        numeric_equality_filter=quicksight_mixins.CfnTemplatePropsMixin.NumericEqualityDrillDownFilterProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            value=123
        ),
        time_range_filter=quicksight_mixins.CfnTemplatePropsMixin.TimeRangeDrillDownFilterProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            range_maximum="rangeMaximum",
            range_minimum="rangeMinimum",
            time_granularity="timeGranularity"
        )
    )],
    hierarchy_id="hierarchyId"
)

Attributes

columns

The list of columns that define the predefined hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-predefinedhierarchy.html#cfn-quicksight-template-predefinedhierarchy-columns

drill_down_filters

The option that determines the drill down filters for the predefined hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-predefinedhierarchy.html#cfn-quicksight-template-predefinedhierarchy-drilldownfilters

hierarchy_id

The hierarchy ID of the predefined hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-predefinedhierarchy.html#cfn-quicksight-template-predefinedhierarchy-hierarchyid

ProgressBarOptionsProperty

class CfnTemplatePropsMixin.ProgressBarOptionsProperty(*, visibility=None)

Bases: object

The options that determine the presentation of the progress bar of a KPI visual.

Parameters:

visibility (Optional[str]) – The visibility of the progress bar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-progressbaroptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

progress_bar_options_property = quicksight_mixins.CfnTemplatePropsMixin.ProgressBarOptionsProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility of the progress bar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-progressbaroptions.html#cfn-quicksight-template-progressbaroptions-visibility

QueryExecutionOptionsProperty

class CfnTemplatePropsMixin.QueryExecutionOptionsProperty(*, query_execution_mode=None)

Bases: object

A structure that describes the query execution options.

Parameters:

query_execution_mode (Optional[str]) – A structure that describes the query execution mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-queryexecutionoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

query_execution_options_property = quicksight_mixins.CfnTemplatePropsMixin.QueryExecutionOptionsProperty(
    query_execution_mode="queryExecutionMode"
)

Attributes

query_execution_mode

A structure that describes the query execution mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-queryexecutionoptions.html#cfn-quicksight-template-queryexecutionoptions-queryexecutionmode

RadarChartAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.RadarChartAggregatedFieldWellsProperty(*, category=None, color=None, values=None)

Bases: object

The aggregated field well configuration of a RadarChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category

The aggregated field well categories of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartaggregatedfieldwells.html#cfn-quicksight-template-radarchartaggregatedfieldwells-category

color

The color that are assigned to the aggregated field wells of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartaggregatedfieldwells.html#cfn-quicksight-template-radarchartaggregatedfieldwells-color

values

The values that are assigned to the aggregated field wells of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartaggregatedfieldwells.html#cfn-quicksight-template-radarchartaggregatedfieldwells-values

RadarChartAreaStyleSettingsProperty

class CfnTemplatePropsMixin.RadarChartAreaStyleSettingsProperty(*, visibility=None)

Bases: object

The configured style settings of a radar chart.

Parameters:

visibility (Optional[str]) – The visibility settings of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartareastylesettings.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

radar_chart_area_style_settings_property = quicksight_mixins.CfnTemplatePropsMixin.RadarChartAreaStyleSettingsProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility settings of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartareastylesettings.html#cfn-quicksight-template-radarchartareastylesettings-visibility

RadarChartConfigurationProperty

class CfnTemplatePropsMixin.RadarChartConfigurationProperty(*, alternate_band_colors_visibility=None, alternate_band_even_color=None, alternate_band_odd_color=None, axes_range_scale=None, base_series_settings=None, category_axis=None, category_label_options=None, color_axis=None, color_label_options=None, field_wells=None, interactions=None, legend=None, shape=None, sort_configuration=None, start_angle=None, visual_palette=None)

Bases: object

The configuration of a RadarChartVisual .

Parameters:

  • alternate_band_colors_visibility (Optional[str]) – Determines the visibility of the colors of alternatign bands in a radar chart.

  • alternate_band_even_color (Optional[str]) – The color of the even-numbered alternate bands of a radar chart.

  • alternate_band_odd_color (Optional[str]) – The color of the odd-numbered alternate bands of a radar chart.

  • axes_range_scale (Optional[str]) – The axis behavior options of a radar chart.

  • base_series_settings (Union[IResolvable, RadarChartSeriesSettingsProperty, Dict[str, Any], None]) – The base sreies settings of a radar chart.

  • category_axis (Union[IResolvable, AxisDisplayOptionsProperty, Dict[str, Any], None]) – The category axis of a radar chart.

  • category_label_options (Union[IResolvable, ChartAxisLabelOptionsProperty, Dict[str, Any], None]) – The category label options of a radar chart.

  • color_axis (Union[IResolvable, AxisDisplayOptionsProperty, Dict[str, Any], None]) – The color axis of a radar chart.

  • color_label_options (Union[IResolvable, ChartAxisLabelOptionsProperty, Dict[str, Any], None]) – The color label options of a radar chart.

  • field_wells (Union[IResolvable, RadarChartFieldWellsProperty, Dict[str, Any], None]) – The field well configuration of a RadarChartVisual .

  • interactions (Union[IResolvable, VisualInteractionOptionsProperty, Dict[str, Any], None]) – The general visual interactions setup for a visual.

  • legend (Union[IResolvable, LegendOptionsProperty, Dict[str, Any], None]) – The legend display setup of the visual.

  • shape (Optional[str]) – The shape of the radar chart.

  • sort_configuration (Union[IResolvable, RadarChartSortConfigurationProperty, Dict[str, Any], None]) – The sort configuration of a RadarChartVisual .

  • start_angle (Union[int, float, None]) – The start angle of a radar chart’s axis.

  • visual_palette (Union[IResolvable, VisualPaletteProperty, Dict[str, Any], None]) – The palette (chart color) display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
alternate_band_colors_visibility

Determines the visibility of the colors of alternatign bands in a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-alternatebandcolorsvisibility

alternate_band_even_color

The color of the even-numbered alternate bands of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-alternatebandevencolor

alternate_band_odd_color

The color of the odd-numbered alternate bands of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-alternatebandoddcolor

axes_range_scale

The axis behavior options of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-axesrangescale

base_series_settings

The base sreies settings of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-baseseriessettings

category_axis

The category axis of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-categoryaxis

category_label_options

The category label options of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-categorylabeloptions

color_axis

The color axis of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-coloraxis

color_label_options

The color label options of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-colorlabeloptions

field_wells

The field well configuration of a RadarChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-interactions

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-legend

shape

The shape of the radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-shape

sort_configuration

The sort configuration of a RadarChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-sortconfiguration

start_angle

The start angle of a radar chart’s axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-startangle

visual_palette

The palette (chart color) display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartconfiguration.html#cfn-quicksight-template-radarchartconfiguration-visualpalette

RadarChartFieldWellsProperty

class CfnTemplatePropsMixin.RadarChartFieldWellsProperty(*, radar_chart_aggregated_field_wells=None)

Bases: object

The field wells of a radar chart visual.

Parameters:

radar_chart_aggregated_field_wells (Union[IResolvable, RadarChartAggregatedFieldWellsProperty, Dict[str, Any], None]) – The aggregated field wells of a radar chart visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
radar_chart_aggregated_field_wells

The aggregated field wells of a radar chart visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartfieldwells.html#cfn-quicksight-template-radarchartfieldwells-radarchartaggregatedfieldwells

RadarChartSeriesSettingsProperty

class CfnTemplatePropsMixin.RadarChartSeriesSettingsProperty(*, area_style_settings=None)

Bases: object

The series settings of a radar chart.

Parameters:

area_style_settings (Union[IResolvable, RadarChartAreaStyleSettingsProperty, Dict[str, Any], None]) – The area style settings of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartseriessettings.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

radar_chart_series_settings_property = quicksight_mixins.CfnTemplatePropsMixin.RadarChartSeriesSettingsProperty(
    area_style_settings=quicksight_mixins.CfnTemplatePropsMixin.RadarChartAreaStyleSettingsProperty(
        visibility="visibility"
    )
)

Attributes

area_style_settings

The area style settings of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartseriessettings.html#cfn-quicksight-template-radarchartseriessettings-areastylesettings

RadarChartSortConfigurationProperty

class CfnTemplatePropsMixin.RadarChartSortConfigurationProperty(*, category_items_limit=None, category_sort=None, color_items_limit=None, color_sort=None)

Bases: object

The sort configuration of a RadarChartVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

radar_chart_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.RadarChartSortConfigurationProperty(
    category_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    color_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    color_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

category_items_limit

The category items limit for a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartsortconfiguration.html#cfn-quicksight-template-radarchartsortconfiguration-categoryitemslimit

category_sort

The category sort options of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartsortconfiguration.html#cfn-quicksight-template-radarchartsortconfiguration-categorysort

color_items_limit

The color items limit of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartsortconfiguration.html#cfn-quicksight-template-radarchartsortconfiguration-coloritemslimit

color_sort

The color sort configuration of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartsortconfiguration.html#cfn-quicksight-template-radarchartsortconfiguration-colorsort

RadarChartVisualProperty

class CfnTemplatePropsMixin.RadarChartVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A radar chart visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-radarchartvisual.html#cfn-quicksight-template-radarchartvisual-visualid

RangeEndsLabelTypeProperty

class CfnTemplatePropsMixin.RangeEndsLabelTypeProperty(*, visibility=None)

Bases: object

The range ends label type of a data path label.

Parameters:

visibility (Optional[str]) – The visibility of the range ends label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rangeendslabeltype.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

range_ends_label_type_property = quicksight_mixins.CfnTemplatePropsMixin.RangeEndsLabelTypeProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility of the range ends label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rangeendslabeltype.html#cfn-quicksight-template-rangeendslabeltype-visibility

ReferenceLineCustomLabelConfigurationProperty

class CfnTemplatePropsMixin.ReferenceLineCustomLabelConfigurationProperty(*, custom_label=None)

Bases: object

The configuration for a custom label on a ReferenceLine .

Parameters:

custom_label (Optional[str]) – The string text of the custom label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinecustomlabelconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

reference_line_custom_label_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineCustomLabelConfigurationProperty(
    custom_label="customLabel"
)

Attributes

custom_label

The string text of the custom label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinecustomlabelconfiguration.html#cfn-quicksight-template-referencelinecustomlabelconfiguration-customlabel

ReferenceLineDataConfigurationProperty

class CfnTemplatePropsMixin.ReferenceLineDataConfigurationProperty(*, axis_binding=None, dynamic_configuration=None, series_type=None, static_configuration=None)

Bases: object

The data configuration of the reference line.

Parameters:

  • axis_binding (Optional[str]) – The axis binding type of the reference line. Choose one of the following options:. - PrimaryY - SecondaryY

  • dynamic_configuration (Union[IResolvable, ReferenceLineDynamicDataConfigurationProperty, Dict[str, Any], None]) – The dynamic configuration of the reference line data configuration.

  • series_type (Optional[str]) – The series type of the reference line data configuration. Choose one of the following options:. - BAR - LINE

  • static_configuration (Union[IResolvable, ReferenceLineStaticDataConfigurationProperty, Dict[str, Any], None]) – The static data configuration of the reference line data configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedataconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

reference_line_data_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineDataConfigurationProperty(
    axis_binding="axisBinding",
    dynamic_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineDynamicDataConfigurationProperty(
        calculation=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        ),
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        measure_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        )
    ),
    series_type="seriesType",
    static_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineStaticDataConfigurationProperty(
        value=123
    )
)

Attributes

axis_binding

.

  • PrimaryY

  • SecondaryY

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedataconfiguration.html#cfn-quicksight-template-referencelinedataconfiguration-axisbinding

Type:

The axis binding type of the reference line. Choose one of the following options

dynamic_configuration

The dynamic configuration of the reference line data configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedataconfiguration.html#cfn-quicksight-template-referencelinedataconfiguration-dynamicconfiguration

series_type

.

  • BAR

  • LINE

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedataconfiguration.html#cfn-quicksight-template-referencelinedataconfiguration-seriestype

Type:

The series type of the reference line data configuration. Choose one of the following options

static_configuration

The static data configuration of the reference line data configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedataconfiguration.html#cfn-quicksight-template-referencelinedataconfiguration-staticconfiguration

ReferenceLineDynamicDataConfigurationProperty

class CfnTemplatePropsMixin.ReferenceLineDynamicDataConfigurationProperty(*, calculation=None, column=None, measure_aggregation_function=None)

Bases: object

The dynamic configuration of the reference line data configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedynamicdataconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

reference_line_dynamic_data_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineDynamicDataConfigurationProperty(
    calculation=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
        percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
            percentile_value=123
        ),
        simple_numerical_aggregation="simpleNumericalAggregation"
    ),
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    measure_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    )
)

Attributes

calculation

The calculation that is used in the dynamic data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedynamicdataconfiguration.html#cfn-quicksight-template-referencelinedynamicdataconfiguration-calculation

column

The column that the dynamic data targets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedynamicdataconfiguration.html#cfn-quicksight-template-referencelinedynamicdataconfiguration-column

measure_aggregation_function

The aggregation function that is used in the dynamic data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinedynamicdataconfiguration.html#cfn-quicksight-template-referencelinedynamicdataconfiguration-measureaggregationfunction

ReferenceLineLabelConfigurationProperty

class CfnTemplatePropsMixin.ReferenceLineLabelConfigurationProperty(*, custom_label_configuration=None, font_color=None, font_configuration=None, horizontal_position=None, value_label_configuration=None, vertical_position=None)

Bases: object

The label configuration of a reference line.

Parameters:

  • custom_label_configuration (Union[IResolvable, ReferenceLineCustomLabelConfigurationProperty, Dict[str, Any], None]) – The custom label configuration of the label in a reference line.

  • font_color (Optional[str]) – The font color configuration of the label in a reference line.

  • font_configuration (Union[IResolvable, FontConfigurationProperty, Dict[str, Any], None]) – The font configuration of the label in a reference line.

  • horizontal_position (Optional[str]) – The horizontal position configuration of the label in a reference line. Choose one of the following options:. - LEFT - CENTER - RIGHT

  • value_label_configuration (Union[IResolvable, ReferenceLineValueLabelConfigurationProperty, Dict[str, Any], None]) – The value label configuration of the label in a reference line.

  • vertical_position (Optional[str]) – The vertical position configuration of the label in a reference line. Choose one of the following options:. - ABOVE - BELOW

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

reference_line_label_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineLabelConfigurationProperty(
    custom_label_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineCustomLabelConfigurationProperty(
        custom_label="customLabel"
    ),
    font_color="fontColor",
    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    ),
    horizontal_position="horizontalPosition",
    value_label_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineValueLabelConfigurationProperty(
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                        grouping_style="groupingStyle",
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        ),
        relative_position="relativePosition"
    ),
    vertical_position="verticalPosition"
)

Attributes

custom_label_configuration

The custom label configuration of the label in a reference line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-customlabelconfiguration

font_color

The font color configuration of the label in a reference line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-fontcolor

font_configuration

The font configuration of the label in a reference line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-fontconfiguration

horizontal_position

.

  • LEFT

  • CENTER

  • RIGHT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-horizontalposition

Type:

The horizontal position configuration of the label in a reference line. Choose one of the following options

value_label_configuration

The value label configuration of the label in a reference line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-valuelabelconfiguration

vertical_position

.

  • ABOVE

  • BELOW

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinelabelconfiguration.html#cfn-quicksight-template-referencelinelabelconfiguration-verticalposition

Type:

The vertical position configuration of the label in a reference line. Choose one of the following options

ReferenceLineProperty

class CfnTemplatePropsMixin.ReferenceLineProperty(*, data_configuration=None, label_configuration=None, status=None, style_configuration=None)

Bases: object

The reference line visual display options.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

reference_line_property = quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineProperty(
    data_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineDataConfigurationProperty(
        axis_binding="axisBinding",
        dynamic_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineDynamicDataConfigurationProperty(
            calculation=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            measure_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        series_type="seriesType",
        static_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineStaticDataConfigurationProperty(
            value=123
        )
    ),
    label_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineLabelConfigurationProperty(
        custom_label_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineCustomLabelConfigurationProperty(
            custom_label="customLabel"
        ),
        font_color="fontColor",
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        horizontal_position="horizontalPosition",
        value_label_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineValueLabelConfigurationProperty(
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            ),
            relative_position="relativePosition"
        ),
        vertical_position="verticalPosition"
    ),
    status="status",
    style_configuration=quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineStyleConfigurationProperty(
        color="color",
        pattern="pattern"
    )
)

Attributes

data_configuration

The data configuration of the reference line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-dataconfiguration

label_configuration

The label configuration of the reference line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-labelconfiguration

status

.

  • ENABLE

  • DISABLE

See:

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

Type:

The status of the reference line. Choose one of the following options

style_configuration

The style configuration of the reference line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referenceline.html#cfn-quicksight-template-referenceline-styleconfiguration

ReferenceLineStaticDataConfigurationProperty

class CfnTemplatePropsMixin.ReferenceLineStaticDataConfigurationProperty(*, value=None)

Bases: object

The static data configuration of the reference line data configuration.

Parameters:

value (Union[int, float, None]) – The double input of the static data. Default: - 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinestaticdataconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

reference_line_static_data_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineStaticDataConfigurationProperty(
    value=123
)

Attributes

value

The double input of the static data.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinestaticdataconfiguration.html#cfn-quicksight-template-referencelinestaticdataconfiguration-value

ReferenceLineStyleConfigurationProperty

class CfnTemplatePropsMixin.ReferenceLineStyleConfigurationProperty(*, color=None, pattern=None)

Bases: object

The style configuration of the reference line.

Parameters:

  • color (Optional[str]) – The hex color of the reference line.

  • pattern (Optional[str]) – The pattern type of the line style. Choose one of the following options:. - SOLID - DASHED - DOTTED

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinestyleconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

reference_line_style_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineStyleConfigurationProperty(
    color="color",
    pattern="pattern"
)

Attributes

color

The hex color of the reference line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinestyleconfiguration.html#cfn-quicksight-template-referencelinestyleconfiguration-color

pattern

.

  • SOLID

  • DASHED

  • DOTTED

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinestyleconfiguration.html#cfn-quicksight-template-referencelinestyleconfiguration-pattern

Type:

The pattern type of the line style. Choose one of the following options

ReferenceLineValueLabelConfigurationProperty

class CfnTemplatePropsMixin.ReferenceLineValueLabelConfigurationProperty(*, format_configuration=None, relative_position=None)

Bases: object

The value label configuration of the label in a reference line.

Parameters:

  • format_configuration (Union[IResolvable, NumericFormatConfigurationProperty, Dict[str, Any], None]) – The format configuration of the value label.

  • relative_position (Optional[str]) – The relative position of the value label. Choose one of the following options:. - BEFORE_CUSTOM_LABEL - AFTER_CUSTOM_LABEL

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinevaluelabelconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

reference_line_value_label_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ReferenceLineValueLabelConfigurationProperty(
    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
        currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix",
            symbol="symbol"
        ),
        number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        )
    ),
    relative_position="relativePosition"
)

Attributes

format_configuration

The format configuration of the value label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinevaluelabelconfiguration.html#cfn-quicksight-template-referencelinevaluelabelconfiguration-formatconfiguration

relative_position

.

  • BEFORE_CUSTOM_LABEL

  • AFTER_CUSTOM_LABEL

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-referencelinevaluelabelconfiguration.html#cfn-quicksight-template-referencelinevaluelabelconfiguration-relativeposition

Type:

The relative position of the value label. Choose one of the following options

RelativeDateTimeControlDisplayOptionsProperty

class CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(*, date_time_format=None, info_icon_label_options=None, title_options=None)

Bases: object

The display options of a control.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatetimecontroldisplayoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

relative_date_time_control_display_options_property = quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
    date_time_format="dateTimeFormat",
    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        visibility="visibility"
    )
)

Attributes

date_time_format

Customize how dates are formatted in controls.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatetimecontroldisplayoptions.html#cfn-quicksight-template-relativedatetimecontroldisplayoptions-datetimeformat

info_icon_label_options

The configuration of info icon label options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatetimecontroldisplayoptions.html#cfn-quicksight-template-relativedatetimecontroldisplayoptions-infoiconlabeloptions

title_options

The options to configure the title visibility, name, and font size.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatetimecontroldisplayoptions.html#cfn-quicksight-template-relativedatetimecontroldisplayoptions-titleoptions

RelativeDatesFilterProperty

class CfnTemplatePropsMixin.RelativeDatesFilterProperty(*, anchor_date_configuration=None, column=None, default_filter_control_configuration=None, exclude_period_configuration=None, filter_id=None, minimum_granularity=None, null_option=None, parameter_name=None, relative_date_type=None, relative_date_value=None, time_granularity=None)

Bases: object

A RelativeDatesFilter filters relative dates values.

Parameters:

  • anchor_date_configuration (Union[IResolvable, AnchorDateConfigurationProperty, Dict[str, Any], None]) – The date configuration of the filter.

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the filter is applied to.

  • default_filter_control_configuration (Union[IResolvable, DefaultFilterControlConfigurationProperty, Dict[str, Any], None]) – The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

  • exclude_period_configuration (Union[IResolvable, ExcludePeriodConfigurationProperty, Dict[str, Any], None]) – The configuration for the exclude period of the filter.

  • filter_id (Optional[str]) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • minimum_granularity (Optional[str]) – The minimum granularity (period granularity) of the relative dates filter.

  • null_option (Optional[str]) – This option determines how null values should be treated when filtering data. - ALL_VALUES : Include null values in filtered results. - NULLS_ONLY : Only include null values in filtered results. - NON_NULLS_ONLY : Exclude null values from filtered results.

  • parameter_name (Optional[str]) – The parameter whose value should be used for the filter value.

  • relative_date_type (Optional[str]) – The range date type of the filter. Choose one of the options below:. - PREVIOUS - THIS - LAST - NOW - NEXT

  • relative_date_value (Union[int, float, None]) – The date value of the filter.

  • time_granularity (Optional[str]) – The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

relative_dates_filter_property = quicksight_mixins.CfnTemplatePropsMixin.RelativeDatesFilterProperty(
    anchor_date_configuration=quicksight_mixins.CfnTemplatePropsMixin.AnchorDateConfigurationProperty(
        anchor_option="anchorOption",
        parameter_name="parameterName"
    ),
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    default_filter_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
        control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                    date_icon_visibility=date_icon_visibility,
                    date_time_format="dateTimeFormat",
                    helper_text_visibility=helper_text_visibility,
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                maximum_value=123,
                minimum_value=123,
                step_size=123,
                type="type"
            ),
            default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    exclude_period_configuration=quicksight_mixins.CfnTemplatePropsMixin.ExcludePeriodConfigurationProperty(
        amount=123,
        granularity="granularity",
        status="status"
    ),
    filter_id="filterId",
    minimum_granularity="minimumGranularity",
    null_option="nullOption",
    parameter_name="parameterName",
    relative_date_type="relativeDateType",
    relative_date_value=123,
    time_granularity="timeGranularity"
)

Attributes

anchor_date_configuration

The date configuration of the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-anchordateconfiguration

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-column

default_filter_control_configuration

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-defaultfiltercontrolconfiguration

exclude_period_configuration

The configuration for the exclude period of the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-excludeperiodconfiguration

filter_id

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-filterid

minimum_granularity

The minimum granularity (period granularity) of the relative dates filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-minimumgranularity

null_option

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.

  • NULLS_ONLY : Only include null values in filtered results.

  • NON_NULLS_ONLY : Exclude null values from filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-nulloption

parameter_name

The parameter whose value should be used for the filter value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-parametername

relative_date_type

.

  • PREVIOUS

  • THIS

  • LAST

  • NOW

  • NEXT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-relativedatetype

Type:

The range date type of the filter. Choose one of the options below

relative_date_value

The date value of the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-relativedatevalue

time_granularity

The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-timegranularity

ResourcePermissionProperty

class CfnTemplatePropsMixin.ResourcePermissionProperty(*, actions=None, principal=None, resource=None)

Bases: object

Permission 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

resource_permission_property = quicksight_mixins.CfnTemplatePropsMixin.ResourcePermissionProperty(
    actions=["actions"],
    principal="principal",
    resource="resource"
)

Attributes

actions

The IAM action to grant or revoke permissions on.

See:

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

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:

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

Type:

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

resource

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

Type:

see

RollingDateConfigurationProperty

class CfnTemplatePropsMixin.RollingDateConfigurationProperty(*, data_set_identifier=None, expression=None)

Bases: object

The rolling date configuration of a date time filter.

Parameters:

  • data_set_identifier (Optional[str]) – The data set that is used in the rolling date configuration.

  • expression (Optional[str]) – The expression of the rolling date configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rollingdateconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

rolling_date_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.RollingDateConfigurationProperty(
    data_set_identifier="dataSetIdentifier",
    expression="expression"
)

Attributes

data_set_identifier

The data set that is used in the rolling date configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rollingdateconfiguration.html#cfn-quicksight-template-rollingdateconfiguration-datasetidentifier

expression

The expression of the rolling date configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rollingdateconfiguration.html#cfn-quicksight-template-rollingdateconfiguration-expression

RowAlternateColorOptionsProperty

class CfnTemplatePropsMixin.RowAlternateColorOptionsProperty(*, row_alternate_colors=None, status=None, use_primary_background_color=None)

Bases: object

Determines the row alternate color options.

Parameters:

  • row_alternate_colors (Optional[Sequence[str]]) – Determines the list of row alternate colors.

  • status (Optional[str]) – Determines the widget status.

  • use_primary_background_color (Optional[str]) – The primary background color options for alternate rows.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rowalternatecoloroptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

row_alternate_color_options_property = quicksight_mixins.CfnTemplatePropsMixin.RowAlternateColorOptionsProperty(
    row_alternate_colors=["rowAlternateColors"],
    status="status",
    use_primary_background_color="usePrimaryBackgroundColor"
)

Attributes

row_alternate_colors

Determines the list of row alternate colors.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rowalternatecoloroptions.html#cfn-quicksight-template-rowalternatecoloroptions-rowalternatecolors

status

Determines the widget status.

See:

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

use_primary_background_color

The primary background color options for alternate rows.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-rowalternatecoloroptions.html#cfn-quicksight-template-rowalternatecoloroptions-useprimarybackgroundcolor

SameSheetTargetVisualConfigurationProperty

class CfnTemplatePropsMixin.SameSheetTargetVisualConfigurationProperty(*, target_visual_options=None, target_visuals=None)

Bases: object

The configuration of the same-sheet target visuals that you want to be filtered.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • target_visual_options (Optional[str]) – The options that choose the target visual in the same sheet. Valid values are defined as follows: - ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

  • target_visuals (Optional[Sequence[str]]) – A list of the target visual IDs that are located in the same sheet of the analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-samesheettargetvisualconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

same_sheet_target_visual_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SameSheetTargetVisualConfigurationProperty(
    target_visual_options="targetVisualOptions",
    target_visuals=["targetVisuals"]
)

Attributes

target_visual_options

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

  • ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-samesheettargetvisualconfiguration.html#cfn-quicksight-template-samesheettargetvisualconfiguration-targetvisualoptions

target_visuals

A list of the target visual IDs that are located in the same sheet of the analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-samesheettargetvisualconfiguration.html#cfn-quicksight-template-samesheettargetvisualconfiguration-targetvisuals

SankeyDiagramAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.SankeyDiagramAggregatedFieldWellsProperty(*, destination=None, source=None, weight=None)

Bases: object

The field well configuration of a sankey diagram.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
destination

The destination field wells of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-template-sankeydiagramaggregatedfieldwells-destination

source

The source field wells of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-template-sankeydiagramaggregatedfieldwells-source

weight

The weight field wells of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-template-sankeydiagramaggregatedfieldwells-weight

SankeyDiagramChartConfigurationProperty

class CfnTemplatePropsMixin.SankeyDiagramChartConfigurationProperty(*, data_labels=None, field_wells=None, interactions=None, sort_configuration=None)

Bases: object

The configuration of a sankey diagram.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramchartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
data_labels

The data label configuration of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramchartconfiguration.html#cfn-quicksight-template-sankeydiagramchartconfiguration-datalabels

field_wells

The field well configuration of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramchartconfiguration.html#cfn-quicksight-template-sankeydiagramchartconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramchartconfiguration.html#cfn-quicksight-template-sankeydiagramchartconfiguration-interactions

sort_configuration

The sort configuration of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramchartconfiguration.html#cfn-quicksight-template-sankeydiagramchartconfiguration-sortconfiguration

SankeyDiagramFieldWellsProperty

class CfnTemplatePropsMixin.SankeyDiagramFieldWellsProperty(*, sankey_diagram_aggregated_field_wells=None)

Bases: object

The field well configuration of a sankey diagram.

Parameters:

sankey_diagram_aggregated_field_wells (Union[IResolvable, SankeyDiagramAggregatedFieldWellsProperty, Dict[str, Any], None]) – The field well configuration of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
sankey_diagram_aggregated_field_wells

The field well configuration of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramfieldwells.html#cfn-quicksight-template-sankeydiagramfieldwells-sankeydiagramaggregatedfieldwells

SankeyDiagramSortConfigurationProperty

class CfnTemplatePropsMixin.SankeyDiagramSortConfigurationProperty(*, destination_items_limit=None, source_items_limit=None, weight_sort=None)

Bases: object

The sort configuration of a sankey diagram.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sankey_diagram_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SankeyDiagramSortConfigurationProperty(
    destination_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    source_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    weight_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

destination_items_limit

The limit on the number of destination nodes that are displayed in a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramsortconfiguration.html#cfn-quicksight-template-sankeydiagramsortconfiguration-destinationitemslimit

source_items_limit

The limit on the number of source nodes that are displayed in a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramsortconfiguration.html#cfn-quicksight-template-sankeydiagramsortconfiguration-sourceitemslimit

weight_sort

The sort configuration of the weight fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramsortconfiguration.html#cfn-quicksight-template-sankeydiagramsortconfiguration-weightsort

SankeyDiagramVisualProperty

class CfnTemplatePropsMixin.SankeyDiagramVisualProperty(*, actions=None, chart_configuration=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-chartconfiguration

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sankeydiagramvisual.html#cfn-quicksight-template-sankeydiagramvisual-visualid

ScatterPlotCategoricallyAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.ScatterPlotCategoricallyAggregatedFieldWellsProperty(*, category=None, label=None, size=None, x_axis=None, y_axis=None)

Bases: object

The aggregated field well of a scatter plot.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category

The category field well of a scatter plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-template-scatterplotcategoricallyaggregatedfieldwells-category

label

The label field well of a scatter plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-template-scatterplotcategoricallyaggregatedfieldwells-label

size

The size field well of a scatter plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-template-scatterplotcategoricallyaggregatedfieldwells-size

x_axis

The x-axis field well of a scatter plot.

The x-axis is aggregated by category.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-template-scatterplotcategoricallyaggregatedfieldwells-xaxis

y_axis

The y-axis field well of a scatter plot.

The y-axis is aggregated by category.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-template-scatterplotcategoricallyaggregatedfieldwells-yaxis

ScatterPlotConfigurationProperty

class CfnTemplatePropsMixin.ScatterPlotConfigurationProperty(*, data_labels=None, field_wells=None, interactions=None, legend=None, sort_configuration=None, tooltip=None, visual_palette=None, x_axis_display_options=None, x_axis_label_options=None, y_axis_display_options=None, y_axis_label_options=None)

Bases: object

The configuration of a scatter plot.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
data_labels

The options that determine if visual data labels are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-datalabels

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-interactions

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-legend

sort_configuration

The sort configuration of a scatter plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-sortconfiguration

tooltip

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-tooltip

visual_palette

The palette (chart color) display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-visualpalette

x_axis_display_options

The label display options (grid line, range, scale, and axis step) of the scatter plot’s x-axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-xaxisdisplayoptions

x_axis_label_options

The label options (label text, label visibility, and sort icon visibility) of the scatter plot’s x-axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-xaxislabeloptions

y_axis_display_options

The label display options (grid line, range, scale, and axis step) of the scatter plot’s y-axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-yaxisdisplayoptions

y_axis_label_options

The label options (label text, label visibility, and sort icon visibility) of the scatter plot’s y-axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotconfiguration.html#cfn-quicksight-template-scatterplotconfiguration-yaxislabeloptions

ScatterPlotFieldWellsProperty

class CfnTemplatePropsMixin.ScatterPlotFieldWellsProperty(*, scatter_plot_categorically_aggregated_field_wells=None, scatter_plot_unaggregated_field_wells=None)

Bases: object

The field well configuration of a scatter plot.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
scatter_plot_categorically_aggregated_field_wells

The aggregated field wells of a scatter plot.

The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotfieldwells.html#cfn-quicksight-template-scatterplotfieldwells-scatterplotcategoricallyaggregatedfieldwells

scatter_plot_unaggregated_field_wells

The unaggregated field wells of a scatter plot.

The x and y-axes of these scatter plots are unaggregated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotfieldwells.html#cfn-quicksight-template-scatterplotfieldwells-scatterplotunaggregatedfieldwells

ScatterPlotSortConfigurationProperty

class CfnTemplatePropsMixin.ScatterPlotSortConfigurationProperty(*, scatter_plot_limit_configuration=None)

Bases: object

The sort configuration of a scatter plot.

Parameters:

scatter_plot_limit_configuration (Union[IResolvable, ItemsLimitConfigurationProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

scatter_plot_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.ScatterPlotSortConfigurationProperty(
    scatter_plot_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    )
)

Attributes

scatter_plot_limit_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotsortconfiguration.html#cfn-quicksight-template-scatterplotsortconfiguration-scatterplotlimitconfiguration

Type:

see

ScatterPlotUnaggregatedFieldWellsProperty

class CfnTemplatePropsMixin.ScatterPlotUnaggregatedFieldWellsProperty(*, category=None, label=None, size=None, x_axis=None, y_axis=None)

Bases: object

The unaggregated field wells of a scatter plot.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category

The category field well of a scatter plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html#cfn-quicksight-template-scatterplotunaggregatedfieldwells-category

label

The label field well of a scatter plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html#cfn-quicksight-template-scatterplotunaggregatedfieldwells-label

size

The size field well of a scatter plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html#cfn-quicksight-template-scatterplotunaggregatedfieldwells-size

x_axis

The x-axis field well of a scatter plot.

The x-axis is a dimension field and cannot be aggregated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html#cfn-quicksight-template-scatterplotunaggregatedfieldwells-xaxis

y_axis

The y-axis field well of a scatter plot.

The y-axis is a dimension field and cannot be aggregated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotunaggregatedfieldwells.html#cfn-quicksight-template-scatterplotunaggregatedfieldwells-yaxis

ScatterPlotVisualProperty

class CfnTemplatePropsMixin.ScatterPlotVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A scatter plot.

For more information, see Using scatter plots in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scatterplotvisual.html#cfn-quicksight-template-scatterplotvisual-visualid

ScrollBarOptionsProperty

class CfnTemplatePropsMixin.ScrollBarOptionsProperty(*, visibility=None, visible_range=None)

Bases: object

The visual display options for a data zoom scroll bar.

Parameters:

  • visibility (Optional[str]) – The visibility of the data zoom scroll bar.

  • visible_range (Union[IResolvable, VisibleRangeOptionsProperty, Dict[str, Any], None]) – The visibility range for the data zoom scroll bar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scrollbaroptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

scroll_bar_options_property = quicksight_mixins.CfnTemplatePropsMixin.ScrollBarOptionsProperty(
    visibility="visibility",
    visible_range=quicksight_mixins.CfnTemplatePropsMixin.VisibleRangeOptionsProperty(
        percent_range=quicksight_mixins.CfnTemplatePropsMixin.PercentVisibleRangeProperty(
            from=123,
            to=123
        )
    )
)

Attributes

visibility

The visibility of the data zoom scroll bar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scrollbaroptions.html#cfn-quicksight-template-scrollbaroptions-visibility

visible_range

The visibility range for the data zoom scroll bar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-scrollbaroptions.html#cfn-quicksight-template-scrollbaroptions-visiblerange

SecondaryValueOptionsProperty

class CfnTemplatePropsMixin.SecondaryValueOptionsProperty(*, visibility=None)

Bases: object

The options that determine the presentation of the secondary value of a KPI visual.

Parameters:

visibility (Optional[str]) – Determines the visibility of the secondary value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-secondaryvalueoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

secondary_value_options_property = quicksight_mixins.CfnTemplatePropsMixin.SecondaryValueOptionsProperty(
    visibility="visibility"
)

Attributes

visibility

Determines the visibility of the secondary value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-secondaryvalueoptions.html#cfn-quicksight-template-secondaryvalueoptions-visibility

SectionAfterPageBreakProperty

class CfnTemplatePropsMixin.SectionAfterPageBreakProperty(*, status=None)

Bases: object

The configuration of a page break after a section.

Parameters:

status (Optional[str]) – The option that enables or disables a page break at the end of a section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionafterpagebreak.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

section_after_page_break_property = quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
    status="status"
)

Attributes

status

The option that enables or disables a page break at the end of a section.

See:

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

SectionBasedLayoutCanvasSizeOptionsProperty

class CfnTemplatePropsMixin.SectionBasedLayoutCanvasSizeOptionsProperty(*, paper_canvas_size_options=None)

Bases: object

The options for the canvas of a section-based layout.

Parameters:

paper_canvas_size_options (Union[IResolvable, SectionBasedLayoutPaperCanvasSizeOptionsProperty, Dict[str, Any], None]) – The options for a paper canvas of a section-based layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutcanvassizeoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

section_based_layout_canvas_size_options_property = quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutCanvasSizeOptionsProperty(
    paper_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
        paper_margin=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
            bottom="bottom",
            left="left",
            right="right",
            top="top"
        ),
        paper_orientation="paperOrientation",
        paper_size="paperSize"
    )
)

Attributes

paper_canvas_size_options

The options for a paper canvas of a section-based layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutcanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutcanvassizeoptions-papercanvassizeoptions

SectionBasedLayoutConfigurationProperty

class CfnTemplatePropsMixin.SectionBasedLayoutConfigurationProperty(*, body_sections=None, canvas_size_options=None, footer_sections=None, header_sections=None)

Bases: object

The configuration for a section-based layout.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

section_based_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutConfigurationProperty(
    body_sections=[quicksight_mixins.CfnTemplatePropsMixin.BodySectionConfigurationProperty(
        content=quicksight_mixins.CfnTemplatePropsMixin.BodySectionContentProperty(
            layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
                free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
                    elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                        background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        element_id="elementId",
                        element_type="elementType",
                        height="height",
                        loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                            visibility="visibility"
                        ),
                        rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                            configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                                visibility="visibility"
                            ),
                            expression="expression"
                        )],
                        selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        visibility="visibility",
                        width="width",
                        x_axis_location="xAxisLocation",
                        y_axis_location="yAxisLocation"
                    )]
                )
            )
        ),
        page_break_configuration=quicksight_mixins.CfnTemplatePropsMixin.SectionPageBreakConfigurationProperty(
            after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
                status="status"
            )
        ),
        repeat_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatConfigurationProperty(
            dimension_configurations=[quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatDimensionConfigurationProperty(
                dynamic_category_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicCategoryDimensionConfigurationProperty(
                    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    ),
                    limit=123,
                    sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                        aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                            attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                                simple_attribute_aggregation="simpleAttributeAggregation",
                                value_for_multiple_values="valueForMultipleValues"
                            ),
                            categorical_aggregation_function="categoricalAggregationFunction",
                            date_aggregation_function="dateAggregationFunction",
                            numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                                    percentile_value=123
                                ),
                                simple_numerical_aggregation="simpleNumericalAggregation"
                            )
                        ),
                        direction="direction",
                        sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                            column_name="columnName",
                            data_set_identifier="dataSetIdentifier"
                        )
                    )]
                ),
                dynamic_numeric_dimension_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionDynamicNumericDimensionConfigurationProperty(
                    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    ),
                    limit=123,
                    sort_by_metrics=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
                        aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                            attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                                simple_attribute_aggregation="simpleAttributeAggregation",
                                value_for_multiple_values="valueForMultipleValues"
                            ),
                            categorical_aggregation_function="categoricalAggregationFunction",
                            date_aggregation_function="dateAggregationFunction",
                            numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                                    percentile_value=123
                                ),
                                simple_numerical_aggregation="simpleNumericalAggregation"
                            )
                        ),
                        direction="direction",
                        sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                            column_name="columnName",
                            data_set_identifier="dataSetIdentifier"
                        )
                    )]
                )
            )],
            non_repeating_visuals=["nonRepeatingVisuals"],
            page_break_configuration=quicksight_mixins.CfnTemplatePropsMixin.BodySectionRepeatPageBreakConfigurationProperty(
                after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
                    status="status"
                )
            )
        ),
        section_id="sectionId",
        style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
            height="height",
            padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                bottom="bottom",
                left="left",
                right="right",
                top="top"
            )
        )
    )],
    canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutCanvasSizeOptionsProperty(
        paper_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
            paper_margin=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                bottom="bottom",
                left="left",
                right="right",
                top="top"
            ),
            paper_orientation="paperOrientation",
            paper_size="paperSize"
        )
    ),
    footer_sections=[quicksight_mixins.CfnTemplatePropsMixin.HeaderFooterSectionConfigurationProperty(
        layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
            free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
                elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                    background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    element_id="elementId",
                    element_type="elementType",
                    height="height",
                    loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                        visibility="visibility"
                    ),
                    rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                        configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                            visibility="visibility"
                        ),
                        expression="expression"
                    )],
                    selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    visibility="visibility",
                    width="width",
                    x_axis_location="xAxisLocation",
                    y_axis_location="yAxisLocation"
                )]
            )
        ),
        section_id="sectionId",
        style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
            height="height",
            padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                bottom="bottom",
                left="left",
                right="right",
                top="top"
            )
        )
    )],
    header_sections=[quicksight_mixins.CfnTemplatePropsMixin.HeaderFooterSectionConfigurationProperty(
        layout=quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
            free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
                elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
                    background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    element_id="elementId",
                    element_type="elementType",
                    height="height",
                    loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                        visibility="visibility"
                    ),
                    rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                        configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                            visibility="visibility"
                        ),
                        expression="expression"
                    )],
                    selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    visibility="visibility",
                    width="width",
                    x_axis_location="xAxisLocation",
                    y_axis_location="yAxisLocation"
                )]
            )
        ),
        section_id="sectionId",
        style=quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
            height="height",
            padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
                bottom="bottom",
                left="left",
                right="right",
                top="top"
            )
        )
    )]
)

Attributes

body_sections

A list of body section configurations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-bodysections

canvas_size_options

The options for the canvas of a section-based layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-canvassizeoptions

footer_sections

A list of footer section configurations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-footersections

header_sections

A list of header section configurations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutconfiguration.html#cfn-quicksight-template-sectionbasedlayoutconfiguration-headersections

SectionBasedLayoutPaperCanvasSizeOptionsProperty

class CfnTemplatePropsMixin.SectionBasedLayoutPaperCanvasSizeOptionsProperty(*, paper_margin=None, paper_orientation=None, paper_size=None)

Bases: object

The options for a paper canvas of a section-based layout.

Parameters:

  • paper_margin (Union[IResolvable, SpacingProperty, Dict[str, Any], None]) – Defines the spacing between the canvas content and the top, bottom, left, and right edges.

  • paper_orientation (Optional[str]) – The paper orientation that is used to define canvas dimensions. Choose one of the following options:. - PORTRAIT - LANDSCAPE

  • paper_size (Optional[str]) – The paper size that is used to define canvas dimensions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

section_based_layout_paper_canvas_size_options_property = quicksight_mixins.CfnTemplatePropsMixin.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
    paper_margin=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
        bottom="bottom",
        left="left",
        right="right",
        top="top"
    ),
    paper_orientation="paperOrientation",
    paper_size="paperSize"
)

Attributes

paper_margin

Defines the spacing between the canvas content and the top, bottom, left, and right edges.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutpapercanvassizeoptions-papermargin

paper_orientation

.

  • PORTRAIT

  • LANDSCAPE

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutpapercanvassizeoptions-paperorientation

Type:

The paper orientation that is used to define canvas dimensions. Choose one of the following options

paper_size

The paper size that is used to define canvas dimensions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-template-sectionbasedlayoutpapercanvassizeoptions-papersize

SectionLayoutConfigurationProperty

class CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(*, free_form_layout=None)

Bases: object

The layout configuration of a section.

Parameters:

free_form_layout (Union[IResolvable, FreeFormSectionLayoutConfigurationProperty, Dict[str, Any], None]) – The free-form layout configuration of a section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionlayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

section_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SectionLayoutConfigurationProperty(
    free_form_layout=quicksight_mixins.CfnTemplatePropsMixin.FreeFormSectionLayoutConfigurationProperty(
        elements=[quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementProperty(
            background_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBackgroundStyleProperty(
                color="color",
                visibility="visibility"
            ),
            border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                color="color",
                visibility="visibility"
            ),
            element_id="elementId",
            element_type="elementType",
            height="height",
            loading_animation=quicksight_mixins.CfnTemplatePropsMixin.LoadingAnimationProperty(
                visibility="visibility"
            ),
            rendering_rules=[quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
                configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
                    visibility="visibility"
                ),
                expression="expression"
            )],
            selected_border_style=quicksight_mixins.CfnTemplatePropsMixin.FreeFormLayoutElementBorderStyleProperty(
                color="color",
                visibility="visibility"
            ),
            visibility="visibility",
            width="width",
            x_axis_location="xAxisLocation",
            y_axis_location="yAxisLocation"
        )]
    )
)

Attributes

free_form_layout

The free-form layout configuration of a section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionlayoutconfiguration.html#cfn-quicksight-template-sectionlayoutconfiguration-freeformlayout

SectionPageBreakConfigurationProperty

class CfnTemplatePropsMixin.SectionPageBreakConfigurationProperty(*, after=None)

Bases: object

The configuration of a page break for a section.

Parameters:

after (Union[IResolvable, SectionAfterPageBreakProperty, Dict[str, Any], None]) – The configuration of a page break after a section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionpagebreakconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

section_page_break_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SectionPageBreakConfigurationProperty(
    after=quicksight_mixins.CfnTemplatePropsMixin.SectionAfterPageBreakProperty(
        status="status"
    )
)

Attributes

after

The configuration of a page break after a section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionpagebreakconfiguration.html#cfn-quicksight-template-sectionpagebreakconfiguration-after

SectionStyleProperty

class CfnTemplatePropsMixin.SectionStyleProperty(*, height=None, padding=None)

Bases: object

The options that style a section.

Parameters:

  • height (Optional[str]) – The height of a section. Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.

  • padding (Union[IResolvable, SpacingProperty, Dict[str, Any], None]) – The spacing between section content and its top, bottom, left, and right edges. There is no padding by default.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionstyle.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

section_style_property = quicksight_mixins.CfnTemplatePropsMixin.SectionStyleProperty(
    height="height",
    padding=quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
        bottom="bottom",
        left="left",
        right="right",
        top="top"
    )
)

Attributes

height

The height of a section.

Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionstyle.html#cfn-quicksight-template-sectionstyle-height

padding

The spacing between section content and its top, bottom, left, and right edges.

There is no padding by default.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sectionstyle.html#cfn-quicksight-template-sectionstyle-padding

SelectedSheetsFilterScopeConfigurationProperty

class CfnTemplatePropsMixin.SelectedSheetsFilterScopeConfigurationProperty(*, sheet_visual_scoping_configurations=None)

Bases: object

The configuration for applying a filter to specific sheets or visuals.

You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

sheet_visual_scoping_configurations (Union[IResolvable, Sequence[Union[IResolvable, SheetVisualScopingConfigurationProperty, Dict[str, Any]]], None]) – The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-selectedsheetsfilterscopeconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

selected_sheets_filter_scope_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SelectedSheetsFilterScopeConfigurationProperty(
    sheet_visual_scoping_configurations=[quicksight_mixins.CfnTemplatePropsMixin.SheetVisualScopingConfigurationProperty(
        scope="scope",
        sheet_id="sheetId",
        visual_ids=["visualIds"]
    )]
)

Attributes

sheet_visual_scoping_configurations

The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-selectedsheetsfilterscopeconfiguration.html#cfn-quicksight-template-selectedsheetsfilterscopeconfiguration-sheetvisualscopingconfigurations

SeriesItemProperty

class CfnTemplatePropsMixin.SeriesItemProperty(*, data_field_series_item=None, field_series_item=None)

Bases: object

The series item configuration of a line chart.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-seriesitem.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

series_item_property = quicksight_mixins.CfnTemplatePropsMixin.SeriesItemProperty(
    data_field_series_item=quicksight_mixins.CfnTemplatePropsMixin.DataFieldSeriesItemProperty(
        axis_binding="axisBinding",
        field_id="fieldId",
        field_value="fieldValue",
        settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartSeriesSettingsProperty(
            line_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartLineStyleSettingsProperty(
                line_interpolation="lineInterpolation",
                line_style="lineStyle",
                line_visibility="lineVisibility",
                line_width="lineWidth"
            ),
            marker_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartMarkerStyleSettingsProperty(
                marker_color="markerColor",
                marker_shape="markerShape",
                marker_size="markerSize",
                marker_visibility="markerVisibility"
            )
        )
    ),
    field_series_item=quicksight_mixins.CfnTemplatePropsMixin.FieldSeriesItemProperty(
        axis_binding="axisBinding",
        field_id="fieldId",
        settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartSeriesSettingsProperty(
            line_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartLineStyleSettingsProperty(
                line_interpolation="lineInterpolation",
                line_style="lineStyle",
                line_visibility="lineVisibility",
                line_width="lineWidth"
            ),
            marker_style_settings=quicksight_mixins.CfnTemplatePropsMixin.LineChartMarkerStyleSettingsProperty(
                marker_color="markerColor",
                marker_shape="markerShape",
                marker_size="markerSize",
                marker_visibility="markerVisibility"
            )
        )
    )
)

Attributes

data_field_series_item

The data field series item configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-seriesitem.html#cfn-quicksight-template-seriesitem-datafieldseriesitem

field_series_item

The field series item configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-seriesitem.html#cfn-quicksight-template-seriesitem-fieldseriesitem

SetParameterValueConfigurationProperty

class CfnTemplatePropsMixin.SetParameterValueConfigurationProperty(*, destination_parameter_name=None, value=None)

Bases: object

The configuration of adding parameters in action.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-setparametervalueconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

set_parameter_value_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SetParameterValueConfigurationProperty(
    destination_parameter_name="destinationParameterName",
    value=quicksight_mixins.CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(
        custom_values_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
            custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
                date_time_values=["dateTimeValues"],
                decimal_values=[123],
                integer_values=[123],
                string_values=["stringValues"]
            ),
            include_null_value=False
        ),
        select_all_value_options="selectAllValueOptions",
        source_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        source_field="sourceField",
        source_parameter_name="sourceParameterName"
    )
)

Attributes

destination_parameter_name

The destination parameter name of the SetParameterValueConfiguration .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-setparametervalueconfiguration.html#cfn-quicksight-template-setparametervalueconfiguration-destinationparametername

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-setparametervalueconfiguration.html#cfn-quicksight-template-setparametervalueconfiguration-value

Type:

see

ShapeConditionalFormatProperty

class CfnTemplatePropsMixin.ShapeConditionalFormatProperty(*, background_color=None)

Bases: object

The shape conditional formatting of a filled map visual.

Parameters:

background_color (Union[IResolvable, ConditionalFormattingColorProperty, Dict[str, Any], None]) – The conditional formatting for the shape background color of a filled map visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-shapeconditionalformat.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

shape_conditional_format_property = quicksight_mixins.CfnTemplatePropsMixin.ShapeConditionalFormatProperty(
    background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    )
)

Attributes

background_color

The conditional formatting for the shape background color of a filled map visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-shapeconditionalformat.html#cfn-quicksight-template-shapeconditionalformat-backgroundcolor

SheetControlInfoIconLabelOptionsProperty

class CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(*, info_icon_text=None, visibility=None)

Bases: object

A control to display info icons for filters and parameters.

Parameters:

  • info_icon_text (Optional[str]) – The text content of info icon.

  • visibility (Optional[str]) – The visibility configuration of info icon label options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_control_info_icon_label_options_property = quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
    info_icon_text="infoIconText",
    visibility="visibility"
)

Attributes

info_icon_text

The text content of info icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html#cfn-quicksight-template-sheetcontrolinfoiconlabeloptions-infoicontext

visibility

The visibility configuration of info icon label options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrolinfoiconlabeloptions.html#cfn-quicksight-template-sheetcontrolinfoiconlabeloptions-visibility

SheetControlLayoutConfigurationProperty

class CfnTemplatePropsMixin.SheetControlLayoutConfigurationProperty(*, grid_layout=None)

Bases: object

The configuration that determines the elements and canvas size options of sheet control.

Parameters:

grid_layout (Union[IResolvable, GridLayoutConfigurationProperty, Dict[str, Any], None]) – The configuration that determines the elements and canvas size options of sheet control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrollayoutconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_control_layout_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SheetControlLayoutConfigurationProperty(
    grid_layout=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutConfigurationProperty(
        canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(
            screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
                optimized_view_port_width="optimizedViewPortWidth",
                resize_option="resizeOption"
            )
        ),
        elements=[quicksight_mixins.CfnTemplatePropsMixin.GridLayoutElementProperty(
            column_index=123,
            column_span=123,
            element_id="elementId",
            element_type="elementType",
            row_index=123,
            row_span=123
        )]
    )
)

Attributes

grid_layout

The configuration that determines the elements and canvas size options of sheet control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrollayoutconfiguration.html#cfn-quicksight-template-sheetcontrollayoutconfiguration-gridlayout

SheetControlLayoutProperty

class CfnTemplatePropsMixin.SheetControlLayoutProperty(*, configuration=None)

Bases: object

A grid layout to define the placement of sheet control.

Parameters:

configuration (Union[IResolvable, SheetControlLayoutConfigurationProperty, Dict[str, Any], None]) – The configuration that determines the elements and canvas size options of sheet control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetcontrollayout.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_control_layout_property = quicksight_mixins.CfnTemplatePropsMixin.SheetControlLayoutProperty(
    configuration=quicksight_mixins.CfnTemplatePropsMixin.SheetControlLayoutConfigurationProperty(
        grid_layout=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutConfigurationProperty(
            canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutCanvasSizeOptionsProperty(
                screen_canvas_size_options=quicksight_mixins.CfnTemplatePropsMixin.GridLayoutScreenCanvasSizeOptionsProperty(
                    optimized_view_port_width="optimizedViewPortWidth",
                    resize_option="resizeOption"
                )
            ),
            elements=[quicksight_mixins.CfnTemplatePropsMixin.GridLayoutElementProperty(
                column_index=123,
                column_span=123,
                element_id="elementId",
                element_type="elementType",
                row_index=123,
                row_span=123
            )]
        )
    )
)

Attributes

configuration

The configuration that determines the elements and canvas size options of sheet control.

See:

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

SheetDefinitionProperty

class CfnTemplatePropsMixin.SheetDefinitionProperty(*, content_type=None, description=None, filter_controls=None, images=None, layouts=None, name=None, parameter_controls=None, sheet_control_layouts=None, sheet_id=None, text_boxes=None, title=None, visuals=None)

Bases: object

A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report.

Every analysis and dashboard must contain at least one sheet.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
content_type

.

  • PAGINATED : Creates a sheet for a paginated report.

  • INTERACTIVE : Creates a sheet for an interactive dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-contenttype

Type:

The layout content type of the sheet. Choose one of the following options

description

A description of the sheet.

See:

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

filter_controls

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-filtercontrols

images

A list of images on a sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-images

layouts

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-layouts

name

The name of the sheet.

This name is displayed on the sheet’s tab in the Quick Suite console.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-name

parameter_controls

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-parametercontrols

sheet_control_layouts

The control layouts of the sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-sheetcontrollayouts

sheet_id

The unique identifier of a sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-sheetid

text_boxes

The text boxes that are on a sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-textboxes

title

The title of the sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-title

visuals

A list of the visuals that are on a sheet.

Visual placement is determined by the layout of the sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-visuals

SheetElementConfigurationOverridesProperty

class CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(*, visibility=None)

Bases: object

The override configuration of the rendering rules of a sheet.

Parameters:

visibility (Optional[str]) – Determines whether or not the overrides are visible. Choose one of the following options:. - VISIBLE - HIDDEN

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetelementconfigurationoverrides.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_element_configuration_overrides_property = quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
    visibility="visibility"
)

Attributes

visibility

.

  • VISIBLE

  • HIDDEN

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetelementconfigurationoverrides.html#cfn-quicksight-template-sheetelementconfigurationoverrides-visibility

Type:

Determines whether or not the overrides are visible. Choose one of the following options

SheetElementRenderingRuleProperty

class CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(*, configuration_overrides=None, expression=None)

Bases: object

The rendering rules of a sheet that uses a free-form layout.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetelementrenderingrule.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_element_rendering_rule_property = quicksight_mixins.CfnTemplatePropsMixin.SheetElementRenderingRuleProperty(
    configuration_overrides=quicksight_mixins.CfnTemplatePropsMixin.SheetElementConfigurationOverridesProperty(
        visibility="visibility"
    ),
    expression="expression"
)

Attributes

configuration_overrides

The override configuration of the rendering rules of a sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetelementrenderingrule.html#cfn-quicksight-template-sheetelementrenderingrule-configurationoverrides

expression

The expression of the rendering rules of a sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetelementrenderingrule.html#cfn-quicksight-template-sheetelementrenderingrule-expression

SheetImageProperty

class CfnTemplatePropsMixin.SheetImageProperty(*, actions=None, image_content_alt_text=None, interactions=None, scaling=None, sheet_image_id=None, source=None, tooltip=None)

Bases: object

An image that is located on a sheet.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# visibility: Any

sheet_image_property = quicksight_mixins.CfnTemplatePropsMixin.SheetImageProperty(
    actions=[quicksight_mixins.CfnTemplatePropsMixin.ImageCustomActionProperty(
        action_operations=[quicksight_mixins.CfnTemplatePropsMixin.ImageCustomActionOperationProperty(
            navigation_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionNavigationOperationProperty(
                local_navigation_configuration=quicksight_mixins.CfnTemplatePropsMixin.LocalNavigationConfigurationProperty(
                    target_sheet_id="targetSheetId"
                )
            ),
            set_parameters_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionSetParametersOperationProperty(
                parameter_value_configurations=[quicksight_mixins.CfnTemplatePropsMixin.SetParameterValueConfigurationProperty(
                    destination_parameter_name="destinationParameterName",
                    value=quicksight_mixins.CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(
                        custom_values_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
                            custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
                                date_time_values=["dateTimeValues"],
                                decimal_values=[123],
                                integer_values=[123],
                                string_values=["stringValues"]
                            ),
                            include_null_value=False
                        ),
                        select_all_value_options="selectAllValueOptions",
                        source_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                            column_name="columnName",
                            data_set_identifier="dataSetIdentifier"
                        ),
                        source_field="sourceField",
                        source_parameter_name="sourceParameterName"
                    )
                )]
            ),
            url_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionURLOperationProperty(
                url_target="urlTarget",
                url_template="urlTemplate"
            )
        )],
        custom_action_id="customActionId",
        name="name",
        status="status",
        trigger="trigger"
    )],
    image_content_alt_text="imageContentAltText",
    interactions=quicksight_mixins.CfnTemplatePropsMixin.ImageInteractionOptionsProperty(
        image_menu_option=quicksight_mixins.CfnTemplatePropsMixin.ImageMenuOptionProperty(
            availability_status="availabilityStatus"
        )
    ),
    scaling=quicksight_mixins.CfnTemplatePropsMixin.SheetImageScalingConfigurationProperty(
        scaling_type="scalingType"
    ),
    sheet_image_id="sheetImageId",
    source=quicksight_mixins.CfnTemplatePropsMixin.SheetImageSourceProperty(
        sheet_image_static_file_source=quicksight_mixins.CfnTemplatePropsMixin.SheetImageStaticFileSourceProperty(
            static_file_id="staticFileId"
        )
    ),
    tooltip=quicksight_mixins.CfnTemplatePropsMixin.SheetImageTooltipConfigurationProperty(
        tooltip_text=quicksight_mixins.CfnTemplatePropsMixin.SheetImageTooltipTextProperty(
            plain_text="plainText"
        ),
        visibility=visibility
    )
)

Attributes

actions

A list of custom actions that are configured for an image.

See:

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

image_content_alt_text

The alt text for the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-imagecontentalttext

interactions

The general image interactions setup for an image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-interactions

scaling

Determines how the image is scaled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-scaling

sheet_image_id

The ID of the sheet image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-sheetimageid

source

The source of the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-source

tooltip

The tooltip to be shown when hovering over the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimage.html#cfn-quicksight-template-sheetimage-tooltip

SheetImageScalingConfigurationProperty

class CfnTemplatePropsMixin.SheetImageScalingConfigurationProperty(*, scaling_type=None)

Bases: object

Determines how the image is scaled.

Parameters:

scaling_type (Optional[str]) – The scaling option to use when fitting the image inside the container. Valid values are defined as follows: - SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved. - SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved. - SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved. - SCALE_NONE : The image is displayed in its original size and is not scaled to the container.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagescalingconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_image_scaling_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SheetImageScalingConfigurationProperty(
    scaling_type="scalingType"
)

Attributes

scaling_type

The scaling option to use when fitting the image inside the container.

Valid values are defined as follows:

  • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.

  • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.

  • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.

  • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagescalingconfiguration.html#cfn-quicksight-template-sheetimagescalingconfiguration-scalingtype

SheetImageSourceProperty

class CfnTemplatePropsMixin.SheetImageSourceProperty(*, sheet_image_static_file_source=None)

Bases: object

The source of the image.

Parameters:

sheet_image_static_file_source (Union[IResolvable, SheetImageStaticFileSourceProperty, Dict[str, Any], None]) – The source of the static file that contains the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagesource.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_image_source_property = quicksight_mixins.CfnTemplatePropsMixin.SheetImageSourceProperty(
    sheet_image_static_file_source=quicksight_mixins.CfnTemplatePropsMixin.SheetImageStaticFileSourceProperty(
        static_file_id="staticFileId"
    )
)

Attributes

sheet_image_static_file_source

The source of the static file that contains the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagesource.html#cfn-quicksight-template-sheetimagesource-sheetimagestaticfilesource

SheetImageStaticFileSourceProperty

class CfnTemplatePropsMixin.SheetImageStaticFileSourceProperty(*, static_file_id=None)

Bases: object

The source of the static file that contains the image.

Parameters:

static_file_id (Optional[str]) – The ID of the static file that contains the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagestaticfilesource.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_image_static_file_source_property = quicksight_mixins.CfnTemplatePropsMixin.SheetImageStaticFileSourceProperty(
    static_file_id="staticFileId"
)

Attributes

static_file_id

The ID of the static file that contains the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagestaticfilesource.html#cfn-quicksight-template-sheetimagestaticfilesource-staticfileid

SheetImageTooltipConfigurationProperty

class CfnTemplatePropsMixin.SheetImageTooltipConfigurationProperty(*, tooltip_text=None, visibility=None)

Bases: object

The tooltip configuration for a sheet image.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagetooltipconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# visibility: Any

sheet_image_tooltip_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SheetImageTooltipConfigurationProperty(
    tooltip_text=quicksight_mixins.CfnTemplatePropsMixin.SheetImageTooltipTextProperty(
        plain_text="plainText"
    ),
    visibility=visibility
)

Attributes

tooltip_text

The text that appears in the tooltip.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagetooltipconfiguration.html#cfn-quicksight-template-sheetimagetooltipconfiguration-tooltiptext

visibility

The visibility of the tooltip.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagetooltipconfiguration.html#cfn-quicksight-template-sheetimagetooltipconfiguration-visibility

SheetImageTooltipTextProperty

class CfnTemplatePropsMixin.SheetImageTooltipTextProperty(*, plain_text=None)

Bases: object

The text that appears in the sheet image tooltip.

Parameters:

plain_text (Optional[str]) – The plain text format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagetooltiptext.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_image_tooltip_text_property = quicksight_mixins.CfnTemplatePropsMixin.SheetImageTooltipTextProperty(
    plain_text="plainText"
)

Attributes

plain_text

The plain text format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetimagetooltiptext.html#cfn-quicksight-template-sheetimagetooltiptext-plaintext

SheetProperty

class CfnTemplatePropsMixin.SheetProperty(*, name=None, sheet_id=None)

Bases: object

A sheet , which is an object that contains a set of visuals that are viewed together on one page in Quick Sight.

Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

Parameters:

  • name (Optional[str]) – The name of a sheet. This name is displayed on the sheet’s tab in the Quick Sight console.

  • sheet_id (Optional[str]) – The unique identifier associated with a sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_property = quicksight_mixins.CfnTemplatePropsMixin.SheetProperty(
    name="name",
    sheet_id="sheetId"
)

Attributes

name

The name of a sheet.

This name is displayed on the sheet’s tab in the Quick Sight console.

See:

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

sheet_id

The unique identifier associated with a sheet.

See:

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

SheetTextBoxProperty

class CfnTemplatePropsMixin.SheetTextBoxProperty(*, content=None, sheet_text_box_id=None)

Bases: object

A text box.

Parameters:

  • content (Optional[str]) – The content that is displayed in the text box.

  • sheet_text_box_id (Optional[str]) – The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheettextbox.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_text_box_property = quicksight_mixins.CfnTemplatePropsMixin.SheetTextBoxProperty(
    content="content",
    sheet_text_box_id="sheetTextBoxId"
)

Attributes

content

The content that is displayed in the text box.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheettextbox.html#cfn-quicksight-template-sheettextbox-content

sheet_text_box_id

The unique identifier for a text box.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheettextbox.html#cfn-quicksight-template-sheettextbox-sheettextboxid

SheetVisualScopingConfigurationProperty

class CfnTemplatePropsMixin.SheetVisualScopingConfigurationProperty(*, scope=None, sheet_id=None, visual_ids=None)

Bases: object

The filter that is applied to the options.

Parameters:

  • scope (Optional[str]) – The scope of the applied entities. Choose one of the following options:. - ALL_VISUALS - SELECTED_VISUALS

  • sheet_id (Optional[str]) – The selected sheet that the filter is applied to.

  • visual_ids (Optional[Sequence[str]]) – The selected visuals that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetvisualscopingconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

sheet_visual_scoping_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.SheetVisualScopingConfigurationProperty(
    scope="scope",
    sheet_id="sheetId",
    visual_ids=["visualIds"]
)

Attributes

scope

.

  • ALL_VISUALS

  • SELECTED_VISUALS

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetvisualscopingconfiguration.html#cfn-quicksight-template-sheetvisualscopingconfiguration-scope

Type:

The scope of the applied entities. Choose one of the following options

sheet_id

The selected sheet that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetvisualscopingconfiguration.html#cfn-quicksight-template-sheetvisualscopingconfiguration-sheetid

visual_ids

The selected visuals that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetvisualscopingconfiguration.html#cfn-quicksight-template-sheetvisualscopingconfiguration-visualids

ShortFormatTextProperty

class CfnTemplatePropsMixin.ShortFormatTextProperty(*, plain_text=None, rich_text=None)

Bases: object

The text format for the title.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • plain_text (Optional[str]) – Plain text format.

  • rich_text (Optional[str]) – Rich text. Examples of rich text include bold, underline, and italics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-shortformattext.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

short_format_text_property = quicksight_mixins.CfnTemplatePropsMixin.ShortFormatTextProperty(
    plain_text="plainText",
    rich_text="richText"
)

Attributes

plain_text

Plain text format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-shortformattext.html#cfn-quicksight-template-shortformattext-plaintext

rich_text

Rich text.

Examples of rich text include bold, underline, and italics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-shortformattext.html#cfn-quicksight-template-shortformattext-richtext

SimpleClusterMarkerProperty

class CfnTemplatePropsMixin.SimpleClusterMarkerProperty(*, color=None)

Bases: object

The simple cluster marker of the cluster marker.

Parameters:

color (Optional[str]) – The color of the simple cluster marker.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-simpleclustermarker.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

simple_cluster_marker_property = quicksight_mixins.CfnTemplatePropsMixin.SimpleClusterMarkerProperty(
    color="color"
)

Attributes

color

The color of the simple cluster marker.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-simpleclustermarker.html#cfn-quicksight-template-simpleclustermarker-color

SingleAxisOptionsProperty

class CfnTemplatePropsMixin.SingleAxisOptionsProperty(*, y_axis_options=None)

Bases: object

The settings of a chart’s single axis configuration.

Parameters:

y_axis_options (Union[IResolvable, YAxisOptionsProperty, Dict[str, Any], None]) – The Y axis options of a single axis configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-singleaxisoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

single_axis_options_property = quicksight_mixins.CfnTemplatePropsMixin.SingleAxisOptionsProperty(
    y_axis_options=quicksight_mixins.CfnTemplatePropsMixin.YAxisOptionsProperty(
        y_axis="yAxis"
    )
)

Attributes

y_axis_options

The Y axis options of a single axis configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-singleaxisoptions.html#cfn-quicksight-template-singleaxisoptions-yaxisoptions

SliderControlDisplayOptionsProperty

class CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(*, info_icon_label_options=None, title_options=None)

Bases: object

The display options of a control.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-slidercontroldisplayoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

slider_control_display_options_property = quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        visibility="visibility"
    )
)

Attributes

info_icon_label_options

The configuration of info icon label options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-slidercontroldisplayoptions.html#cfn-quicksight-template-slidercontroldisplayoptions-infoiconlabeloptions

title_options

The options to configure the title visibility, name, and font size.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-slidercontroldisplayoptions.html#cfn-quicksight-template-slidercontroldisplayoptions-titleoptions

SmallMultiplesAxisPropertiesProperty

class CfnTemplatePropsMixin.SmallMultiplesAxisPropertiesProperty(*, placement=None, scale=None)

Bases: object

Configures the properties of a chart’s axes that are used by small multiples panels.

Parameters:

  • placement (Optional[str]) – Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

  • scale (Optional[str]) – Determines whether scale of the axes are shared or independent. The default value is SHARED .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesaxisproperties.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

small_multiples_axis_properties_property = quicksight_mixins.CfnTemplatePropsMixin.SmallMultiplesAxisPropertiesProperty(
    placement="placement",
    scale="scale"
)

Attributes

placement

Defines the placement of the axis.

By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesaxisproperties.html#cfn-quicksight-template-smallmultiplesaxisproperties-placement

scale

Determines whether scale of the axes are shared or independent.

The default value is SHARED .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesaxisproperties.html#cfn-quicksight-template-smallmultiplesaxisproperties-scale

SmallMultiplesOptionsProperty

class CfnTemplatePropsMixin.SmallMultiplesOptionsProperty(*, max_visible_columns=None, max_visible_rows=None, panel_configuration=None, x_axis=None, y_axis=None)

Bases: object

Options that determine the layout and display options of a chart’s small multiples.

Parameters:

  • max_visible_columns (Union[int, float, None]) – Sets the maximum number of visible columns to display in the grid of small multiples panels. The default is Auto , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

  • max_visible_rows (Union[int, float, None]) – Sets the maximum number of visible rows to display in the grid of small multiples panels. The default value is Auto , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

  • panel_configuration (Union[IResolvable, PanelConfigurationProperty, Dict[str, Any], None]) – Configures the display options for each small multiples panel.

  • x_axis (Union[IResolvable, SmallMultiplesAxisPropertiesProperty, Dict[str, Any], None]) – The properties of a small multiples X axis.

  • y_axis (Union[IResolvable, SmallMultiplesAxisPropertiesProperty, Dict[str, Any], None]) – The properties of a small multiples Y axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

small_multiples_options_property = quicksight_mixins.CfnTemplatePropsMixin.SmallMultiplesOptionsProperty(
    max_visible_columns=123,
    max_visible_rows=123,
    panel_configuration=quicksight_mixins.CfnTemplatePropsMixin.PanelConfigurationProperty(
        background_color="backgroundColor",
        background_visibility="backgroundVisibility",
        border_color="borderColor",
        border_style="borderStyle",
        border_thickness="borderThickness",
        border_visibility="borderVisibility",
        gutter_spacing="gutterSpacing",
        gutter_visibility="gutterVisibility",
        title=quicksight_mixins.CfnTemplatePropsMixin.PanelTitleOptionsProperty(
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            horizontal_text_alignment="horizontalTextAlignment",
            visibility="visibility"
        )
    ),
    x_axis=quicksight_mixins.CfnTemplatePropsMixin.SmallMultiplesAxisPropertiesProperty(
        placement="placement",
        scale="scale"
    ),
    y_axis=quicksight_mixins.CfnTemplatePropsMixin.SmallMultiplesAxisPropertiesProperty(
        placement="placement",
        scale="scale"
    )
)

Attributes

max_visible_columns

Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html#cfn-quicksight-template-smallmultiplesoptions-maxvisiblecolumns

max_visible_rows

Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html#cfn-quicksight-template-smallmultiplesoptions-maxvisiblerows

panel_configuration

Configures the display options for each small multiples panel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html#cfn-quicksight-template-smallmultiplesoptions-panelconfiguration

x_axis

The properties of a small multiples X axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html#cfn-quicksight-template-smallmultiplesoptions-xaxis

y_axis

The properties of a small multiples Y axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-smallmultiplesoptions.html#cfn-quicksight-template-smallmultiplesoptions-yaxis

SpacingProperty

class CfnTemplatePropsMixin.SpacingProperty(*, bottom=None, left=None, right=None, top=None)

Bases: object

The configuration of spacing (often a margin or padding).

Parameters:

  • bottom (Optional[str]) – Define the bottom spacing.

  • left (Optional[str]) – Define the left spacing.

  • right (Optional[str]) – Define the right spacing.

  • top (Optional[str]) – Define the top spacing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-spacing.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

spacing_property = quicksight_mixins.CfnTemplatePropsMixin.SpacingProperty(
    bottom="bottom",
    left="left",
    right="right",
    top="top"
)

Attributes

bottom

Define the bottom spacing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-spacing.html#cfn-quicksight-template-spacing-bottom

left

Define the left spacing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-spacing.html#cfn-quicksight-template-spacing-left

right

Define the right spacing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-spacing.html#cfn-quicksight-template-spacing-right

top

Define the top spacing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-spacing.html#cfn-quicksight-template-spacing-top

StringDefaultValuesProperty

class CfnTemplatePropsMixin.StringDefaultValuesProperty(*, dynamic_value=None, static_values=None)

Bases: object

The default values of the StringParameterDeclaration .

Parameters:

  • dynamic_value (Union[IResolvable, DynamicDefaultValueProperty, Dict[str, Any], None]) – The dynamic value of the StringDefaultValues . Different defaults displayed according to users, groups, and values mapping.

  • static_values (Optional[Sequence[str]]) – The static values of the DecimalDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringdefaultvalues.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

string_default_values_property = quicksight_mixins.CfnTemplatePropsMixin.StringDefaultValuesProperty(
    dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
        default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    ),
    static_values=["staticValues"]
)

Attributes

dynamic_value

The dynamic value of the StringDefaultValues .

Different defaults displayed according to users, groups, and values mapping.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringdefaultvalues.html#cfn-quicksight-template-stringdefaultvalues-dynamicvalue

static_values

The static values of the DecimalDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringdefaultvalues.html#cfn-quicksight-template-stringdefaultvalues-staticvalues

StringFormatConfigurationProperty

class CfnTemplatePropsMixin.StringFormatConfigurationProperty(*, null_value_format_configuration=None, numeric_format_configuration=None)

Bases: object

Formatting configuration for string fields.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringformatconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

string_format_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
        currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix",
            symbol="symbol"
        ),
        number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        )
    )
)

Attributes

null_value_format_configuration

The options that determine the null value format configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringformatconfiguration.html#cfn-quicksight-template-stringformatconfiguration-nullvalueformatconfiguration

numeric_format_configuration

The formatting configuration for numeric strings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringformatconfiguration.html#cfn-quicksight-template-stringformatconfiguration-numericformatconfiguration

StringParameterDeclarationProperty

class CfnTemplatePropsMixin.StringParameterDeclarationProperty(*, default_values=None, mapped_data_set_parameters=None, name=None, parameter_value_type=None, value_when_unset=None)

Bases: object

A parameter declaration for the String data type.

Parameters:

  • default_values (Union[IResolvable, StringDefaultValuesProperty, Dict[str, Any], None]) – The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

  • mapped_data_set_parameters (Union[IResolvable, Sequence[Union[IResolvable, MappedDataSetParameterProperty, Dict[str, Any]]], None])

  • name (Optional[str]) – The name of the parameter that is being declared.

  • parameter_value_type (Optional[str]) – The value type determines whether the parameter is a single-value or multi-value parameter.

  • value_when_unset (Union[IResolvable, StringValueWhenUnsetConfigurationProperty, Dict[str, Any], None]) – The configuration that defines the default value of a String parameter when a value has not been set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

string_parameter_declaration_property = quicksight_mixins.CfnTemplatePropsMixin.StringParameterDeclarationProperty(
    default_values=quicksight_mixins.CfnTemplatePropsMixin.StringDefaultValuesProperty(
        dynamic_value=quicksight_mixins.CfnTemplatePropsMixin.DynamicDefaultValueProperty(
            default_value_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            group_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            user_name_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        static_values=["staticValues"]
    ),
    mapped_data_set_parameters=[quicksight_mixins.CfnTemplatePropsMixin.MappedDataSetParameterProperty(
        data_set_identifier="dataSetIdentifier",
        data_set_parameter_name="dataSetParameterName"
    )],
    name="name",
    parameter_value_type="parameterValueType",
    value_when_unset=quicksight_mixins.CfnTemplatePropsMixin.StringValueWhenUnsetConfigurationProperty(
        custom_value="customValue",
        value_when_unset_option="valueWhenUnsetOption"
    )
)

Attributes

default_values

The default values of a parameter.

If the parameter is a single-value parameter, a maximum of one default value can be provided.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-defaultvalues

mapped_data_set_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-mappeddatasetparameters

Type:

see

name

The name of the parameter that is being declared.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-name

parameter_value_type

The value type determines whether the parameter is a single-value or multi-value parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-parametervaluetype

value_when_unset

The configuration that defines the default value of a String parameter when a value has not been set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringparameterdeclaration.html#cfn-quicksight-template-stringparameterdeclaration-valuewhenunset

StringValueWhenUnsetConfigurationProperty

class CfnTemplatePropsMixin.StringValueWhenUnsetConfigurationProperty(*, custom_value=None, value_when_unset_option=None)

Bases: object

The configuration that defines the default value of a String parameter when a value has not been set.

Parameters:

  • custom_value (Optional[str]) – A custom value that’s used when the value of a parameter isn’t set.

  • value_when_unset_option (Optional[str]) – The built-in options for default values. The value can be one of the following:. - RECOMMENDED : The recommended value. - NULL : The NULL value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringvaluewhenunsetconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

string_value_when_unset_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.StringValueWhenUnsetConfigurationProperty(
    custom_value="customValue",
    value_when_unset_option="valueWhenUnsetOption"
)

Attributes

custom_value

A custom value that’s used when the value of a parameter isn’t set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringvaluewhenunsetconfiguration.html#cfn-quicksight-template-stringvaluewhenunsetconfiguration-customvalue

value_when_unset_option

.

  • RECOMMENDED : The recommended value.

  • NULL : The NULL value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-stringvaluewhenunsetconfiguration.html#cfn-quicksight-template-stringvaluewhenunsetconfiguration-valuewhenunsetoption

Type:

The built-in options for default values. The value can be one of the following

SubtotalOptionsProperty

class CfnTemplatePropsMixin.SubtotalOptionsProperty(*, custom_label=None, field_level=None, field_level_options=None, metric_header_cell_style=None, style_targets=None, total_cell_style=None, totals_visibility=None, value_cell_style=None)

Bases: object

The subtotal options.

Parameters:

  • custom_label (Optional[str]) – The custom label string for the subtotal cells.

  • field_level (Optional[str]) – The field level (all, custom, last) for the subtotal cells.

  • field_level_options (Union[IResolvable, Sequence[Union[IResolvable, PivotTableFieldSubtotalOptionsProperty, Dict[str, Any]]], None]) – The optional configuration of subtotal cells.

  • metric_header_cell_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – The cell styling options for the subtotals of header cells.

  • style_targets (Union[IResolvable, Sequence[Union[IResolvable, TableStyleTargetProperty, Dict[str, Any]]], None]) – The style targets options for subtotals.

  • total_cell_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – The cell styling options for the subtotal cells.

  • totals_visibility (Optional[str]) – The visibility configuration for the subtotal cells.

  • value_cell_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – The cell styling options for the subtotals of value cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

subtotal_options_property = quicksight_mixins.CfnTemplatePropsMixin.SubtotalOptionsProperty(
    custom_label="customLabel",
    field_level="fieldLevel",
    field_level_options=[quicksight_mixins.CfnTemplatePropsMixin.PivotTableFieldSubtotalOptionsProperty(
        field_id="fieldId"
    )],
    metric_header_cell_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    style_targets=[quicksight_mixins.CfnTemplatePropsMixin.TableStyleTargetProperty(
        cell_type="cellType"
    )],
    total_cell_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    totals_visibility="totalsVisibility",
    value_cell_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    )
)

Attributes

custom_label

The custom label string for the subtotal cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-customlabel

field_level

The field level (all, custom, last) for the subtotal cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-fieldlevel

field_level_options

The optional configuration of subtotal cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-fieldleveloptions

metric_header_cell_style

The cell styling options for the subtotals of header cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-metricheadercellstyle

style_targets

The style targets options for subtotals.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-styletargets

total_cell_style

The cell styling options for the subtotal cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-totalcellstyle

totals_visibility

The visibility configuration for the subtotal cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-totalsvisibility

value_cell_style

The cell styling options for the subtotals of value cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-subtotaloptions.html#cfn-quicksight-template-subtotaloptions-valuecellstyle

TableAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.TableAggregatedFieldWellsProperty(*, group_by=None, values=None)

Bases: object

The aggregated field well for the table.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
group_by

The group by field well for a pivot table.

Values are grouped by group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableaggregatedfieldwells.html#cfn-quicksight-template-tableaggregatedfieldwells-groupby

values

The values field well for a pivot table.

Values are aggregated based on group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableaggregatedfieldwells.html#cfn-quicksight-template-tableaggregatedfieldwells-values

TableBorderOptionsProperty

class CfnTemplatePropsMixin.TableBorderOptionsProperty(*, color=None, style=None, thickness=None)

Bases: object

The border options for a table border.

Parameters:

  • color (Optional[str]) – The color of a table border.

  • style (Optional[str]) – The style (none, solid) of a table border.

  • thickness (Union[int, float, None]) – The thickness of a table border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableborderoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_border_options_property = quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
    color="color",
    style="style",
    thickness=123
)

Attributes

color

The color of a table border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableborderoptions.html#cfn-quicksight-template-tableborderoptions-color

style

The style (none, solid) of a table border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableborderoptions.html#cfn-quicksight-template-tableborderoptions-style

thickness

The thickness of a table border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableborderoptions.html#cfn-quicksight-template-tableborderoptions-thickness

TableCellConditionalFormattingProperty

class CfnTemplatePropsMixin.TableCellConditionalFormattingProperty(*, field_id=None, text_format=None)

Bases: object

The cell conditional formatting option for a table.

Parameters:

  • field_id (Optional[str]) – The field ID of the cell for conditional formatting.

  • text_format (Union[IResolvable, TextConditionalFormatProperty, Dict[str, Any], None]) – The text format of the cell for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_cell_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.TableCellConditionalFormattingProperty(
    field_id="fieldId",
    text_format=quicksight_mixins.CfnTemplatePropsMixin.TextConditionalFormatProperty(
        background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        ),
        icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
            custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                color="color",
                display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                ),
                expression="expression",
                icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                )
            ),
            icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                expression="expression",
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        )
    )
)

Attributes

field_id

The field ID of the cell for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellconditionalformatting.html#cfn-quicksight-template-tablecellconditionalformatting-fieldid

text_format

The text format of the cell for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellconditionalformatting.html#cfn-quicksight-template-tablecellconditionalformatting-textformat

TableCellImageSizingConfigurationProperty

class CfnTemplatePropsMixin.TableCellImageSizingConfigurationProperty(*, table_cell_image_scaling_configuration=None)

Bases: object

The sizing options for the table image configuration.

Parameters:

table_cell_image_scaling_configuration (Optional[str]) – The cell scaling configuration of the sizing options for the table image configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellimagesizingconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_cell_image_sizing_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.TableCellImageSizingConfigurationProperty(
    table_cell_image_scaling_configuration="tableCellImageScalingConfiguration"
)

Attributes

table_cell_image_scaling_configuration

The cell scaling configuration of the sizing options for the table image configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellimagesizingconfiguration.html#cfn-quicksight-template-tablecellimagesizingconfiguration-tablecellimagescalingconfiguration

TableCellStyleProperty

class CfnTemplatePropsMixin.TableCellStyleProperty(*, background_color=None, border=None, font_configuration=None, height=None, horizontal_text_alignment=None, text_wrap=None, vertical_text_alignment=None, visibility=None)

Bases: object

The table cell style for a cell in pivot table or table visual.

Parameters:

  • background_color (Optional[str]) – The background color for the table cells.

  • border (Union[IResolvable, GlobalTableBorderOptionsProperty, Dict[str, Any], None]) – The borders for the table cells.

  • font_configuration (Union[IResolvable, FontConfigurationProperty, Dict[str, Any], None]) – The font configuration of the table cells.

  • height (Union[int, float, None]) – The height color for the table cells.

  • horizontal_text_alignment (Optional[str]) – The horizontal text alignment (left, center, right, auto) for the table cells.

  • text_wrap (Optional[str]) – The text wrap (none, wrap) for the table cells.

  • vertical_text_alignment (Optional[str]) – The vertical text alignment (top, middle, bottom) for the table cells.

  • visibility (Optional[str]) – The visibility of the table cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_cell_style_property = quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
    background_color="backgroundColor",
    border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
        side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
            bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            ),
            inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            ),
            inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            ),
            left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            ),
            right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            ),
            top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        )
    ),
    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    ),
    height=123,
    horizontal_text_alignment="horizontalTextAlignment",
    text_wrap="textWrap",
    vertical_text_alignment="verticalTextAlignment",
    visibility="visibility"
)

Attributes

background_color

The background color for the table cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-backgroundcolor

border

The borders for the table cells.

See:

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

font_configuration

The font configuration of the table cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-fontconfiguration

height

The height color for the table cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-height

horizontal_text_alignment

The horizontal text alignment (left, center, right, auto) for the table cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-horizontaltextalignment

text_wrap

The text wrap (none, wrap) for the table cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-textwrap

vertical_text_alignment

The vertical text alignment (top, middle, bottom) for the table cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-verticaltextalignment

visibility

The visibility of the table cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablecellstyle.html#cfn-quicksight-template-tablecellstyle-visibility

TableConditionalFormattingOptionProperty

class CfnTemplatePropsMixin.TableConditionalFormattingOptionProperty(*, cell=None, row=None)

Bases: object

Conditional formatting options for a PivotTableVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconditionalformattingoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_conditional_formatting_option_property = quicksight_mixins.CfnTemplatePropsMixin.TableConditionalFormattingOptionProperty(
    cell=quicksight_mixins.CfnTemplatePropsMixin.TableCellConditionalFormattingProperty(
        field_id="fieldId",
        text_format=quicksight_mixins.CfnTemplatePropsMixin.TextConditionalFormatProperty(
            background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            ),
            icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
                custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                    color="color",
                    display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    ),
                    expression="expression",
                    icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    )
                ),
                icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                    expression="expression",
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            )
        )
    ),
    row=quicksight_mixins.CfnTemplatePropsMixin.TableRowConditionalFormattingProperty(
        background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        ),
        text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
            gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                    stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                        color="color",
                        data_value=123,
                        gradient_offset=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                color="color",
                expression="expression"
            )
        )
    )
)

Attributes

cell

The cell conditional formatting option for a table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconditionalformattingoption.html#cfn-quicksight-template-tableconditionalformattingoption-cell

row

The row conditional formatting option for a table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconditionalformattingoption.html#cfn-quicksight-template-tableconditionalformattingoption-row

TableConditionalFormattingProperty

class CfnTemplatePropsMixin.TableConditionalFormattingProperty(*, conditional_formatting_options=None)

Bases: object

The conditional formatting for a PivotTableVisual .

Parameters:

conditional_formatting_options (Union[IResolvable, Sequence[Union[IResolvable, TableConditionalFormattingOptionProperty, Dict[str, Any]]], None]) – Conditional formatting options for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.TableConditionalFormattingProperty(
    conditional_formatting_options=[quicksight_mixins.CfnTemplatePropsMixin.TableConditionalFormattingOptionProperty(
        cell=quicksight_mixins.CfnTemplatePropsMixin.TableCellConditionalFormattingProperty(
            field_id="fieldId",
            text_format=quicksight_mixins.CfnTemplatePropsMixin.TextConditionalFormatProperty(
                background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                    gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                        color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                            stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                                color="color",
                                data_value=123,
                                gradient_offset=123
                            )]
                        ),
                        expression="expression"
                    ),
                    solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                        color="color",
                        expression="expression"
                    )
                ),
                icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
                    custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
                        color="color",
                        display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                            icon_display_option="iconDisplayOption"
                        ),
                        expression="expression",
                        icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                            icon="icon",
                            unicode_icon="unicodeIcon"
                        )
                    ),
                    icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
                        expression="expression",
                        icon_set_type="iconSetType"
                    )
                ),
                text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                    gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                        color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                            stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                                color="color",
                                data_value=123,
                                gradient_offset=123
                            )]
                        ),
                        expression="expression"
                    ),
                    solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                        color="color",
                        expression="expression"
                    )
                )
            )
        ),
        row=quicksight_mixins.CfnTemplatePropsMixin.TableRowConditionalFormattingProperty(
            background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            ),
            text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
                gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
                    color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                        stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                            color="color",
                            data_value=123,
                            gradient_offset=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
                    color="color",
                    expression="expression"
                )
            )
        )
    )]
)

Attributes

conditional_formatting_options

Conditional formatting options for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconditionalformatting.html#cfn-quicksight-template-tableconditionalformatting-conditionalformattingoptions

TableConfigurationProperty

class CfnTemplatePropsMixin.TableConfigurationProperty(*, field_options=None, field_wells=None, interactions=None, paginated_report_options=None, sort_configuration=None, table_inline_visualizations=None, table_options=None, total_options=None)

Bases: object

The configuration for a TableVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
field_options

The field options for a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-fieldoptions

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-interactions

paginated_report_options

The paginated report options for a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-paginatedreportoptions

sort_configuration

The sort configuration for a TableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-sortconfiguration

table_inline_visualizations

A collection of inline visualizations to display within a chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-tableinlinevisualizations

table_options

The table options for a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-tableoptions

total_options

The total options for a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableconfiguration.html#cfn-quicksight-template-tableconfiguration-totaloptions

TableFieldCustomIconContentProperty

class CfnTemplatePropsMixin.TableFieldCustomIconContentProperty(*, icon=None)

Bases: object

The custom icon content for the table link content configuration.

Parameters:

icon (Optional[str]) – The icon set type (link) of the custom icon content for table URL link content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldcustomiconcontent.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_field_custom_icon_content_property = quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomIconContentProperty(
    icon="icon"
)

Attributes

icon

The icon set type (link) of the custom icon content for table URL link content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldcustomiconcontent.html#cfn-quicksight-template-tablefieldcustomiconcontent-icon

TableFieldCustomTextContentProperty

class CfnTemplatePropsMixin.TableFieldCustomTextContentProperty(*, font_configuration=None, value=None)

Bases: object

The custom text content (value, font configuration) for the table link content configuration.

Parameters:

  • font_configuration (Union[IResolvable, FontConfigurationProperty, Dict[str, Any], None]) – The font configuration of the custom text content for the table URL link content.

  • value (Optional[str]) – The string value of the custom text content for the table URL link content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldcustomtextcontent.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_field_custom_text_content_property = quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomTextContentProperty(
    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
            name="name"
        )
    ),
    value="value"
)

Attributes

font_configuration

The font configuration of the custom text content for the table URL link content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldcustomtextcontent.html#cfn-quicksight-template-tablefieldcustomtextcontent-fontconfiguration

value

The string value of the custom text content for the table URL link content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldcustomtextcontent.html#cfn-quicksight-template-tablefieldcustomtextcontent-value

TableFieldImageConfigurationProperty

class CfnTemplatePropsMixin.TableFieldImageConfigurationProperty(*, sizing_options=None)

Bases: object

The image configuration of a table field URL.

Parameters:

sizing_options (Union[IResolvable, TableCellImageSizingConfigurationProperty, Dict[str, Any], None]) – The sizing options for the table image configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldimageconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_field_image_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.TableFieldImageConfigurationProperty(
    sizing_options=quicksight_mixins.CfnTemplatePropsMixin.TableCellImageSizingConfigurationProperty(
        table_cell_image_scaling_configuration="tableCellImageScalingConfiguration"
    )
)

Attributes

sizing_options

The sizing options for the table image configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldimageconfiguration.html#cfn-quicksight-template-tablefieldimageconfiguration-sizingoptions

TableFieldLinkConfigurationProperty

class CfnTemplatePropsMixin.TableFieldLinkConfigurationProperty(*, content=None, target=None)

Bases: object

The link configuration of a table field URL.

Parameters:

  • content (Union[IResolvable, TableFieldLinkContentConfigurationProperty, Dict[str, Any], None]) – The URL content (text, icon) for the table link configuration.

  • target (Optional[str]) – The URL target (new tab, new window, same tab) for the table link configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_field_link_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.TableFieldLinkConfigurationProperty(
    content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldLinkContentConfigurationProperty(
        custom_icon_content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomIconContentProperty(
            icon="icon"
        ),
        custom_text_content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomTextContentProperty(
            font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_family="fontFamily",
                font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                    absolute="absolute",
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                    name="name"
                )
            ),
            value="value"
        )
    ),
    target="target"
)

Attributes

content

The URL content (text, icon) for the table link configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkconfiguration.html#cfn-quicksight-template-tablefieldlinkconfiguration-content

target

The URL target (new tab, new window, same tab) for the table link configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkconfiguration.html#cfn-quicksight-template-tablefieldlinkconfiguration-target

TableFieldLinkContentConfigurationProperty

class CfnTemplatePropsMixin.TableFieldLinkContentConfigurationProperty(*, custom_icon_content=None, custom_text_content=None)

Bases: object

The URL content (text, icon) for the table link configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkcontentconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_field_link_content_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.TableFieldLinkContentConfigurationProperty(
    custom_icon_content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomIconContentProperty(
        icon="icon"
    ),
    custom_text_content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomTextContentProperty(
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        value="value"
    )
)

Attributes

custom_icon_content

The custom icon content for the table link content configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkcontentconfiguration.html#cfn-quicksight-template-tablefieldlinkcontentconfiguration-customiconcontent

custom_text_content

The custom text content (value, font configuration) for the table link content configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldlinkcontentconfiguration.html#cfn-quicksight-template-tablefieldlinkcontentconfiguration-customtextcontent

TableFieldOptionProperty

class CfnTemplatePropsMixin.TableFieldOptionProperty(*, custom_label=None, field_id=None, url_styling=None, visibility=None, width=None)

Bases: object

The options for a table field.

Parameters:

  • custom_label (Optional[str]) – The custom label for a table field.

  • field_id (Optional[str]) – The field ID for a table field.

  • url_styling (Union[IResolvable, TableFieldURLConfigurationProperty, Dict[str, Any], None]) – The URL configuration for a table field.

  • visibility (Optional[str]) – The visibility of a table field.

  • width (Optional[str]) – The width for a table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_field_option_property = quicksight_mixins.CfnTemplatePropsMixin.TableFieldOptionProperty(
    custom_label="customLabel",
    field_id="fieldId",
    url_styling=quicksight_mixins.CfnTemplatePropsMixin.TableFieldURLConfigurationProperty(
        image_configuration=quicksight_mixins.CfnTemplatePropsMixin.TableFieldImageConfigurationProperty(
            sizing_options=quicksight_mixins.CfnTemplatePropsMixin.TableCellImageSizingConfigurationProperty(
                table_cell_image_scaling_configuration="tableCellImageScalingConfiguration"
            )
        ),
        link_configuration=quicksight_mixins.CfnTemplatePropsMixin.TableFieldLinkConfigurationProperty(
            content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldLinkContentConfigurationProperty(
                custom_icon_content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomIconContentProperty(
                    icon="icon"
                ),
                custom_text_content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomTextContentProperty(
                    font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_family="fontFamily",
                        font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                            absolute="absolute",
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                            name="name"
                        )
                    ),
                    value="value"
                )
            ),
            target="target"
        )
    ),
    visibility="visibility",
    width="width"
)

Attributes

custom_label

The custom label for a table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html#cfn-quicksight-template-tablefieldoption-customlabel

field_id

The field ID for a table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html#cfn-quicksight-template-tablefieldoption-fieldid

url_styling

The URL configuration for a table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html#cfn-quicksight-template-tablefieldoption-urlstyling

visibility

The visibility of a table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html#cfn-quicksight-template-tablefieldoption-visibility

width

The width for a table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoption.html#cfn-quicksight-template-tablefieldoption-width

TableFieldOptionsProperty

class CfnTemplatePropsMixin.TableFieldOptionsProperty(*, order=None, pinned_field_options=None, selected_field_options=None, transposed_table_options=None)

Bases: object

The field options of a table visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_field_options_property = quicksight_mixins.CfnTemplatePropsMixin.TableFieldOptionsProperty(
    order=["order"],
    pinned_field_options=quicksight_mixins.CfnTemplatePropsMixin.TablePinnedFieldOptionsProperty(
        pinned_left_fields=["pinnedLeftFields"]
    ),
    selected_field_options=[quicksight_mixins.CfnTemplatePropsMixin.TableFieldOptionProperty(
        custom_label="customLabel",
        field_id="fieldId",
        url_styling=quicksight_mixins.CfnTemplatePropsMixin.TableFieldURLConfigurationProperty(
            image_configuration=quicksight_mixins.CfnTemplatePropsMixin.TableFieldImageConfigurationProperty(
                sizing_options=quicksight_mixins.CfnTemplatePropsMixin.TableCellImageSizingConfigurationProperty(
                    table_cell_image_scaling_configuration="tableCellImageScalingConfiguration"
                )
            ),
            link_configuration=quicksight_mixins.CfnTemplatePropsMixin.TableFieldLinkConfigurationProperty(
                content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldLinkContentConfigurationProperty(
                    custom_icon_content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomIconContentProperty(
                        icon="icon"
                    ),
                    custom_text_content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomTextContentProperty(
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        value="value"
                    )
                ),
                target="target"
            )
        ),
        visibility="visibility",
        width="width"
    )],
    transposed_table_options=[quicksight_mixins.CfnTemplatePropsMixin.TransposedTableOptionProperty(
        column_index=123,
        column_type="columnType",
        column_width="columnWidth"
    )]
)

Attributes

order

The order of the field IDs that are configured as field options for a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoptions.html#cfn-quicksight-template-tablefieldoptions-order

pinned_field_options

The settings for the pinned columns of a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoptions.html#cfn-quicksight-template-tablefieldoptions-pinnedfieldoptions

selected_field_options

The field options to be configured to a table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoptions.html#cfn-quicksight-template-tablefieldoptions-selectedfieldoptions

transposed_table_options

The TableOptions of a transposed table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldoptions.html#cfn-quicksight-template-tablefieldoptions-transposedtableoptions

TableFieldURLConfigurationProperty

class CfnTemplatePropsMixin.TableFieldURLConfigurationProperty(*, image_configuration=None, link_configuration=None)

Bases: object

The URL configuration for a table field.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldurlconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_field_uRLConfiguration_property = quicksight_mixins.CfnTemplatePropsMixin.TableFieldURLConfigurationProperty(
    image_configuration=quicksight_mixins.CfnTemplatePropsMixin.TableFieldImageConfigurationProperty(
        sizing_options=quicksight_mixins.CfnTemplatePropsMixin.TableCellImageSizingConfigurationProperty(
            table_cell_image_scaling_configuration="tableCellImageScalingConfiguration"
        )
    ),
    link_configuration=quicksight_mixins.CfnTemplatePropsMixin.TableFieldLinkConfigurationProperty(
        content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldLinkContentConfigurationProperty(
            custom_icon_content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomIconContentProperty(
                icon="icon"
            ),
            custom_text_content=quicksight_mixins.CfnTemplatePropsMixin.TableFieldCustomTextContentProperty(
                font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_family="fontFamily",
                    font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                        absolute="absolute",
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                        name="name"
                    )
                ),
                value="value"
            )
        ),
        target="target"
    )
)

Attributes

image_configuration

The image configuration of a table field URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldurlconfiguration.html#cfn-quicksight-template-tablefieldurlconfiguration-imageconfiguration

The link configuration of a table field URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldurlconfiguration.html#cfn-quicksight-template-tablefieldurlconfiguration-linkconfiguration

TableFieldWellsProperty

class CfnTemplatePropsMixin.TableFieldWellsProperty(*, table_aggregated_field_wells=None, table_unaggregated_field_wells=None)

Bases: object

The field wells for a table visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
table_aggregated_field_wells

The aggregated field well for the table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldwells.html#cfn-quicksight-template-tablefieldwells-tableaggregatedfieldwells

table_unaggregated_field_wells

The unaggregated field well for the table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablefieldwells.html#cfn-quicksight-template-tablefieldwells-tableunaggregatedfieldwells

TableInlineVisualizationProperty

class CfnTemplatePropsMixin.TableInlineVisualizationProperty(*, data_bars=None)

Bases: object

The inline visualization of a specific type to display within a chart.

Parameters:

data_bars (Union[IResolvable, DataBarsOptionsProperty, Dict[str, Any], None]) – The configuration of the inline visualization of the data bars within a chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableinlinevisualization.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_inline_visualization_property = quicksight_mixins.CfnTemplatePropsMixin.TableInlineVisualizationProperty(
    data_bars=quicksight_mixins.CfnTemplatePropsMixin.DataBarsOptionsProperty(
        field_id="fieldId",
        negative_color="negativeColor",
        positive_color="positiveColor"
    )
)

Attributes

data_bars

The configuration of the inline visualization of the data bars within a chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableinlinevisualization.html#cfn-quicksight-template-tableinlinevisualization-databars

TableOptionsProperty

class CfnTemplatePropsMixin.TableOptionsProperty(*, cell_style=None, header_style=None, orientation=None, row_alternate_color_options=None)

Bases: object

The table options for a table visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_options_property = quicksight_mixins.CfnTemplatePropsMixin.TableOptionsProperty(
    cell_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    header_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    orientation="orientation",
    row_alternate_color_options=quicksight_mixins.CfnTemplatePropsMixin.RowAlternateColorOptionsProperty(
        row_alternate_colors=["rowAlternateColors"],
        status="status",
        use_primary_background_color="usePrimaryBackgroundColor"
    )
)

Attributes

cell_style

The table cell style of table cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableoptions.html#cfn-quicksight-template-tableoptions-cellstyle

header_style

The table cell style of a table header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableoptions.html#cfn-quicksight-template-tableoptions-headerstyle

orientation

The orientation (vertical, horizontal) for a table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableoptions.html#cfn-quicksight-template-tableoptions-orientation

row_alternate_color_options

The row alternate color options (widget status, row alternate colors) for a table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableoptions.html#cfn-quicksight-template-tableoptions-rowalternatecoloroptions

TablePaginatedReportOptionsProperty

class CfnTemplatePropsMixin.TablePaginatedReportOptionsProperty(*, overflow_column_header_visibility=None, vertical_overflow_visibility=None)

Bases: object

The paginated report options for a table visual.

Parameters:

  • overflow_column_header_visibility (Optional[str]) – The visibility of repeating header rows on each page.

  • vertical_overflow_visibility (Optional[str]) – The visibility of printing table overflow across pages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablepaginatedreportoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_paginated_report_options_property = quicksight_mixins.CfnTemplatePropsMixin.TablePaginatedReportOptionsProperty(
    overflow_column_header_visibility="overflowColumnHeaderVisibility",
    vertical_overflow_visibility="verticalOverflowVisibility"
)

Attributes

overflow_column_header_visibility

The visibility of repeating header rows on each page.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablepaginatedreportoptions.html#cfn-quicksight-template-tablepaginatedreportoptions-overflowcolumnheadervisibility

vertical_overflow_visibility

The visibility of printing table overflow across pages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablepaginatedreportoptions.html#cfn-quicksight-template-tablepaginatedreportoptions-verticaloverflowvisibility

TablePinnedFieldOptionsProperty

class CfnTemplatePropsMixin.TablePinnedFieldOptionsProperty(*, pinned_left_fields=None)

Bases: object

The settings for the pinned columns of a table visual.

Parameters:

pinned_left_fields (Optional[Sequence[str]]) – A list of columns to be pinned to the left of a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablepinnedfieldoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_pinned_field_options_property = quicksight_mixins.CfnTemplatePropsMixin.TablePinnedFieldOptionsProperty(
    pinned_left_fields=["pinnedLeftFields"]
)

Attributes

pinned_left_fields

A list of columns to be pinned to the left of a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablepinnedfieldoptions.html#cfn-quicksight-template-tablepinnedfieldoptions-pinnedleftfields

TableRowConditionalFormattingProperty

class CfnTemplatePropsMixin.TableRowConditionalFormattingProperty(*, background_color=None, text_color=None)

Bases: object

The conditional formatting of a table row.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablerowconditionalformatting.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_row_conditional_formatting_property = quicksight_mixins.CfnTemplatePropsMixin.TableRowConditionalFormattingProperty(
    background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    ),
    text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    )
)

Attributes

background_color

The conditional formatting color (solid, gradient) of the background for a table row.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablerowconditionalformatting.html#cfn-quicksight-template-tablerowconditionalformatting-backgroundcolor

text_color

The conditional formatting color (solid, gradient) of the text for a table row.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablerowconditionalformatting.html#cfn-quicksight-template-tablerowconditionalformatting-textcolor

TableSideBorderOptionsProperty

class CfnTemplatePropsMixin.TableSideBorderOptionsProperty(*, bottom=None, inner_horizontal=None, inner_vertical=None, left=None, right=None, top=None)

Bases: object

The side border options for a table.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_side_border_options_property = quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
    bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    ),
    inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    ),
    inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    ),
    left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    ),
    right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    ),
    top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    )
)

Attributes

bottom

The table border options of the bottom border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-bottom

inner_horizontal

The table border options of the inner horizontal border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-innerhorizontal

inner_vertical

The table border options of the inner vertical border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-innervertical

left

The table border options of the left border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-left

right

The table border options of the right border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-right

top

The table border options of the top border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesideborderoptions.html#cfn-quicksight-template-tablesideborderoptions-top

TableSortConfigurationProperty

class CfnTemplatePropsMixin.TableSortConfigurationProperty(*, pagination_configuration=None, row_sort=None)

Bases: object

The sort configuration for a TableVisual .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.TableSortConfigurationProperty(
    pagination_configuration=quicksight_mixins.CfnTemplatePropsMixin.PaginationConfigurationProperty(
        page_number=123,
        page_size=123
    ),
    row_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

pagination_configuration

The pagination configuration (page size, page number) for the table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesortconfiguration.html#cfn-quicksight-template-tablesortconfiguration-paginationconfiguration

row_sort

The field sort options for rows in the table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablesortconfiguration.html#cfn-quicksight-template-tablesortconfiguration-rowsort

TableStyleTargetProperty

class CfnTemplatePropsMixin.TableStyleTargetProperty(*, cell_type=None)

Bases: object

The table style target.

Parameters:

cell_type (Optional[str]) – The cell type of the table style target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablestyletarget.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_style_target_property = quicksight_mixins.CfnTemplatePropsMixin.TableStyleTargetProperty(
    cell_type="cellType"
)

Attributes

cell_type

The cell type of the table style target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablestyletarget.html#cfn-quicksight-template-tablestyletarget-celltype

TableUnaggregatedFieldWellsProperty

class CfnTemplatePropsMixin.TableUnaggregatedFieldWellsProperty(*, values=None)

Bases: object

The unaggregated field well for the table.

Parameters:

values (Union[IResolvable, Sequence[Union[IResolvable, UnaggregatedFieldProperty, Dict[str, Any]]], None]) – The values field well for a pivot table. Values are unaggregated for an unaggregated table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableunaggregatedfieldwells.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

table_unaggregated_field_wells_property = quicksight_mixins.CfnTemplatePropsMixin.TableUnaggregatedFieldWellsProperty(
    values=[quicksight_mixins.CfnTemplatePropsMixin.UnaggregatedFieldProperty(
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",
        format_configuration=quicksight_mixins.CfnTemplatePropsMixin.FormatConfigurationProperty(
            date_time_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            number_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
                format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            string_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        )
    )]
)

Attributes

values

The values field well for a pivot table.

Values are unaggregated for an unaggregated table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tableunaggregatedfieldwells.html#cfn-quicksight-template-tableunaggregatedfieldwells-values

TableVisualProperty

class CfnTemplatePropsMixin.TableVisualProperty(*, actions=None, chart_configuration=None, conditional_formatting=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A table visual.

For more information, see Using tables as visuals in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-chartconfiguration

conditional_formatting

The conditional formatting for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-conditionalformatting

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tablevisual.html#cfn-quicksight-template-tablevisual-visualid

TemplateErrorProperty

class CfnTemplatePropsMixin.TemplateErrorProperty(*, message=None, type=None, violated_entities=None)

Bases: object

List of errors that occurred when the template version creation failed.

Parameters:

  • message (Optional[str]) – Description of the error type.

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

  • violated_entities (Union[IResolvable, Sequence[Union[IResolvable, EntityProperty, Dict[str, Any]]], None]) – An error path that shows which entities caused the template error.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

template_error_property = quicksight_mixins.CfnTemplatePropsMixin.TemplateErrorProperty(
    message="message",
    type="type",
    violated_entities=[quicksight_mixins.CfnTemplatePropsMixin.EntityProperty(
        path="path"
    )]
)

Attributes

message

Description of the error type.

See:

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

type

Type of error.

See:

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

violated_entities

An error path that shows which entities caused the template error.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html#cfn-quicksight-template-templateerror-violatedentities

TemplateSourceAnalysisProperty

class CfnTemplatePropsMixin.TemplateSourceAnalysisProperty(*, arn=None, data_set_references=None)

Bases: object

The source analysis of the template.

Parameters:

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

  • data_set_references (Union[IResolvable, Sequence[Union[IResolvable, DataSetReferenceProperty, Dict[str, Any]]], None]) – A structure containing information about the dataset references used as placeholders in the template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceanalysis.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

template_source_analysis_property = quicksight_mixins.CfnTemplatePropsMixin.TemplateSourceAnalysisProperty(
    arn="arn",
    data_set_references=[quicksight_mixins.CfnTemplatePropsMixin.DataSetReferenceProperty(
        data_set_arn="dataSetArn",
        data_set_placeholder="dataSetPlaceholder"
    )]
)

Attributes

arn

The Amazon Resource Name (ARN) of the resource.

See:

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

data_set_references

A structure containing information about the dataset references used as placeholders in the template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceanalysis.html#cfn-quicksight-template-templatesourceanalysis-datasetreferences

TemplateSourceEntityProperty

class CfnTemplatePropsMixin.TemplateSourceEntityProperty(*, source_analysis=None, source_template=None)

Bases: object

The source entity of the template.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

template_source_entity_property = quicksight_mixins.CfnTemplatePropsMixin.TemplateSourceEntityProperty(
    source_analysis=quicksight_mixins.CfnTemplatePropsMixin.TemplateSourceAnalysisProperty(
        arn="arn",
        data_set_references=[quicksight_mixins.CfnTemplatePropsMixin.DataSetReferenceProperty(
            data_set_arn="dataSetArn",
            data_set_placeholder="dataSetPlaceholder"
        )]
    ),
    source_template=quicksight_mixins.CfnTemplatePropsMixin.TemplateSourceTemplateProperty(
        arn="arn"
    )
)

Attributes

source_analysis

The source analysis, if it is based on an analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html#cfn-quicksight-template-templatesourceentity-sourceanalysis

source_template

The source template, if it is based on an template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html#cfn-quicksight-template-templatesourceentity-sourcetemplate

TemplateSourceTemplateProperty

class CfnTemplatePropsMixin.TemplateSourceTemplateProperty(*, arn=None)

Bases: object

The source template of the template.

Parameters:

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourcetemplate.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

template_source_template_property = quicksight_mixins.CfnTemplatePropsMixin.TemplateSourceTemplateProperty(
    arn="arn"
)

Attributes

arn

The Amazon Resource Name (ARN) of the resource.

See:

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

TemplateVersionDefinitionProperty

class CfnTemplatePropsMixin.TemplateVersionDefinitionProperty(*, analysis_defaults=None, calculated_fields=None, column_configurations=None, data_set_configurations=None, filter_groups=None, options=None, parameter_declarations=None, query_execution_options=None, sheets=None)

Bases: object

The detailed definition of a template.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
analysis_defaults

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-analysisdefaults

Type:

see

calculated_fields

An array of calculated field definitions for the template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-calculatedfields

column_configurations

An array of template-level column configurations.

Column configurations are used to set default formatting for a column that’s used throughout a template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-columnconfigurations

data_set_configurations

An array of dataset configurations.

These configurations define the required columns for each dataset used within a template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-datasetconfigurations

filter_groups

Filter definitions for a template.

For more information, see Filtering Data in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-filtergroups

options

An array of option definitions for a template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-options

parameter_declarations

An array of parameter declarations for a template.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-parameterdeclarations

query_execution_options

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-queryexecutionoptions

Type:

see

sheets

An array of sheet definitions for a template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-sheets

TemplateVersionProperty

class CfnTemplatePropsMixin.TemplateVersionProperty(*, created_time=None, data_set_configurations=None, description=None, errors=None, sheets=None, source_entity_arn=None, status=None, theme_arn=None, version_number=None)

Bases: object

A version of a template.

Parameters:

  • created_time (Optional[str]) – The time that this template version was created.

  • data_set_configurations (Union[IResolvable, Sequence[Union[IResolvable, DataSetConfigurationProperty, Dict[str, Any]]], None]) – Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

  • description (Optional[str]) – The description of the template.

  • errors (Union[IResolvable, Sequence[Union[IResolvable, TemplateErrorProperty, Dict[str, Any]]], None]) – Errors associated with this template version.

  • sheets (Union[IResolvable, Sequence[Union[IResolvable, SheetProperty, Dict[str, Any]]], None]) – A list of the associated sheets with the unique identifier and name of each sheet.

  • source_entity_arn (Optional[str]) – The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

  • status (Optional[str]) – The status that is associated with the template. - CREATION_IN_PROGRESS - CREATION_SUCCESSFUL - CREATION_FAILED - UPDATE_IN_PROGRESS - UPDATE_SUCCESSFUL - UPDATE_FAILED - DELETED

  • theme_arn (Optional[str]) – The ARN of the theme associated with this version of the template.

  • version_number (Union[int, float, None]) – The version number of the template version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

template_version_property = quicksight_mixins.CfnTemplatePropsMixin.TemplateVersionProperty(
    created_time="createdTime",
    data_set_configurations=[quicksight_mixins.CfnTemplatePropsMixin.DataSetConfigurationProperty(
        column_group_schema_list=[quicksight_mixins.CfnTemplatePropsMixin.ColumnGroupSchemaProperty(
            column_group_column_schema_list=[quicksight_mixins.CfnTemplatePropsMixin.ColumnGroupColumnSchemaProperty(
                name="name"
            )],
            name="name"
        )],
        data_set_schema=quicksight_mixins.CfnTemplatePropsMixin.DataSetSchemaProperty(
            column_schema_list=[quicksight_mixins.CfnTemplatePropsMixin.ColumnSchemaProperty(
                data_type="dataType",
                geographic_role="geographicRole",
                name="name"
            )]
        ),
        placeholder="placeholder"
    )],
    description="description",
    errors=[quicksight_mixins.CfnTemplatePropsMixin.TemplateErrorProperty(
        message="message",
        type="type",
        violated_entities=[quicksight_mixins.CfnTemplatePropsMixin.EntityProperty(
            path="path"
        )]
    )],
    sheets=[quicksight_mixins.CfnTemplatePropsMixin.SheetProperty(
        name="name",
        sheet_id="sheetId"
    )],
    source_entity_arn="sourceEntityArn",
    status="status",
    theme_arn="themeArn",
    version_number=123
)

Attributes

created_time

The time that this template version was created.

See:

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

data_set_configurations

Schema of the dataset identified by the placeholder.

Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-datasetconfigurations

description

The description of the template.

See:

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

errors

Errors associated with this template version.

See:

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

sheets

A list of the associated sheets with the unique identifier and name of each sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-sheets

source_entity_arn

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-sourceentityarn

status

The status that is associated with the template.

  • CREATION_IN_PROGRESS

  • CREATION_SUCCESSFUL

  • CREATION_FAILED

  • UPDATE_IN_PROGRESS

  • UPDATE_SUCCESSFUL

  • UPDATE_FAILED

  • DELETED

See:

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

theme_arn

The ARN of the theme associated with this version of the template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-themearn

version_number

The version number of the template version.

See:

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

TextAreaControlDisplayOptionsProperty

class CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(*, info_icon_label_options=None, placeholder_options=None, title_options=None)

Bases: object

The display options of a control.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textareacontroldisplayoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

text_area_control_display_options_property = quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
        visibility="visibility"
    ),
    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        visibility="visibility"
    )
)

Attributes

info_icon_label_options

The configuration of info icon label options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textareacontroldisplayoptions.html#cfn-quicksight-template-textareacontroldisplayoptions-infoiconlabeloptions

placeholder_options

The configuration of the placeholder options in a text area control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textareacontroldisplayoptions.html#cfn-quicksight-template-textareacontroldisplayoptions-placeholderoptions

title_options

The options to configure the title visibility, name, and font size.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textareacontroldisplayoptions.html#cfn-quicksight-template-textareacontroldisplayoptions-titleoptions

TextConditionalFormatProperty

class CfnTemplatePropsMixin.TextConditionalFormatProperty(*, background_color=None, icon=None, text_color=None)

Bases: object

The conditional formatting for the text.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textconditionalformat.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

text_conditional_format_property = quicksight_mixins.CfnTemplatePropsMixin.TextConditionalFormatProperty(
    background_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    ),
    icon=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconProperty(
        custom_condition=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconConditionProperty(
            color="color",
            display_configuration=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconDisplayConfigurationProperty(
                icon_display_option="iconDisplayOption"
            ),
            expression="expression",
            icon_options=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingCustomIconOptionsProperty(
                icon="icon",
                unicode_icon="unicodeIcon"
            )
        ),
        icon_set=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingIconSetProperty(
            expression="expression",
            icon_set_type="iconSetType"
        )
    ),
    text_color=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingColorProperty(
        gradient=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingGradientColorProperty(
            color=quicksight_mixins.CfnTemplatePropsMixin.GradientColorProperty(
                stops=[quicksight_mixins.CfnTemplatePropsMixin.GradientStopProperty(
                    color="color",
                    data_value=123,
                    gradient_offset=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight_mixins.CfnTemplatePropsMixin.ConditionalFormattingSolidColorProperty(
            color="color",
            expression="expression"
        )
    )
)

Attributes

background_color

The conditional formatting for the text background color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textconditionalformat.html#cfn-quicksight-template-textconditionalformat-backgroundcolor

icon

The conditional formatting for the icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textconditionalformat.html#cfn-quicksight-template-textconditionalformat-icon

text_color

The conditional formatting for the text color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textconditionalformat.html#cfn-quicksight-template-textconditionalformat-textcolor

TextControlPlaceholderOptionsProperty

class CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(*, visibility=None)

Bases: object

The configuration of the placeholder options in a text control.

Parameters:

visibility (Optional[str]) – The visibility configuration of the placeholder options in a text control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textcontrolplaceholderoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

text_control_placeholder_options_property = quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility configuration of the placeholder options in a text control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textcontrolplaceholderoptions.html#cfn-quicksight-template-textcontrolplaceholderoptions-visibility

TextFieldControlDisplayOptionsProperty

class CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(*, info_icon_label_options=None, placeholder_options=None, title_options=None)

Bases: object

The display options of a control.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textfieldcontroldisplayoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

text_field_control_display_options_property = quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
        visibility="visibility"
    ),
    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        visibility="visibility"
    )
)

Attributes

info_icon_label_options

The configuration of info icon label options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textfieldcontroldisplayoptions.html#cfn-quicksight-template-textfieldcontroldisplayoptions-infoiconlabeloptions

placeholder_options

The configuration of the placeholder options in a text field control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textfieldcontroldisplayoptions.html#cfn-quicksight-template-textfieldcontroldisplayoptions-placeholderoptions

title_options

The options to configure the title visibility, name, and font size.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-textfieldcontroldisplayoptions.html#cfn-quicksight-template-textfieldcontroldisplayoptions-titleoptions

ThousandSeparatorOptionsProperty

class CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(*, grouping_style=None, symbol=None, visibility=None)

Bases: object

The options that determine the thousands separator configuration.

Parameters:

  • grouping_style (Optional[str]) – Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

  • symbol (Optional[str]) – Determines the thousands separator symbol.

  • visibility (Optional[str]) – Determines the visibility of the thousands separator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-thousandseparatoroptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

thousand_separator_options_property = quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
    grouping_style="groupingStyle",
    symbol="symbol",
    visibility="visibility"
)

Attributes

grouping_style

Determines the way numbers are styled to accommodate different readability standards.

The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-thousandseparatoroptions.html#cfn-quicksight-template-thousandseparatoroptions-groupingstyle

symbol

Determines the thousands separator symbol.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-thousandseparatoroptions.html#cfn-quicksight-template-thousandseparatoroptions-symbol

visibility

Determines the visibility of the thousands separator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-thousandseparatoroptions.html#cfn-quicksight-template-thousandseparatoroptions-visibility

TimeBasedForecastPropertiesProperty

class CfnTemplatePropsMixin.TimeBasedForecastPropertiesProperty(*, lower_boundary=None, periods_backward=None, periods_forward=None, prediction_interval=None, seasonality=None, upper_boundary=None)

Bases: object

The forecast properties setup of a forecast in the line chart.

Parameters:

  • lower_boundary (Union[int, float, None]) – The lower boundary setup of a forecast computation.

  • periods_backward (Union[int, float, None]) – The periods backward setup of a forecast computation.

  • periods_forward (Union[int, float, None]) – The periods forward setup of a forecast computation.

  • prediction_interval (Union[int, float, None]) – The prediction interval setup of a forecast computation.

  • seasonality (Union[int, float, None]) – The seasonality setup of a forecast computation. Choose one of the following options:. - NULL : The input is set to NULL . - NON_NULL : The input is set to a custom value.

  • upper_boundary (Union[int, float, None]) – The upper boundary setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

time_based_forecast_properties_property = quicksight_mixins.CfnTemplatePropsMixin.TimeBasedForecastPropertiesProperty(
    lower_boundary=123,
    periods_backward=123,
    periods_forward=123,
    prediction_interval=123,
    seasonality=123,
    upper_boundary=123
)

Attributes

lower_boundary

The lower boundary setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-lowerboundary

periods_backward

The periods backward setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-periodsbackward

periods_forward

The periods forward setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-periodsforward

prediction_interval

The prediction interval setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-predictioninterval

seasonality

.

  • NULL : The input is set to NULL .

  • NON_NULL : The input is set to a custom value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-seasonality

Type:

The seasonality setup of a forecast computation. Choose one of the following options

upper_boundary

The upper boundary setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timebasedforecastproperties.html#cfn-quicksight-template-timebasedforecastproperties-upperboundary

TimeEqualityFilterProperty

class CfnTemplatePropsMixin.TimeEqualityFilterProperty(*, column=None, default_filter_control_configuration=None, filter_id=None, parameter_name=None, rolling_date=None, time_granularity=None, value=None)

Bases: object

A TimeEqualityFilter filters values that are equal to a given value.

Parameters:

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the filter is applied to.

  • default_filter_control_configuration (Union[IResolvable, DefaultFilterControlConfigurationProperty, Dict[str, Any], None]) – The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

  • filter_id (Optional[str]) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • parameter_name (Optional[str]) – The parameter whose value should be used for the filter value. This field is mutually exclusive to Value and RollingDate .

  • rolling_date (Union[IResolvable, RollingDateConfigurationProperty, Dict[str, Any], None]) – The rolling date input for the TimeEquality filter. This field is mutually exclusive to Value and ParameterName .

  • time_granularity (Optional[str]) – The level of time precision that is used to aggregate DateTime values.

  • value (Optional[str]) – The value of a TimeEquality filter. This field is mutually exclusive to RollingDate and ParameterName .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

time_equality_filter_property = quicksight_mixins.CfnTemplatePropsMixin.TimeEqualityFilterProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    default_filter_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
        control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                    date_icon_visibility=date_icon_visibility,
                    date_time_format="dateTimeFormat",
                    helper_text_visibility=helper_text_visibility,
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                maximum_value=123,
                minimum_value=123,
                step_size=123,
                type="type"
            ),
            default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    filter_id="filterId",
    parameter_name="parameterName",
    rolling_date=quicksight_mixins.CfnTemplatePropsMixin.RollingDateConfigurationProperty(
        data_set_identifier="dataSetIdentifier",
        expression="expression"
    ),
    time_granularity="timeGranularity",
    value="value"
)

Attributes

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-column

default_filter_control_configuration

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-defaultfiltercontrolconfiguration

filter_id

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-filterid

parameter_name

The parameter whose value should be used for the filter value.

This field is mutually exclusive to Value and RollingDate .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-parametername

rolling_date

The rolling date input for the TimeEquality filter.

This field is mutually exclusive to Value and ParameterName .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-rollingdate

time_granularity

The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-timegranularity

value

The value of a TimeEquality filter.

This field is mutually exclusive to RollingDate and ParameterName .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timeequalityfilter.html#cfn-quicksight-template-timeequalityfilter-value

TimeRangeDrillDownFilterProperty

class CfnTemplatePropsMixin.TimeRangeDrillDownFilterProperty(*, column=None, range_maximum=None, range_minimum=None, time_granularity=None)

Bases: object

The time range drill down filter.

Parameters:

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the filter is applied to.

  • range_maximum (Optional[str]) – The maximum value for the filter value range.

  • range_minimum (Optional[str]) – The minimum value for the filter value range.

  • time_granularity (Optional[str]) – The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangedrilldownfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

time_range_drill_down_filter_property = quicksight_mixins.CfnTemplatePropsMixin.TimeRangeDrillDownFilterProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    range_maximum="rangeMaximum",
    range_minimum="rangeMinimum",
    time_granularity="timeGranularity"
)

Attributes

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangedrilldownfilter.html#cfn-quicksight-template-timerangedrilldownfilter-column

range_maximum

The maximum value for the filter value range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangedrilldownfilter.html#cfn-quicksight-template-timerangedrilldownfilter-rangemaximum

range_minimum

The minimum value for the filter value range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangedrilldownfilter.html#cfn-quicksight-template-timerangedrilldownfilter-rangeminimum

time_granularity

The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangedrilldownfilter.html#cfn-quicksight-template-timerangedrilldownfilter-timegranularity

TimeRangeFilterProperty

class CfnTemplatePropsMixin.TimeRangeFilterProperty(*, column=None, default_filter_control_configuration=None, exclude_period_configuration=None, filter_id=None, include_maximum=None, include_minimum=None, null_option=None, range_maximum_value=None, range_minimum_value=None, time_granularity=None)

Bases: object

A TimeRangeFilter filters values that are between two specified values.

Parameters:

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the filter is applied to.

  • default_filter_control_configuration (Union[IResolvable, DefaultFilterControlConfigurationProperty, Dict[str, Any], None]) – The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

  • exclude_period_configuration (Union[IResolvable, ExcludePeriodConfigurationProperty, Dict[str, Any], None]) – The exclude period of the time range filter.

  • filter_id (Optional[str]) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • include_maximum (Union[bool, IResolvable, None]) – Determines whether the maximum value in the filter value range should be included in the filtered results.

  • include_minimum (Union[bool, IResolvable, None]) – Determines whether the minimum value in the filter value range should be included in the filtered results.

  • null_option (Optional[str]) – This option determines how null values should be treated when filtering data. - ALL_VALUES : Include null values in filtered results. - NULLS_ONLY : Only include null values in filtered results. - NON_NULLS_ONLY : Exclude null values from filtered results.

  • range_maximum_value (Union[IResolvable, TimeRangeFilterValueProperty, Dict[str, Any], None]) – The maximum value for the filter value range.

  • range_minimum_value (Union[IResolvable, TimeRangeFilterValueProperty, Dict[str, Any], None]) – The minimum value for the filter value range.

  • time_granularity (Optional[str]) – The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

time_range_filter_property = quicksight_mixins.CfnTemplatePropsMixin.TimeRangeFilterProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    default_filter_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
        control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                    date_icon_visibility=date_icon_visibility,
                    date_time_format="dateTimeFormat",
                    helper_text_visibility=helper_text_visibility,
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                maximum_value=123,
                minimum_value=123,
                step_size=123,
                type="type"
            ),
            default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    exclude_period_configuration=quicksight_mixins.CfnTemplatePropsMixin.ExcludePeriodConfigurationProperty(
        amount=123,
        granularity="granularity",
        status="status"
    ),
    filter_id="filterId",
    include_maximum=False,
    include_minimum=False,
    null_option="nullOption",
    range_maximum_value=quicksight_mixins.CfnTemplatePropsMixin.TimeRangeFilterValueProperty(
        parameter="parameter",
        rolling_date=quicksight_mixins.CfnTemplatePropsMixin.RollingDateConfigurationProperty(
            data_set_identifier="dataSetIdentifier",
            expression="expression"
        ),
        static_value="staticValue"
    ),
    range_minimum_value=quicksight_mixins.CfnTemplatePropsMixin.TimeRangeFilterValueProperty(
        parameter="parameter",
        rolling_date=quicksight_mixins.CfnTemplatePropsMixin.RollingDateConfigurationProperty(
            data_set_identifier="dataSetIdentifier",
            expression="expression"
        ),
        static_value="staticValue"
    ),
    time_granularity="timeGranularity"
)

Attributes

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-column

default_filter_control_configuration

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-defaultfiltercontrolconfiguration

exclude_period_configuration

The exclude period of the time range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-excludeperiodconfiguration

filter_id

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-filterid

include_maximum

Determines whether the maximum value in the filter value range should be included in the filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-includemaximum

include_minimum

Determines whether the minimum value in the filter value range should be included in the filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-includeminimum

null_option

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.

  • NULLS_ONLY : Only include null values in filtered results.

  • NON_NULLS_ONLY : Exclude null values from filtered results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-nulloption

range_maximum_value

The maximum value for the filter value range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-rangemaximumvalue

range_minimum_value

The minimum value for the filter value range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-rangeminimumvalue

time_granularity

The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefilter.html#cfn-quicksight-template-timerangefilter-timegranularity

TimeRangeFilterValueProperty

class CfnTemplatePropsMixin.TimeRangeFilterValueProperty(*, parameter=None, rolling_date=None, static_value=None)

Bases: object

The value of a time range filter.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

  • parameter (Optional[str]) – The parameter type input value.

  • rolling_date (Union[IResolvable, RollingDateConfigurationProperty, Dict[str, Any], None]) – The rolling date input value.

  • static_value (Optional[str]) – The static input value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefiltervalue.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

time_range_filter_value_property = quicksight_mixins.CfnTemplatePropsMixin.TimeRangeFilterValueProperty(
    parameter="parameter",
    rolling_date=quicksight_mixins.CfnTemplatePropsMixin.RollingDateConfigurationProperty(
        data_set_identifier="dataSetIdentifier",
        expression="expression"
    ),
    static_value="staticValue"
)

Attributes

parameter

The parameter type input value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefiltervalue.html#cfn-quicksight-template-timerangefiltervalue-parameter

rolling_date

The rolling date input value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefiltervalue.html#cfn-quicksight-template-timerangefiltervalue-rollingdate

static_value

The static input value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-timerangefiltervalue.html#cfn-quicksight-template-timerangefiltervalue-staticvalue

TooltipItemProperty

class CfnTemplatePropsMixin.TooltipItemProperty(*, column_tooltip_item=None, field_tooltip_item=None)

Bases: object

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipitem.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

tooltip_item_property = quicksight_mixins.CfnTemplatePropsMixin.TooltipItemProperty(
    column_tooltip_item=quicksight_mixins.CfnTemplatePropsMixin.ColumnTooltipItemProperty(
        aggregation=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        ),
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        label="label",
        tooltip_target="tooltipTarget",
        visibility="visibility"
    ),
    field_tooltip_item=quicksight_mixins.CfnTemplatePropsMixin.FieldTooltipItemProperty(
        field_id="fieldId",
        label="label",
        tooltip_target="tooltipTarget",
        visibility="visibility"
    )
)

Attributes

column_tooltip_item

The tooltip item for the columns that are not part of a field well.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipitem.html#cfn-quicksight-template-tooltipitem-columntooltipitem

field_tooltip_item

The tooltip item for the fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipitem.html#cfn-quicksight-template-tooltipitem-fieldtooltipitem

TooltipOptionsProperty

class CfnTemplatePropsMixin.TooltipOptionsProperty(*, field_based_tooltip=None, selected_tooltip_type=None, tooltip_visibility=None)

Bases: object

The display options for the visual tooltip.

Parameters:

  • field_based_tooltip (Union[IResolvable, FieldBasedTooltipProperty, Dict[str, Any], None]) – The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

  • selected_tooltip_type (Optional[str]) – The selected type for the tooltip. Choose one of the following options:. - BASIC : A basic tooltip. - DETAILED : A detailed tooltip.

  • tooltip_visibility (Optional[str]) – Determines whether or not the tooltip is visible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

tooltip_options_property = quicksight_mixins.CfnTemplatePropsMixin.TooltipOptionsProperty(
    field_based_tooltip=quicksight_mixins.CfnTemplatePropsMixin.FieldBasedTooltipProperty(
        aggregation_visibility="aggregationVisibility",
        tooltip_fields=[quicksight_mixins.CfnTemplatePropsMixin.TooltipItemProperty(
            column_tooltip_item=quicksight_mixins.CfnTemplatePropsMixin.ColumnTooltipItemProperty(
                aggregation=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                    attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                        simple_attribute_aggregation="simpleAttributeAggregation",
                        value_for_multiple_values="valueForMultipleValues"
                    ),
                    categorical_aggregation_function="categoricalAggregationFunction",
                    date_aggregation_function="dateAggregationFunction",
                    numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                        percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                            percentile_value=123
                        ),
                        simple_numerical_aggregation="simpleNumericalAggregation"
                    )
                ),
                column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                label="label",
                tooltip_target="tooltipTarget",
                visibility="visibility"
            ),
            field_tooltip_item=quicksight_mixins.CfnTemplatePropsMixin.FieldTooltipItemProperty(
                field_id="fieldId",
                label="label",
                tooltip_target="tooltipTarget",
                visibility="visibility"
            )
        )],
        tooltip_title_type="tooltipTitleType"
    ),
    selected_tooltip_type="selectedTooltipType",
    tooltip_visibility="tooltipVisibility"
)

Attributes

field_based_tooltip

The setup for the detailed tooltip.

The tooltip setup is always saved. The display type is decided based on the tooltip type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipoptions.html#cfn-quicksight-template-tooltipoptions-fieldbasedtooltip

selected_tooltip_type

.

  • BASIC : A basic tooltip.

  • DETAILED : A detailed tooltip.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipoptions.html#cfn-quicksight-template-tooltipoptions-selectedtooltiptype

Type:

The selected type for the tooltip. Choose one of the following options

tooltip_visibility

Determines whether or not the tooltip is visible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-tooltipoptions.html#cfn-quicksight-template-tooltipoptions-tooltipvisibility

TopBottomFilterProperty

class CfnTemplatePropsMixin.TopBottomFilterProperty(*, aggregation_sort_configurations=None, column=None, default_filter_control_configuration=None, filter_id=None, limit=None, parameter_name=None, time_granularity=None)

Bases: object

A TopBottomFilter filters values that are at the top or the bottom.

Parameters:

  • aggregation_sort_configurations (Union[IResolvable, Sequence[Union[IResolvable, AggregationSortConfigurationProperty, Dict[str, Any]]], None]) – The aggregation and sort configuration of the top bottom filter.

  • column (Union[IResolvable, ColumnIdentifierProperty, Dict[str, Any], None]) – The column that the filter is applied to.

  • default_filter_control_configuration (Union[IResolvable, DefaultFilterControlConfigurationProperty, Dict[str, Any], None]) – The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

  • filter_id (Optional[str]) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • limit (Union[int, float, None]) – The number of items to include in the top bottom filter results.

  • parameter_name (Optional[str]) – The parameter whose value should be used for the filter value.

  • time_granularity (Optional[str]) – The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

# date_icon_visibility: Any
# helper_text_visibility: Any

top_bottom_filter_property = quicksight_mixins.CfnTemplatePropsMixin.TopBottomFilterProperty(
    aggregation_sort_configurations=[quicksight_mixins.CfnTemplatePropsMixin.AggregationSortConfigurationProperty(
        aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        ),
        column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        sort_direction="sortDirection"
    )],
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    default_filter_control_configuration=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlConfigurationProperty(
        control_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DateTimePickerControlDisplayOptionsProperty(
                    date_icon_visibility=date_icon_visibility,
                    date_time_format="dateTimeFormat",
                    helper_text_visibility=helper_text_visibility,
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultFilterListControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight_mixins.CfnTemplatePropsMixin.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight_mixins.CfnTemplatePropsMixin.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultSliderControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                maximum_value=123,
                minimum_value=123,
                step_size=123,
                type="type"
            ),
            default_text_area_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight_mixins.CfnTemplatePropsMixin.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight_mixins.CfnTemplatePropsMixin.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight_mixins.CfnTemplatePropsMixin.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight_mixins.CfnTemplatePropsMixin.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight_mixins.CfnTemplatePropsMixin.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_family="fontFamily",
                            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                                absolute="absolute",
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    filter_id="filterId",
    limit=123,
    parameter_name="parameterName",
    time_granularity="timeGranularity"
)

Attributes

aggregation_sort_configurations

The aggregation and sort configuration of the top bottom filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-aggregationsortconfigurations

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-column

default_filter_control_configuration

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-defaultfiltercontrolconfiguration

filter_id

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-filterid

limit

The number of items to include in the top bottom filter results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-limit

parameter_name

The parameter whose value should be used for the filter value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-parametername

time_granularity

The level of time precision that is used to aggregate DateTime values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomfilter.html#cfn-quicksight-template-topbottomfilter-timegranularity

TopBottomMoversComputationProperty

class CfnTemplatePropsMixin.TopBottomMoversComputationProperty(*, category=None, computation_id=None, mover_size=None, name=None, sort_order=None, time=None, type=None, value=None)

Bases: object

The top movers and bottom movers computation setup.

Parameters:

  • category (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The category field that is used in a computation.

  • computation_id (Optional[str]) – The ID for a computation.

  • mover_size (Union[int, float, None]) – The mover size setup of the top and bottom movers computation. Default: - 0

  • name (Optional[str]) – The name of a computation.

  • sort_order (Optional[str]) – The sort order setup of the top and bottom movers computation.

  • time (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The time field that is used in a computation.

  • type (Optional[str]) – The computation type. Choose from the following options:. - TOP: Top movers computation. - BOTTOM: Bottom movers computation.

  • value (Union[IResolvable, MeasureFieldProperty, Dict[str, Any], None]) – The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category

The category field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-category

computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-computationid

mover_size

The mover size setup of the top and bottom movers computation.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-moversize

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-name

sort_order

The sort order setup of the top and bottom movers computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-sortorder

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-time

type

.

  • TOP: Top movers computation.

  • BOTTOM: Bottom movers computation.

See:

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

Type:

The computation type. Choose from the following options

value

The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottommoverscomputation.html#cfn-quicksight-template-topbottommoverscomputation-value

TopBottomRankedComputationProperty

class CfnTemplatePropsMixin.TopBottomRankedComputationProperty(*, category=None, computation_id=None, name=None, result_size=None, type=None, value=None)

Bases: object

The top ranked and bottom ranked computation configuration.

Parameters:

  • category (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The category field that is used in a computation.

  • computation_id (Optional[str]) – The ID for a computation.

  • name (Optional[str]) – The name of a computation.

  • result_size (Union[int, float, None]) – The result size of a top and bottom ranked computation. Default: - 0

  • type (Optional[str]) – The computation type. Choose one of the following options:. - TOP: A top ranked computation. - BOTTOM: A bottom ranked computation.

  • value (Union[IResolvable, MeasureFieldProperty, Dict[str, Any], None]) – The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category

The category field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-category

computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-computationid

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-name

result_size

The result size of a top and bottom ranked computation.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-resultsize

type

.

  • TOP: A top ranked computation.

  • BOTTOM: A bottom ranked computation.

See:

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

Type:

The computation type. Choose one of the following options

value

The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-value

TotalAggregationComputationProperty

class CfnTemplatePropsMixin.TotalAggregationComputationProperty(*, computation_id=None, name=None, value=None)

Bases: object

The total aggregation computation configuration.

Parameters:

  • computation_id (Optional[str]) – The ID for a computation.

  • name (Optional[str]) – The name of a computation.

  • value (Union[IResolvable, MeasureFieldProperty, Dict[str, Any], None]) – The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationcomputation.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

total_aggregation_computation_property = quicksight_mixins.CfnTemplatePropsMixin.TotalAggregationComputationProperty(
    computation_id="computationId",
    name="name",
    value=quicksight_mixins.CfnTemplatePropsMixin.MeasureFieldProperty(
        calculated_measure_field=quicksight_mixins.CfnTemplatePropsMixin.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight_mixins.CfnTemplatePropsMixin.CategoricalMeasureFieldProperty(
            aggregation_function="aggregationFunction",
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight_mixins.CfnTemplatePropsMixin.DateMeasureFieldProperty(
            aggregation_function="aggregationFunction",
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight_mixins.CfnTemplatePropsMixin.NumericalMeasureFieldProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
                format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        )
    )
)

Attributes

computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationcomputation.html#cfn-quicksight-template-totalaggregationcomputation-computationid

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationcomputation.html#cfn-quicksight-template-totalaggregationcomputation-name

value

The value field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationcomputation.html#cfn-quicksight-template-totalaggregationcomputation-value

TotalAggregationFunctionProperty

class CfnTemplatePropsMixin.TotalAggregationFunctionProperty(*, simple_total_aggregation_function=None)

Bases: object

An aggregation function that aggregates the total values of a measure.

Parameters:

simple_total_aggregation_function (Optional[str]) – A built in aggregation function for total values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationfunction.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

total_aggregation_function_property = quicksight_mixins.CfnTemplatePropsMixin.TotalAggregationFunctionProperty(
    simple_total_aggregation_function="simpleTotalAggregationFunction"
)

Attributes

simple_total_aggregation_function

A built in aggregation function for total values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationfunction.html#cfn-quicksight-template-totalaggregationfunction-simpletotalaggregationfunction

TotalAggregationOptionProperty

class CfnTemplatePropsMixin.TotalAggregationOptionProperty(*, field_id=None, total_aggregation_function=None)

Bases: object

The total aggregation settings map of a field id.

Parameters:

  • field_id (Optional[str]) – The field id that’s associated with the total aggregation option.

  • total_aggregation_function (Union[IResolvable, TotalAggregationFunctionProperty, Dict[str, Any], None]) – The total aggregation function that you want to set for a specified field id.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

total_aggregation_option_property = quicksight_mixins.CfnTemplatePropsMixin.TotalAggregationOptionProperty(
    field_id="fieldId",
    total_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.TotalAggregationFunctionProperty(
        simple_total_aggregation_function="simpleTotalAggregationFunction"
    )
)

Attributes

field_id

The field id that’s associated with the total aggregation option.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationoption.html#cfn-quicksight-template-totalaggregationoption-fieldid

total_aggregation_function

The total aggregation function that you want to set for a specified field id.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totalaggregationoption.html#cfn-quicksight-template-totalaggregationoption-totalaggregationfunction

TotalOptionsProperty

class CfnTemplatePropsMixin.TotalOptionsProperty(*, custom_label=None, placement=None, scroll_status=None, total_aggregation_options=None, total_cell_style=None, totals_visibility=None)

Bases: object

The total options for a table visual.

Parameters:

  • custom_label (Optional[str]) – The custom label string for the total cells.

  • placement (Optional[str]) – The placement (start, end) for the total cells.

  • scroll_status (Optional[str]) – The scroll status (pinned, scrolled) for the total cells.

  • total_aggregation_options (Union[IResolvable, Sequence[Union[IResolvable, TotalAggregationOptionProperty, Dict[str, Any]]], None]) – The total aggregation settings for each value field.

  • total_cell_style (Union[IResolvable, TableCellStyleProperty, Dict[str, Any], None]) – Cell styling options for the total cells.

  • totals_visibility (Optional[str]) – The visibility configuration for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

total_options_property = quicksight_mixins.CfnTemplatePropsMixin.TotalOptionsProperty(
    custom_label="customLabel",
    placement="placement",
    scroll_status="scrollStatus",
    total_aggregation_options=[quicksight_mixins.CfnTemplatePropsMixin.TotalAggregationOptionProperty(
        field_id="fieldId",
        total_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.TotalAggregationFunctionProperty(
            simple_total_aggregation_function="simpleTotalAggregationFunction"
        )
    )],
    total_cell_style=quicksight_mixins.CfnTemplatePropsMixin.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight_mixins.CfnTemplatePropsMixin.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight_mixins.CfnTemplatePropsMixin.TableSideBorderOptionsProperty(
                bottom=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight_mixins.CfnTemplatePropsMixin.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight_mixins.CfnTemplatePropsMixin.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_family="fontFamily",
            font_size=quicksight_mixins.CfnTemplatePropsMixin.FontSizeProperty(
                absolute="absolute",
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight_mixins.CfnTemplatePropsMixin.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    totals_visibility="totalsVisibility"
)

Attributes

custom_label

The custom label string for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-customlabel

placement

The placement (start, end) for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-placement

scroll_status

The scroll status (pinned, scrolled) for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-scrollstatus

total_aggregation_options

The total aggregation settings for each value field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-totalaggregationoptions

total_cell_style

Cell styling options for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-totalcellstyle

totals_visibility

The visibility configuration for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-totaloptions.html#cfn-quicksight-template-totaloptions-totalsvisibility

TransposedTableOptionProperty

class CfnTemplatePropsMixin.TransposedTableOptionProperty(*, column_index=None, column_type=None, column_width=None)

Bases: object

The column option of the transposed table.

Parameters:

  • column_index (Union[int, float, None]) – The index of a columns in a transposed table. The index range is 0-9999.

  • column_type (Optional[str]) – The column type of the column in a transposed table. Choose one of the following options:. - ROW_HEADER_COLUMN : Refers to the leftmost column of the row header in the transposed table. - VALUE_COLUMN : Refers to all value columns in the transposed table.

  • column_width (Optional[str]) – The width of a column in a transposed table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-transposedtableoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

transposed_table_option_property = quicksight_mixins.CfnTemplatePropsMixin.TransposedTableOptionProperty(
    column_index=123,
    column_type="columnType",
    column_width="columnWidth"
)

Attributes

column_index

The index of a columns in a transposed table.

The index range is 0-9999.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-transposedtableoption.html#cfn-quicksight-template-transposedtableoption-columnindex

column_type

.

  • ROW_HEADER_COLUMN : Refers to the leftmost column of the row header in the transposed table.

  • VALUE_COLUMN : Refers to all value columns in the transposed table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-transposedtableoption.html#cfn-quicksight-template-transposedtableoption-columntype

Type:

The column type of the column in a transposed table. Choose one of the following options

column_width

The width of a column in a transposed table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-transposedtableoption.html#cfn-quicksight-template-transposedtableoption-columnwidth

TreeMapAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.TreeMapAggregatedFieldWellsProperty(*, colors=None, groups=None, sizes=None)

Bases: object

Aggregated field wells of a tree map.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
colors

The color field well of a tree map.

Values are grouped by aggregations based on group by fields.

See:

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

groups

The group by field well of a tree map.

Values are grouped based on group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapaggregatedfieldwells.html#cfn-quicksight-template-treemapaggregatedfieldwells-groups

sizes

The size field well of a tree map.

Values are aggregated based on group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapaggregatedfieldwells.html#cfn-quicksight-template-treemapaggregatedfieldwells-sizes

TreeMapConfigurationProperty

class CfnTemplatePropsMixin.TreeMapConfigurationProperty(*, color_label_options=None, color_scale=None, data_labels=None, field_wells=None, group_label_options=None, interactions=None, legend=None, size_label_options=None, sort_configuration=None, tooltip=None)

Bases: object

The configuration of a tree map.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
color_label_options

The label options (label text, label visibility) for the colors displayed in a tree map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-colorlabeloptions

color_scale

The color options (gradient color, point of divergence) of a tree map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-colorscale

data_labels

The options that determine if visual data labels are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-datalabels

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-fieldwells

group_label_options

The label options (label text, label visibility) of the groups that are displayed in a tree map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-grouplabeloptions

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-interactions

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-legend

size_label_options

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-sizelabeloptions

sort_configuration

The sort configuration of a tree map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-sortconfiguration

tooltip

The tooltip display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapconfiguration.html#cfn-quicksight-template-treemapconfiguration-tooltip

TreeMapFieldWellsProperty

class CfnTemplatePropsMixin.TreeMapFieldWellsProperty(*, tree_map_aggregated_field_wells=None)

Bases: object

The field wells of a tree map.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

tree_map_aggregated_field_wells (Union[IResolvable, TreeMapAggregatedFieldWellsProperty, Dict[str, Any], None]) – The aggregated field wells of a tree map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
tree_map_aggregated_field_wells

The aggregated field wells of a tree map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapfieldwells.html#cfn-quicksight-template-treemapfieldwells-treemapaggregatedfieldwells

TreeMapSortConfigurationProperty

class CfnTemplatePropsMixin.TreeMapSortConfigurationProperty(*, tree_map_group_items_limit_configuration=None, tree_map_sort=None)

Bases: object

The sort configuration of a tree map.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

tree_map_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.TreeMapSortConfigurationProperty(
    tree_map_group_items_limit_configuration=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    tree_map_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

tree_map_group_items_limit_configuration

The limit on the number of groups that are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapsortconfiguration.html#cfn-quicksight-template-treemapsortconfiguration-treemapgroupitemslimitconfiguration

tree_map_sort

The sort configuration of group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapsortconfiguration.html#cfn-quicksight-template-treemapsortconfiguration-treemapsort

TreeMapVisualProperty

class CfnTemplatePropsMixin.TreeMapVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A tree map.

For more information, see Using tree maps in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-treemapvisual.html#cfn-quicksight-template-treemapvisual-visualid

TrendArrowOptionsProperty

class CfnTemplatePropsMixin.TrendArrowOptionsProperty(*, visibility=None)

Bases: object

The options that determine the presentation of trend arrows in a KPI visual.

Parameters:

visibility (Optional[str]) – The visibility of the trend arrows.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-trendarrowoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

trend_arrow_options_property = quicksight_mixins.CfnTemplatePropsMixin.TrendArrowOptionsProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility of the trend arrows.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-trendarrowoptions.html#cfn-quicksight-template-trendarrowoptions-visibility

UnaggregatedFieldProperty

class CfnTemplatePropsMixin.UnaggregatedFieldProperty(*, column=None, field_id=None, format_configuration=None)

Bases: object

The unaggregated field for a table.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-unaggregatedfield.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

unaggregated_field_property = quicksight_mixins.CfnTemplatePropsMixin.UnaggregatedFieldProperty(
    column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",
    format_configuration=quicksight_mixins.CfnTemplatePropsMixin.FormatConfigurationProperty(
        date_time_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
            date_time_format="dateTimeFormat",
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        number_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        string_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
            null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                            grouping_style="groupingStyle",
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        )
    )
)

Attributes

column

The column that is used in the UnaggregatedField .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-unaggregatedfield.html#cfn-quicksight-template-unaggregatedfield-column

field_id

The custom field ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-unaggregatedfield.html#cfn-quicksight-template-unaggregatedfield-fieldid

format_configuration

The format configuration of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-unaggregatedfield.html#cfn-quicksight-template-unaggregatedfield-formatconfiguration

UniqueValuesComputationProperty

class CfnTemplatePropsMixin.UniqueValuesComputationProperty(*, category=None, computation_id=None, name=None)

Bases: object

The unique values computation configuration.

Parameters:

  • category (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The category field that is used in a computation.

  • computation_id (Optional[str]) – The ID for a computation.

  • name (Optional[str]) – The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-uniquevaluescomputation.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

unique_values_computation_property = quicksight_mixins.CfnTemplatePropsMixin.UniqueValuesComputationProperty(
    category=quicksight_mixins.CfnTemplatePropsMixin.DimensionFieldProperty(
        categorical_dimension_field=quicksight_mixins.CfnTemplatePropsMixin.CategoricalDimensionFieldProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight_mixins.CfnTemplatePropsMixin.DateDimensionFieldProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            date_granularity="dateGranularity",
            field_id="fieldId",
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight_mixins.CfnTemplatePropsMixin.NumericalDimensionFieldProperty(
            column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",
            format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberFormatConfigurationProperty(
                format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight_mixins.CfnTemplatePropsMixin.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight_mixins.CfnTemplatePropsMixin.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight_mixins.CfnTemplatePropsMixin.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight_mixins.CfnTemplatePropsMixin.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight_mixins.CfnTemplatePropsMixin.ThousandSeparatorOptionsProperty(
                                grouping_style="groupingStyle",
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    ),
    computation_id="computationId",
    name="name"
)

Attributes

category

The category field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-uniquevaluescomputation.html#cfn-quicksight-template-uniquevaluescomputation-category

computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-uniquevaluescomputation.html#cfn-quicksight-template-uniquevaluescomputation-computationid

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-uniquevaluescomputation.html#cfn-quicksight-template-uniquevaluescomputation-name

ValidationStrategyProperty

class CfnTemplatePropsMixin.ValidationStrategyProperty(*, mode=None)

Bases: object

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

When you set this value to LENIENT , validation is skipped for specific errors.

Parameters:

mode (Optional[str]) – The mode of validation for the asset to be created or updated. When you set this value to STRICT , strict validation for every error is enforced. When you set this value to LENIENT , validation is skipped for specific UI errors.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-validationstrategy.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

validation_strategy_property = quicksight_mixins.CfnTemplatePropsMixin.ValidationStrategyProperty(
    mode="mode"
)

Attributes

mode

The mode of validation for the asset to be created or updated.

When you set this value to STRICT , strict validation for every error is enforced. When you set this value to LENIENT , validation is skipped for specific UI errors.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-validationstrategy.html#cfn-quicksight-template-validationstrategy-mode

VisibleRangeOptionsProperty

class CfnTemplatePropsMixin.VisibleRangeOptionsProperty(*, percent_range=None)

Bases: object

The range options for the data zoom scroll bar.

Parameters:

percent_range (Union[IResolvable, PercentVisibleRangeProperty, Dict[str, Any], None]) – The percent range in the visible range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visiblerangeoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

visible_range_options_property = quicksight_mixins.CfnTemplatePropsMixin.VisibleRangeOptionsProperty(
    percent_range=quicksight_mixins.CfnTemplatePropsMixin.PercentVisibleRangeProperty(
        from=123,
        to=123
    )
)

Attributes

percent_range

The percent range in the visible range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visiblerangeoptions.html#cfn-quicksight-template-visiblerangeoptions-percentrange

VisualCustomActionOperationProperty

class CfnTemplatePropsMixin.VisualCustomActionOperationProperty(*, filter_operation=None, navigation_operation=None, set_parameters_operation=None, url_operation=None)

Bases: object

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomactionoperation.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

visual_custom_action_operation_property = quicksight_mixins.CfnTemplatePropsMixin.VisualCustomActionOperationProperty(
    filter_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionFilterOperationProperty(
        selected_fields_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterOperationSelectedFieldsConfigurationProperty(
            selected_columns=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )],
            selected_field_options="selectedFieldOptions",
            selected_fields=["selectedFields"]
        ),
        target_visuals_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterOperationTargetVisualsConfigurationProperty(
            same_sheet_target_visual_configuration=quicksight_mixins.CfnTemplatePropsMixin.SameSheetTargetVisualConfigurationProperty(
                target_visual_options="targetVisualOptions",
                target_visuals=["targetVisuals"]
            )
        )
    ),
    navigation_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionNavigationOperationProperty(
        local_navigation_configuration=quicksight_mixins.CfnTemplatePropsMixin.LocalNavigationConfigurationProperty(
            target_sheet_id="targetSheetId"
        )
    ),
    set_parameters_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionSetParametersOperationProperty(
        parameter_value_configurations=[quicksight_mixins.CfnTemplatePropsMixin.SetParameterValueConfigurationProperty(
            destination_parameter_name="destinationParameterName",
            value=quicksight_mixins.CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(
                custom_values_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
                    custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
                        date_time_values=["dateTimeValues"],
                        decimal_values=[123],
                        integer_values=[123],
                        string_values=["stringValues"]
                    ),
                    include_null_value=False
                ),
                select_all_value_options="selectAllValueOptions",
                source_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_field="sourceField",
                source_parameter_name="sourceParameterName"
            )
        )]
    ),
    url_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionURLOperationProperty(
        url_target="urlTarget",
        url_template="urlTemplate"
    )
)

Attributes

filter_operation

The filter operation that filters data included in a visual or in an entire sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomactionoperation.html#cfn-quicksight-template-visualcustomactionoperation-filteroperation

navigation_operation

The navigation operation that navigates between different sheets in the same analysis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomactionoperation.html#cfn-quicksight-template-visualcustomactionoperation-navigationoperation

set_parameters_operation

The set parameter operation that sets parameters in custom action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomactionoperation.html#cfn-quicksight-template-visualcustomactionoperation-setparametersoperation

url_operation

The URL operation that opens a link to another webpage.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomactionoperation.html#cfn-quicksight-template-visualcustomactionoperation-urloperation

VisualCustomActionProperty

class CfnTemplatePropsMixin.VisualCustomActionProperty(*, action_operations=None, custom_action_id=None, name=None, status=None, trigger=None)

Bases: object

A custom action defined on a visual.

Parameters:

  • action_operations (Union[IResolvable, Sequence[Union[IResolvable, VisualCustomActionOperationProperty, Dict[str, Any]]], None]) – A list of VisualCustomActionOperations . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

  • custom_action_id (Optional[str]) – The ID of the VisualCustomAction .

  • name (Optional[str]) – The name of the VisualCustomAction .

  • status (Optional[str]) – The status of the VisualCustomAction .

  • trigger (Optional[str]) – The trigger of the VisualCustomAction . Valid values are defined as follows: - DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point. - DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

visual_custom_action_property = quicksight_mixins.CfnTemplatePropsMixin.VisualCustomActionProperty(
    action_operations=[quicksight_mixins.CfnTemplatePropsMixin.VisualCustomActionOperationProperty(
        filter_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionFilterOperationProperty(
            selected_fields_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterOperationSelectedFieldsConfigurationProperty(
                selected_columns=[quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )],
                selected_field_options="selectedFieldOptions",
                selected_fields=["selectedFields"]
            ),
            target_visuals_configuration=quicksight_mixins.CfnTemplatePropsMixin.FilterOperationTargetVisualsConfigurationProperty(
                same_sheet_target_visual_configuration=quicksight_mixins.CfnTemplatePropsMixin.SameSheetTargetVisualConfigurationProperty(
                    target_visual_options="targetVisualOptions",
                    target_visuals=["targetVisuals"]
                )
            )
        ),
        navigation_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionNavigationOperationProperty(
            local_navigation_configuration=quicksight_mixins.CfnTemplatePropsMixin.LocalNavigationConfigurationProperty(
                target_sheet_id="targetSheetId"
            )
        ),
        set_parameters_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionSetParametersOperationProperty(
            parameter_value_configurations=[quicksight_mixins.CfnTemplatePropsMixin.SetParameterValueConfigurationProperty(
                destination_parameter_name="destinationParameterName",
                value=quicksight_mixins.CfnTemplatePropsMixin.DestinationParameterValueConfigurationProperty(
                    custom_values_configuration=quicksight_mixins.CfnTemplatePropsMixin.CustomValuesConfigurationProperty(
                        custom_values=quicksight_mixins.CfnTemplatePropsMixin.CustomParameterValuesProperty(
                            date_time_values=["dateTimeValues"],
                            decimal_values=[123],
                            integer_values=[123],
                            string_values=["stringValues"]
                        ),
                        include_null_value=False
                    ),
                    select_all_value_options="selectAllValueOptions",
                    source_column=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    ),
                    source_field="sourceField",
                    source_parameter_name="sourceParameterName"
                )
            )]
        ),
        url_operation=quicksight_mixins.CfnTemplatePropsMixin.CustomActionURLOperationProperty(
            url_target="urlTarget",
            url_template="urlTemplate"
        )
    )],
    custom_action_id="customActionId",
    name="name",
    status="status",
    trigger="trigger"
)

Attributes

action_operations

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-actionoperations

custom_action_id

The ID of the VisualCustomAction .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-customactionid

name

The name of the VisualCustomAction .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-name

status

The status of the VisualCustomAction .

See:

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

trigger

The trigger of the VisualCustomAction .

Valid values are defined as follows:

  • DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.

  • DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualcustomaction.html#cfn-quicksight-template-visualcustomaction-trigger

VisualInteractionOptionsProperty

class CfnTemplatePropsMixin.VisualInteractionOptionsProperty(*, context_menu_option=None, visual_menu_option=None)

Bases: object

The general visual interactions setup for visual publish options.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualinteractionoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

visual_interaction_options_property = quicksight_mixins.CfnTemplatePropsMixin.VisualInteractionOptionsProperty(
    context_menu_option=quicksight_mixins.CfnTemplatePropsMixin.ContextMenuOptionProperty(
        availability_status="availabilityStatus"
    ),
    visual_menu_option=quicksight_mixins.CfnTemplatePropsMixin.VisualMenuOptionProperty(
        availability_status="availabilityStatus"
    )
)

Attributes

context_menu_option

The context menu options for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualinteractionoptions.html#cfn-quicksight-template-visualinteractionoptions-contextmenuoption

visual_menu_option

The on-visual menu options for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualinteractionoptions.html#cfn-quicksight-template-visualinteractionoptions-visualmenuoption

VisualMenuOptionProperty

class CfnTemplatePropsMixin.VisualMenuOptionProperty(*, availability_status=None)

Bases: object

The menu options for a visual.

Parameters:

availability_status (Optional[str]) – The availaiblity status of a visual’s menu options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualmenuoption.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

visual_menu_option_property = quicksight_mixins.CfnTemplatePropsMixin.VisualMenuOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

The availaiblity status of a visual’s menu options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualmenuoption.html#cfn-quicksight-template-visualmenuoption-availabilitystatus

VisualPaletteProperty

class CfnTemplatePropsMixin.VisualPaletteProperty(*, chart_color=None, color_map=None)

Bases: object

The visual display options for the visual palette.

Parameters:

  • chart_color (Optional[str]) – The chart color options for the visual palette.

  • color_map (Union[IResolvable, Sequence[Union[IResolvable, DataPathColorProperty, Dict[str, Any]]], None]) – The color map options for the visual palette.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualpalette.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

visual_palette_property = quicksight_mixins.CfnTemplatePropsMixin.VisualPaletteProperty(
    chart_color="chartColor",
    color_map=[quicksight_mixins.CfnTemplatePropsMixin.DataPathColorProperty(
        color="color",
        element=quicksight_mixins.CfnTemplatePropsMixin.DataPathValueProperty(
            data_path_type=quicksight_mixins.CfnTemplatePropsMixin.DataPathTypeProperty(
                pivot_table_data_path_type="pivotTableDataPathType"
            ),
            field_id="fieldId",
            field_value="fieldValue"
        ),
        time_granularity="timeGranularity"
    )]
)

Attributes

chart_color

The chart color options for the visual palette.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualpalette.html#cfn-quicksight-template-visualpalette-chartcolor

color_map

The color map options for the visual palette.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualpalette.html#cfn-quicksight-template-visualpalette-colormap

VisualProperty

class CfnTemplatePropsMixin.VisualProperty(*, bar_chart_visual=None, box_plot_visual=None, combo_chart_visual=None, custom_content_visual=None, empty_visual=None, filled_map_visual=None, funnel_chart_visual=None, gauge_chart_visual=None, geospatial_map_visual=None, heat_map_visual=None, histogram_visual=None, insight_visual=None, kpi_visual=None, line_chart_visual=None, pie_chart_visual=None, pivot_table_visual=None, plugin_visual=None, radar_chart_visual=None, sankey_diagram_visual=None, scatter_plot_visual=None, table_visual=None, tree_map_visual=None, waterfall_visual=None, word_cloud_visual=None)

Bases: object

A visual displayed on a sheet in an analysis, dashboard, or template.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
bar_chart_visual

A bar chart.

For more information, see Using bar charts in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-barchartvisual

box_plot_visual

A box plot.

For more information, see Using box plots in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-boxplotvisual

combo_chart_visual

A combo chart.

For more information, see Using combo charts in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-combochartvisual

custom_content_visual

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-customcontentvisual

empty_visual

An empty visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-emptyvisual

filled_map_visual

A filled map.

For more information, see Creating filled maps in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-filledmapvisual

funnel_chart_visual

A funnel chart.

For more information, see Using funnel charts in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-funnelchartvisual

gauge_chart_visual

A gauge chart.

For more information, see Using gauge charts in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-gaugechartvisual

geospatial_map_visual

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-geospatialmapvisual

heat_map_visual

A heat map.

For more information, see Using heat maps in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-heatmapvisual

histogram_visual

A histogram.

For more information, see Using histograms in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-histogramvisual

insight_visual

An insight visual.

For more information, see Working with insights in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-insightvisual

kpi_visual

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-kpivisual

line_chart_visual

A line chart.

For more information, see Using line charts in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-linechartvisual

pie_chart_visual

A pie or donut chart.

For more information, see Using pie charts in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-piechartvisual

pivot_table_visual

A pivot table.

For more information, see Using pivot tables in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-pivottablevisual

plugin_visual

The custom plugin visual type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-pluginvisual

radar_chart_visual

A radar chart visual.

For more information, see Using radar charts in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-radarchartvisual

sankey_diagram_visual

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-sankeydiagramvisual

scatter_plot_visual

A scatter plot.

For more information, see Using scatter plots in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-scatterplotvisual

table_visual

A table visual.

For more information, see Using tables as visuals in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-tablevisual

tree_map_visual

A tree map.

For more information, see Using tree maps in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-treemapvisual

waterfall_visual

A waterfall chart.

For more information, see Using waterfall charts in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-waterfallvisual

word_cloud_visual

A word cloud.

For more information, see Using word clouds in the Amazon Quick Suite User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-wordcloudvisual

VisualSubtitleLabelOptionsProperty

class CfnTemplatePropsMixin.VisualSubtitleLabelOptionsProperty(*, format_text=None, visibility=None)

Bases: object

The subtitle label options for a visual.

Parameters:

  • format_text (Union[IResolvable, LongFormatTextProperty, Dict[str, Any], None]) – The long text format of the subtitle label, such as plain text or rich text.

  • visibility (Optional[str]) – The visibility of the subtitle label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualsubtitlelabeloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

visual_subtitle_label_options_property = quicksight_mixins.CfnTemplatePropsMixin.VisualSubtitleLabelOptionsProperty(
    format_text=quicksight_mixins.CfnTemplatePropsMixin.LongFormatTextProperty(
        plain_text="plainText",
        rich_text="richText"
    ),
    visibility="visibility"
)

Attributes

format_text

The long text format of the subtitle label, such as plain text or rich text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualsubtitlelabeloptions.html#cfn-quicksight-template-visualsubtitlelabeloptions-formattext

visibility

The visibility of the subtitle label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualsubtitlelabeloptions.html#cfn-quicksight-template-visualsubtitlelabeloptions-visibility

VisualTitleLabelOptionsProperty

class CfnTemplatePropsMixin.VisualTitleLabelOptionsProperty(*, format_text=None, visibility=None)

Bases: object

The title label options for a visual.

Parameters:

  • format_text (Union[IResolvable, ShortFormatTextProperty, Dict[str, Any], None]) – The short text format of the title label, such as plain text or rich text.

  • visibility (Optional[str]) – The visibility of the title label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualtitlelabeloptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

visual_title_label_options_property = quicksight_mixins.CfnTemplatePropsMixin.VisualTitleLabelOptionsProperty(
    format_text=quicksight_mixins.CfnTemplatePropsMixin.ShortFormatTextProperty(
        plain_text="plainText",
        rich_text="richText"
    ),
    visibility="visibility"
)

Attributes

format_text

The short text format of the title label, such as plain text or rich text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualtitlelabeloptions.html#cfn-quicksight-template-visualtitlelabeloptions-formattext

visibility

The visibility of the title label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visualtitlelabeloptions.html#cfn-quicksight-template-visualtitlelabeloptions-visibility

WaterfallChartAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.WaterfallChartAggregatedFieldWellsProperty(*, breakdowns=None, categories=None, values=None)

Bases: object

The field well configuration of a waterfall visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
breakdowns

The breakdown field wells of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartaggregatedfieldwells.html#cfn-quicksight-template-waterfallchartaggregatedfieldwells-breakdowns

categories

The category field wells of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartaggregatedfieldwells.html#cfn-quicksight-template-waterfallchartaggregatedfieldwells-categories

values

The value field wells of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartaggregatedfieldwells.html#cfn-quicksight-template-waterfallchartaggregatedfieldwells-values

WaterfallChartColorConfigurationProperty

class CfnTemplatePropsMixin.WaterfallChartColorConfigurationProperty(*, group_color_configuration=None)

Bases: object

The color configuration of a waterfall visual.

Parameters:

group_color_configuration (Union[IResolvable, WaterfallChartGroupColorConfigurationProperty, Dict[str, Any], None]) – The color configuration for individual groups within a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartcolorconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

waterfall_chart_color_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.WaterfallChartColorConfigurationProperty(
    group_color_configuration=quicksight_mixins.CfnTemplatePropsMixin.WaterfallChartGroupColorConfigurationProperty(
        negative_bar_color="negativeBarColor",
        positive_bar_color="positiveBarColor",
        total_bar_color="totalBarColor"
    )
)

Attributes

group_color_configuration

The color configuration for individual groups within a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartcolorconfiguration.html#cfn-quicksight-template-waterfallchartcolorconfiguration-groupcolorconfiguration

WaterfallChartConfigurationProperty

class CfnTemplatePropsMixin.WaterfallChartConfigurationProperty(*, category_axis_display_options=None, category_axis_label_options=None, color_configuration=None, data_labels=None, field_wells=None, interactions=None, legend=None, primary_y_axis_display_options=None, primary_y_axis_label_options=None, sort_configuration=None, visual_palette=None, waterfall_chart_options=None)

Bases: object

The configuration for a waterfall visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category_axis_display_options

The options that determine the presentation of the category axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-categoryaxisdisplayoptions

category_axis_label_options

The options that determine the presentation of the category axis label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-categoryaxislabeloptions

color_configuration

The color configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-colorconfiguration

data_labels

The data label configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-datalabels

field_wells

The field well configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-interactions

legend

The legend configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-legend

primary_y_axis_display_options

The options that determine the presentation of the y-axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-primaryyaxisdisplayoptions

primary_y_axis_label_options

The options that determine the presentation of the y-axis label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-primaryyaxislabeloptions

sort_configuration

The sort configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-sortconfiguration

visual_palette

The visual palette configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-visualpalette

waterfall_chart_options

The options that determine the presentation of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartconfiguration.html#cfn-quicksight-template-waterfallchartconfiguration-waterfallchartoptions

WaterfallChartFieldWellsProperty

class CfnTemplatePropsMixin.WaterfallChartFieldWellsProperty(*, waterfall_chart_aggregated_field_wells=None)

Bases: object

The field well configuration of a waterfall visual.

Parameters:

waterfall_chart_aggregated_field_wells (Union[IResolvable, WaterfallChartAggregatedFieldWellsProperty, Dict[str, Any], None]) – The field well configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
waterfall_chart_aggregated_field_wells

The field well configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartfieldwells.html#cfn-quicksight-template-waterfallchartfieldwells-waterfallchartaggregatedfieldwells

WaterfallChartGroupColorConfigurationProperty

class CfnTemplatePropsMixin.WaterfallChartGroupColorConfigurationProperty(*, negative_bar_color=None, positive_bar_color=None, total_bar_color=None)

Bases: object

The color configuration for individual groups within a waterfall visual.

Parameters:

  • negative_bar_color (Optional[str]) – Defines the color for the negative bars of a waterfall chart.

  • positive_bar_color (Optional[str]) – Defines the color for the positive bars of a waterfall chart.

  • total_bar_color (Optional[str]) – Defines the color for the total bars of a waterfall chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartgroupcolorconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

waterfall_chart_group_color_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.WaterfallChartGroupColorConfigurationProperty(
    negative_bar_color="negativeBarColor",
    positive_bar_color="positiveBarColor",
    total_bar_color="totalBarColor"
)

Attributes

negative_bar_color

Defines the color for the negative bars of a waterfall chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-template-waterfallchartgroupcolorconfiguration-negativebarcolor

positive_bar_color

Defines the color for the positive bars of a waterfall chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-template-waterfallchartgroupcolorconfiguration-positivebarcolor

total_bar_color

Defines the color for the total bars of a waterfall chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-template-waterfallchartgroupcolorconfiguration-totalbarcolor

WaterfallChartOptionsProperty

class CfnTemplatePropsMixin.WaterfallChartOptionsProperty(*, total_bar_label=None)

Bases: object

The options that determine the presentation of a waterfall visual.

Parameters:

total_bar_label (Optional[str]) – This option determines the total bar label of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

waterfall_chart_options_property = quicksight_mixins.CfnTemplatePropsMixin.WaterfallChartOptionsProperty(
    total_bar_label="totalBarLabel"
)

Attributes

total_bar_label

This option determines the total bar label of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartoptions.html#cfn-quicksight-template-waterfallchartoptions-totalbarlabel

WaterfallChartSortConfigurationProperty

class CfnTemplatePropsMixin.WaterfallChartSortConfigurationProperty(*, breakdown_items_limit=None, category_sort=None)

Bases: object

The sort configuration of a waterfall visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

waterfall_chart_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.WaterfallChartSortConfigurationProperty(
    breakdown_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

breakdown_items_limit

The limit on the number of bar groups that are displayed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartsortconfiguration.html#cfn-quicksight-template-waterfallchartsortconfiguration-breakdownitemslimit

category_sort

The sort configuration of the category fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallchartsortconfiguration.html#cfn-quicksight-template-waterfallchartsortconfiguration-categorysort

WaterfallVisualProperty

class CfnTemplatePropsMixin.WaterfallVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A waterfall chart.

For more information, see Using waterfall charts in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration for a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-waterfallvisual.html#cfn-quicksight-template-waterfallvisual-visualid

WhatIfPointScenarioProperty

class CfnTemplatePropsMixin.WhatIfPointScenarioProperty(*, date=None, value=None)

Bases: object

Provides the forecast to meet the target for a particular date.

Parameters:

  • date (Optional[str]) – The date that you need the forecast results for.

  • value (Union[int, float, None]) – The target value that you want to meet for the provided date. Default: - 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifpointscenario.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

what_if_point_scenario_property = quicksight_mixins.CfnTemplatePropsMixin.WhatIfPointScenarioProperty(
    date="date",
    value=123
)

Attributes

date

The date that you need the forecast results for.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifpointscenario.html#cfn-quicksight-template-whatifpointscenario-date

value

The target value that you want to meet for the provided date.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifpointscenario.html#cfn-quicksight-template-whatifpointscenario-value

WhatIfRangeScenarioProperty

class CfnTemplatePropsMixin.WhatIfRangeScenarioProperty(*, end_date=None, start_date=None, value=None)

Bases: object

Provides the forecast to meet the target for a particular date range.

Parameters:

  • end_date (Optional[str]) – The end date in the date range that you need the forecast results for.

  • start_date (Optional[str]) – The start date in the date range that you need the forecast results for.

  • value (Union[int, float, None]) – The target value that you want to meet for the provided date range. Default: - 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

what_if_range_scenario_property = quicksight_mixins.CfnTemplatePropsMixin.WhatIfRangeScenarioProperty(
    end_date="endDate",
    start_date="startDate",
    value=123
)

Attributes

end_date

The end date in the date range that you need the forecast results for.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html#cfn-quicksight-template-whatifrangescenario-enddate

start_date

The start date in the date range that you need the forecast results for.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html#cfn-quicksight-template-whatifrangescenario-startdate

value

The target value that you want to meet for the provided date range.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html#cfn-quicksight-template-whatifrangescenario-value

WordCloudAggregatedFieldWellsProperty

class CfnTemplatePropsMixin.WordCloudAggregatedFieldWellsProperty(*, group_by=None, size=None)

Bases: object

The aggregated field wells of a word cloud.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
group_by

The group by field well of a word cloud.

Values are grouped by group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudaggregatedfieldwells.html#cfn-quicksight-template-wordcloudaggregatedfieldwells-groupby

size

The size field well of a word cloud.

Values are aggregated based on group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudaggregatedfieldwells.html#cfn-quicksight-template-wordcloudaggregatedfieldwells-size

WordCloudChartConfigurationProperty

class CfnTemplatePropsMixin.WordCloudChartConfigurationProperty(*, category_label_options=None, field_wells=None, interactions=None, sort_configuration=None, word_cloud_options=None)

Bases: object

The configuration of a word cloud visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
category_label_options

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html#cfn-quicksight-template-wordcloudchartconfiguration-categorylabeloptions

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html#cfn-quicksight-template-wordcloudchartconfiguration-fieldwells

interactions

The general visual interactions setup for a visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html#cfn-quicksight-template-wordcloudchartconfiguration-interactions

sort_configuration

The sort configuration of a word cloud visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html#cfn-quicksight-template-wordcloudchartconfiguration-sortconfiguration

word_cloud_options

The options for a word cloud visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudchartconfiguration.html#cfn-quicksight-template-wordcloudchartconfiguration-wordcloudoptions

WordCloudFieldWellsProperty

class CfnTemplatePropsMixin.WordCloudFieldWellsProperty(*, word_cloud_aggregated_field_wells=None)

Bases: object

The field wells of a word cloud visual.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Parameters:

word_cloud_aggregated_field_wells (Union[IResolvable, WordCloudAggregatedFieldWellsProperty, Dict[str, Any], None]) – The aggregated field wells of a word cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
word_cloud_aggregated_field_wells

The aggregated field wells of a word cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudfieldwells.html#cfn-quicksight-template-wordcloudfieldwells-wordcloudaggregatedfieldwells

WordCloudOptionsProperty

class CfnTemplatePropsMixin.WordCloudOptionsProperty(*, cloud_layout=None, maximum_string_length=None, word_casing=None, word_orientation=None, word_padding=None, word_scaling=None)

Bases: object

The word cloud options for a word cloud visual.

Parameters:

  • cloud_layout (Optional[str]) – The cloud layout options (fluid, normal) of a word cloud.

  • maximum_string_length (Union[int, float, None]) – The length limit of each word from 1-100.

  • word_casing (Optional[str]) – The word casing options (lower_case, existing_case) for the words in a word cloud.

  • word_orientation (Optional[str]) – The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

  • word_padding (Optional[str]) – The word padding options (none, small, medium, large) for the words in a word cloud.

  • word_scaling (Optional[str]) – The word scaling options (emphasize, normal) for the words in a word cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

word_cloud_options_property = quicksight_mixins.CfnTemplatePropsMixin.WordCloudOptionsProperty(
    cloud_layout="cloudLayout",
    maximum_string_length=123,
    word_casing="wordCasing",
    word_orientation="wordOrientation",
    word_padding="wordPadding",
    word_scaling="wordScaling"
)

Attributes

cloud_layout

The cloud layout options (fluid, normal) of a word cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-cloudlayout

maximum_string_length

The length limit of each word from 1-100.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-maximumstringlength

word_casing

The word casing options (lower_case, existing_case) for the words in a word cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-wordcasing

word_orientation

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-wordorientation

word_padding

The word padding options (none, small, medium, large) for the words in a word cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-wordpadding

word_scaling

The word scaling options (emphasize, normal) for the words in a word cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudoptions.html#cfn-quicksight-template-wordcloudoptions-wordscaling

WordCloudSortConfigurationProperty

class CfnTemplatePropsMixin.WordCloudSortConfigurationProperty(*, category_items_limit=None, category_sort=None)

Bases: object

The sort configuration of a word cloud visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudsortconfiguration.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

word_cloud_sort_configuration_property = quicksight_mixins.CfnTemplatePropsMixin.WordCloudSortConfigurationProperty(
    category_items_limit=quicksight_mixins.CfnTemplatePropsMixin.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight_mixins.CfnTemplatePropsMixin.FieldSortOptionsProperty(
        column_sort=quicksight_mixins.CfnTemplatePropsMixin.ColumnSortProperty(
            aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight_mixins.CfnTemplatePropsMixin.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight_mixins.CfnTemplatePropsMixin.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            direction="direction",
            sort_by=quicksight_mixins.CfnTemplatePropsMixin.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        field_sort=quicksight_mixins.CfnTemplatePropsMixin.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )]
)

Attributes

category_items_limit

The limit on the number of groups that are displayed in a word cloud.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudsortconfiguration.html#cfn-quicksight-template-wordcloudsortconfiguration-categoryitemslimit

category_sort

The sort configuration of group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudsortconfiguration.html#cfn-quicksight-template-wordcloudsortconfiguration-categorysort

WordCloudVisualProperty

class CfnTemplatePropsMixin.WordCloudVisualProperty(*, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None, visual_content_alt_text=None, visual_id=None)

Bases: object

A word cloud.

For more information, see Using word clouds in the Amazon Quick Suite User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
actions

The list of custom actions that are configured for a visual.

See:

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

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-chartconfiguration

column_hierarchies

The column hierarchy that is used during drill-downs and drill-ups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-subtitle

title

The title that is displayed on the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-title

visual_content_alt_text

The alt text for the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-visualcontentalttext

visual_id

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-wordcloudvisual.html#cfn-quicksight-template-wordcloudvisual-visualid

YAxisOptionsProperty

class CfnTemplatePropsMixin.YAxisOptionsProperty(*, y_axis=None)

Bases: object

The options that are available for a single Y axis in a chart.

Parameters:

y_axis (Optional[str]) – The Y axis type to be used in the chart. If you choose PRIMARY_Y_AXIS , the primary Y Axis is located on the leftmost vertical axis of the chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-yaxisoptions.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

y_axis_options_property = quicksight_mixins.CfnTemplatePropsMixin.YAxisOptionsProperty(
    y_axis="yAxis"
)

Attributes

y_axis

The Y axis type to be used in the chart.

If you choose PRIMARY_Y_AXIS , the primary Y Axis is located on the leftmost vertical axis of the chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-yaxisoptions.html#cfn-quicksight-template-yaxisoptions-yaxis