CfnDashboard

class aws_cdk.aws_quicksight.CfnDashboard(scope, id, *, aws_account_id, dashboard_id, name, dashboard_publish_options=None, definition=None, folder_arns=None, link_entities=None, link_sharing_configuration=None, parameters=None, permissions=None, source_entity=None, tags=None, theme_arn=None, validation_strategy=None, version_description=None)

Bases: CfnResource

Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account .

See:

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

CloudformationResource:

AWS::QuickSight::Dashboard

ExampleMetadata:

fixture=_generated

Example:

:type scope: :py:class:`~constructs.Construct`
:param scope: Scope in which this resource is defined.
:type id: :py:class:`str`
:param id: Construct identifier for this resource (unique in its scope).
:type aws_account_id: :py:class:`str`
:param aws_account_id: The ID of the AWS account where you want to create the dashboard.
:type dashboard_id: :py:class:`str`
:param dashboard_id: The ID for the dashboard, also added to the IAM policy.
:type name: :py:class:`str`
:param name: The display name of the dashboard.
:type dashboard_publish_options: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_quicksight.CfnDashboard.DashboardPublishOptionsProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param dashboard_publish_options: Options for publishing the dashboard when you create it:. - ``AvailabilityStatus`` for ``AdHocFilteringOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . When this is set to ``DISABLED`` , Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ``ENABLED`` by default. - ``AvailabilityStatus`` for ``ExportToCSVOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . The visual option to export data to .CSV format isn't enabled when this is set to ``DISABLED`` . This option is ``ENABLED`` by default. - ``VisibilityState`` for ``SheetControlsOption`` - This visibility state can be either ``COLLAPSED`` or ``EXPANDED`` . This option is ``COLLAPSED`` by default.
:type definition: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_quicksight.CfnDashboard.DashboardVersionDefinitionProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param definition:
:type folder_arns: :py:data:`~typing.Optional`\[:py:class:`~typing.Sequence`\[:py:class:`str`]]
:param folder_arns:
:type link_entities: :py:data:`~typing.Optional`\[:py:class:`~typing.Sequence`\[:py:class:`str`]]
:param link_entities: A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
:type link_sharing_configuration: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_quicksight.CfnDashboard.LinkSharingConfigurationProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param link_sharing_configuration: A structure that contains the link sharing configurations that you want to apply overrides to.
:type parameters: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_quicksight.CfnDashboard.ParametersProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param parameters: The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
:type permissions: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~typing.Sequence`\[:py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_quicksight.CfnDashboard.ResourcePermissionProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`]]], :py:obj:`None`]
:param permissions: A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN. To specify no permissions, omit the permissions list.
:type source_entity: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_quicksight.CfnDashboard.DashboardSourceEntityProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param source_entity: The entity that you are using as a source when you create the dashboard. In ``SourceEntity`` , you specify the type of object that you want to use. You can only create a dashboard from a template, so you use a ``SourceTemplate`` entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the ``CreateTemplate`` API operation. For ``SourceTemplate`` , specify the Amazon Resource Name (ARN) of the source template. The ``SourceTemplate`` ARN can contain any AWS account; and any QuickSight-supported AWS Region . Use the ``DataSetReferences`` entity within ``SourceTemplate`` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
:type tags: :py:data:`~typing.Optional`\[:py:class:`~typing.Sequence`\[:py:data:`~typing.Union`\[:py:class:`~aws_cdk.CfnTag`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`]]]]
:param tags: Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
:type theme_arn: :py:data:`~typing.Optional`\[:py:class:`str`]
:param theme_arn: The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.
:type validation_strategy: :py:data:`~typing.Union`\[:py:class:`~aws_cdk.IResolvable`, :py:class:`~aws_cdk.aws_quicksight.CfnDashboard.ValidationStrategyProperty`, :py:class:`~typing.Dict`\[:py:class:`str`, :py:data:`~typing.Any`], :py:obj:`None`]
:param validation_strategy: 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.
:type version_description: :py:data:`~typing.Optional`\[:py:class:`str`]
:param version_description: A description for the first version of the dashboard being created.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

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

Return type:

None

add_dependency(target)

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

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

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

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

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

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

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

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

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

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

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

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

Parameters:

  • path (str) –

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

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

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

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters:

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

  • value (Any) – The value.

Return type:

None

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

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

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

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

Parameters:

  • policy (Optional[RemovalPolicy]) –

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

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

See:

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

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

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

Parameters:

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

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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

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

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

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

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

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

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

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

Parameters:

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

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

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

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::QuickSight::Dashboard'
attr_arn

The Amazon Resource Name (ARN) of the dashboard.

CloudformationAttribute:

Arn

attr_created_time

The time this dashboard version was created.

CloudformationAttribute:

CreatedTime

attr_last_published_time

The time that the dashboard was last published.

CloudformationAttribute:

LastPublishedTime

attr_last_updated_time

The time that the dashboard was last updated.

CloudformationAttribute:

LastUpdatedTime

attr_version

Version

Type:

cloudformationAttribute

attr_version_arn

Version.Arn

Type:

cloudformationAttribute

attr_version_created_time

Version.CreatedTime

Type:

cloudformationAttribute

attr_version_data_set_arns

Version.DataSetArns

Type:

cloudformationAttribute

attr_version_description

Version.Description

Type:

cloudformationAttribute

attr_version_errors

Version.Errors

Type:

cloudformationAttribute

attr_version_sheets

Version.Sheets

Type:

cloudformationAttribute

attr_version_source_entity_arn

Version.SourceEntityArn

Type:

cloudformationAttribute

attr_version_status

Version.Status

Type:

cloudformationAttribute

attr_version_theme_arn

Version.ThemeArn

Type:

cloudformationAttribute

attr_version_version_number

Version.VersionNumber

Type:

cloudformationAttribute

aws_account_id

The ID of the AWS account where you want to create the dashboard.

cfn_options

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

cfn_resource_type

AWS resource type.

creation_stack

return:

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

dashboard_id

The ID for the dashboard, also added to the IAM policy.

dashboard_publish_options

.

Type:

Options for publishing the dashboard when you create it

definition
folder_arns

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

A structure that contains the link sharing configurations that you want to apply overrides to.

logical_id

The logical ID for this CloudFormation stack element.

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

To override this value, use overrideLogicalId(newLogicalId).

Returns:

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

name

The display name of the dashboard.

node

The tree node.

parameters

The parameters for the creation of the dashboard, which you want to use to override the default settings.

permissions

A structure that contains the permissions of the dashboard.

ref

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

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

source_entity

The entity that you are using as a source when you create the dashboard.

stack

The stack in which this element is defined.

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

tags

Tag Manager which manages the tags for this resource.

tags_raw

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

theme_arn

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.

validation_strategy

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

version_description

A description for the first version of the dashboard being created.

Static Methods

classmethod is_cfn_element(x)

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

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

Parameters:

x (Any) –

Return type:

bool

Returns:

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

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

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

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

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

AdHocFilteringOptionProperty

class CfnDashboard.AdHocFilteringOptionProperty(*, availability_status=None)

Bases: object

An ad hoc (one-time) filtering option.

Parameters:

availability_status (Optional[str]) – Availability status.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-adhocfilteringoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

ad_hoc_filtering_option_property = quicksight.CfnDashboard.AdHocFilteringOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

Availability status.

See:

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

AggregationFunctionProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

aggregation_function_property = quicksight.CfnDashboard.AggregationFunctionProperty(
    attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
        simple_attribute_aggregation="simpleAttributeAggregation",
        value_for_multiple_values="valueForMultipleValues"
    ),
    categorical_aggregation_function="categoricalAggregationFunction",
    date_aggregation_function="dateAggregationFunction",
    numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
        percentile_aggregation=quicksight.CfnDashboard.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-dashboard-aggregationfunction.html#cfn-quicksight-dashboard-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-dashboard-aggregationfunction.html#cfn-quicksight-dashboard-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-dashboard-aggregationfunction.html#cfn-quicksight-dashboard-aggregationfunction-dateaggregationfunction

numerical_aggregation_function

Aggregation for numerical values.

See:

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

AggregationSortConfigurationProperty

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

Bases: object

The configuration options to sort aggregated values.

Parameters:

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

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

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

See:

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

aggregation_sort_configuration_property = quicksight.CfnDashboard.AggregationSortConfigurationProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    sort_direction="sortDirection",

    # the properties below are optional
    aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    )
)

Attributes

aggregation_function

The function that aggregates the values in Column .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-aggregationsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-aggregationsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-aggregationsortconfiguration.html#cfn-quicksight-dashboard-aggregationsortconfiguration-sortdirection

AnalysisDefaultsProperty

class CfnDashboard.AnalysisDefaultsProperty(*, default_new_sheet_configuration)

Bases: object

The configuration for default analysis settings.

Parameters:

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

See:

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

analysis_defaults_property = quicksight.CfnDashboard.AnalysisDefaultsProperty(
    default_new_sheet_configuration=quicksight.CfnDashboard.DefaultNewSheetConfigurationProperty(
        interactive_layout_configuration=quicksight.CfnDashboard.DefaultInteractiveLayoutConfigurationProperty(
            free_form=quicksight.CfnDashboard.DefaultFreeFormLayoutConfigurationProperty(
                canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutCanvasSizeOptionsProperty(
                    screen_canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutScreenCanvasSizeOptionsProperty(
                        optimized_view_port_width="optimizedViewPortWidth"
                    )
                )
            ),
            grid=quicksight.CfnDashboard.DefaultGridLayoutConfigurationProperty(
                canvas_size_options=quicksight.CfnDashboard.GridLayoutCanvasSizeOptionsProperty(
                    screen_canvas_size_options=quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
                        resize_option="resizeOption",

                        # the properties below are optional
                        optimized_view_port_width="optimizedViewPortWidth"
                    )
                )
            )
        ),
        paginated_layout_configuration=quicksight.CfnDashboard.DefaultPaginatedLayoutConfigurationProperty(
            section_based=quicksight.CfnDashboard.DefaultSectionBasedLayoutConfigurationProperty(
                canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutCanvasSizeOptionsProperty(
                    paper_canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
                        paper_margin=quicksight.CfnDashboard.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-dashboard-analysisdefaults.html#cfn-quicksight-dashboard-analysisdefaults-defaultnewsheetconfiguration

AnchorDateConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

anchor_date_configuration_property = quicksight.CfnDashboard.AnchorDateConfigurationProperty(
    anchor_option="anchorOption",
    parameter_name="parameterName"
)

Attributes

anchor_option

.

  • NOW

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-anchordateconfiguration.html#cfn-quicksight-dashboard-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-dashboard-anchordateconfiguration.html#cfn-quicksight-dashboard-anchordateconfiguration-parametername

ArcAxisConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

arc_axis_configuration_property = quicksight.CfnDashboard.ArcAxisConfigurationProperty(
    range=quicksight.CfnDashboard.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-dashboard-arcaxisconfiguration.html#cfn-quicksight-dashboard-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-dashboard-arcaxisconfiguration.html#cfn-quicksight-dashboard-arcaxisconfiguration-reserverange

ArcAxisDisplayRangeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

arc_axis_display_range_property = quicksight.CfnDashboard.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-dashboard-arcaxisdisplayrange.html#cfn-quicksight-dashboard-arcaxisdisplayrange-max

min

The minimum value of the arc axis range.

See:

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

ArcConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

arc_configuration_property = quicksight.CfnDashboard.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-dashboard-arcconfiguration.html#cfn-quicksight-dashboard-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-dashboard-arcconfiguration.html#cfn-quicksight-dashboard-arcconfiguration-arcthickness

ArcOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

arc_options_property = quicksight.CfnDashboard.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-dashboard-arcoptions.html#cfn-quicksight-dashboard-arcoptions-arcthickness

AssetOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

asset_options_property = quicksight.CfnDashboard.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-dashboard-assetoptions.html#cfn-quicksight-dashboard-assetoptions-timezone

week_start

Determines the week start day for an analysis.

See:

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

AttributeAggregationFunctionProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

attribute_aggregation_function_property = quicksight.CfnDashboard.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-dashboard-attributeaggregationfunction.html#cfn-quicksight-dashboard-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-dashboard-attributeaggregationfunction.html#cfn-quicksight-dashboard-attributeaggregationfunction-valueformultiplevalues

AxisDataOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

# data_driven: Any

axis_data_options_property = quicksight.CfnDashboard.AxisDataOptionsProperty(
    date_axis_options=quicksight.CfnDashboard.DateAxisOptionsProperty(
        missing_date_visibility="missingDateVisibility"
    ),
    numeric_axis_options=quicksight.CfnDashboard.NumericAxisOptionsProperty(
        range=quicksight.CfnDashboard.AxisDisplayRangeProperty(
            data_driven=data_driven,
            min_max=quicksight.CfnDashboard.AxisDisplayMinMaxRangeProperty(
                maximum=123,
                minimum=123
            )
        ),
        scale=quicksight.CfnDashboard.AxisScaleProperty(
            linear=quicksight.CfnDashboard.AxisLinearScaleProperty(
                step_count=123,
                step_size=123
            ),
            logarithmic=quicksight.CfnDashboard.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-dashboard-axisdataoptions.html#cfn-quicksight-dashboard-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-dashboard-axisdataoptions.html#cfn-quicksight-dashboard-axisdataoptions-numericaxisoptions

AxisDisplayMinMaxRangeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

axis_display_min_max_range_property = quicksight.CfnDashboard.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-dashboard-axisdisplayminmaxrange.html#cfn-quicksight-dashboard-axisdisplayminmaxrange-maximum

minimum

The minimum setup for an axis display range.

See:

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

AxisDisplayOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

# data_driven: Any

axis_display_options_property = quicksight.CfnDashboard.AxisDisplayOptionsProperty(
    axis_line_visibility="axisLineVisibility",
    axis_offset="axisOffset",
    data_options=quicksight.CfnDashboard.AxisDataOptionsProperty(
        date_axis_options=quicksight.CfnDashboard.DateAxisOptionsProperty(
            missing_date_visibility="missingDateVisibility"
        ),
        numeric_axis_options=quicksight.CfnDashboard.NumericAxisOptionsProperty(
            range=quicksight.CfnDashboard.AxisDisplayRangeProperty(
                data_driven=data_driven,
                min_max=quicksight.CfnDashboard.AxisDisplayMinMaxRangeProperty(
                    maximum=123,
                    minimum=123
                )
            ),
            scale=quicksight.CfnDashboard.AxisScaleProperty(
                linear=quicksight.CfnDashboard.AxisLinearScaleProperty(
                    step_count=123,
                    step_size=123
                ),
                logarithmic=quicksight.CfnDashboard.AxisLogarithmicScaleProperty(
                    base=123
                )
            )
        )
    ),
    grid_line_visibility="gridLineVisibility",
    scrollbar_options=quicksight.CfnDashboard.ScrollBarOptionsProperty(
        visibility="visibility",
        visible_range=quicksight.CfnDashboard.VisibleRangeOptionsProperty(
            percent_range=quicksight.CfnDashboard.PercentVisibleRangeProperty(
                from=123,
                to=123
            )
        )
    ),
    tick_label_options=quicksight.CfnDashboard.AxisTickLabelOptionsProperty(
        label_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-axisdisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-axisdisplayoptions.html#cfn-quicksight-dashboard-axisdisplayoptions-axisoffset

data_options

The data options for an axis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-axisdisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-axisdisplayoptions.html#cfn-quicksight-dashboard-axisdisplayoptions-gridlinevisibility

scrollbar_options

The scroll bar options for an axis.

See:

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

tick_label_options

The tick label options of an axis.

See:

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

AxisDisplayRangeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

# data_driven: Any

axis_display_range_property = quicksight.CfnDashboard.AxisDisplayRangeProperty(
    data_driven=data_driven,
    min_max=quicksight.CfnDashboard.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-dashboard-axisdisplayrange.html#cfn-quicksight-dashboard-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-dashboard-axisdisplayrange.html#cfn-quicksight-dashboard-axisdisplayrange-minmax

AxisLabelOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

axis_label_options_property = quicksight.CfnDashboard.AxisLabelOptionsProperty(
    apply_to=quicksight.CfnDashboard.AxisLabelReferenceOptionsProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId"
    ),
    custom_label="customLabel",
    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.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-dashboard-axislabeloptions.html#cfn-quicksight-dashboard-axislabeloptions-applyto

custom_label

The text for the axis label.

See:

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

font_configuration

The font configuration of the axis label.

See:

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

AxisLabelReferenceOptionsProperty

class CfnDashboard.AxisLabelReferenceOptionsProperty(*, column, field_id)

Bases: object

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

Parameters:

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

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

See:

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

axis_label_reference_options_property = quicksight.CfnDashboard.AxisLabelReferenceOptionsProperty(
    column=quicksight.CfnDashboard.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-dashboard-axislabelreferenceoptions.html#cfn-quicksight-dashboard-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-dashboard-axislabelreferenceoptions.html#cfn-quicksight-dashboard-axislabelreferenceoptions-fieldid

AxisLinearScaleProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

axis_linear_scale_property = quicksight.CfnDashboard.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-dashboard-axislinearscale.html#cfn-quicksight-dashboard-axislinearscale-stepcount

step_size

The step size setup of a linear axis.

See:

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

AxisLogarithmicScaleProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

axis_logarithmic_scale_property = quicksight.CfnDashboard.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-dashboard-axislogarithmicscale.html#cfn-quicksight-dashboard-axislogarithmicscale-base

AxisScaleProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

axis_scale_property = quicksight.CfnDashboard.AxisScaleProperty(
    linear=quicksight.CfnDashboard.AxisLinearScaleProperty(
        step_count=123,
        step_size=123
    ),
    logarithmic=quicksight.CfnDashboard.AxisLogarithmicScaleProperty(
        base=123
    )
)

Attributes

linear

The linear axis scale setup.

See:

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

logarithmic

The logarithmic axis scale setup.

See:

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

AxisTickLabelOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

axis_tick_label_options_property = quicksight.CfnDashboard.AxisTickLabelOptionsProperty(
    label_options=quicksight.CfnDashboard.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-axisticklabeloptions.html#cfn-quicksight-dashboard-axisticklabeloptions-labeloptions

rotation_angle

The rotation angle of the axis tick labels.

See:

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

BarChartAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-barchartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-barchartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-barchartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-barchartaggregatedfieldwells.html#cfn-quicksight-dashboard-barchartaggregatedfieldwells-values

BarChartConfigurationProperty

class CfnDashboard.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, 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.

  • 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-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-datalabels

field_wells

The field wells of the visual.

See:

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

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-referencelines

small_multiples_options

The small multiples setup for the visual.

See:

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

sort_configuration

The sort configuration of a BarChartVisual .

See:

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

tooltip

The tooltip display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartconfiguration.html#cfn-quicksight-dashboard-barchartconfiguration-visualpalette

BarChartFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-barchartfieldwells.html#cfn-quicksight-dashboard-barchartfieldwells-barchartaggregatedfieldwells

BarChartSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

bar_chart_sort_configuration_property = quicksight.CfnDashboard.BarChartSortConfigurationProperty(
    category_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    color_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    color_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    small_multiples_limit_configuration=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    small_multiples_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-barchartsortconfiguration-categoryitemslimit

category_sort

The sort configuration of category fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-barchartsortconfiguration.html#cfn-quicksight-dashboard-barchartsortconfiguration-smallmultiplessort

BarChartVisualProperty

class CfnDashboard.BarChartVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=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 QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-barchartvisual.html#cfn-quicksight-dashboard-barchartvisual-actions

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-barchartvisual.html#cfn-quicksight-dashboard-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-dashboard-barchartvisual.html#cfn-quicksight-dashboard-barchartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-barchartvisual.html#cfn-quicksight-dashboard-barchartvisual-visualid

BinCountOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

bin_count_options_property = quicksight.CfnDashboard.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-dashboard-bincountoptions.html#cfn-quicksight-dashboard-bincountoptions-value

BinWidthOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

bin_width_options_property = quicksight.CfnDashboard.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-dashboard-binwidthoptions.html#cfn-quicksight-dashboard-binwidthoptions-bincountlimit

value

The options that determine the bin width value.

See:

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

BodySectionConfigurationProperty

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

Bases: object

The configuration of a body section.

Parameters:
See:

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

body_section_configuration_property = quicksight.CfnDashboard.BodySectionConfigurationProperty(
    content=quicksight.CfnDashboard.BodySectionContentProperty(
        layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
            free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
                elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                    element_id="elementId",
                    element_type="elementType",
                    height="height",
                    width="width",
                    x_axis_location="xAxisLocation",
                    y_axis_location="yAxisLocation",

                    # the properties below are optional
                    background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                        visibility="visibility"
                    ),
                    rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                        configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                            visibility="visibility"
                        ),
                        expression="expression"
                    )],
                    selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    visibility="visibility"
                )]
            )
        )
    ),
    section_id="sectionId",

    # the properties below are optional
    page_break_configuration=quicksight.CfnDashboard.SectionPageBreakConfigurationProperty(
        after=quicksight.CfnDashboard.SectionAfterPageBreakProperty(
            status="status"
        )
    ),
    style=quicksight.CfnDashboard.SectionStyleProperty(
        height="height",
        padding=quicksight.CfnDashboard.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-dashboard-bodysectionconfiguration.html#cfn-quicksight-dashboard-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-dashboard-bodysectionconfiguration.html#cfn-quicksight-dashboard-bodysectionconfiguration-pagebreakconfiguration

section_id

The unique identifier of a body section.

See:

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

style

The style options of a body section.

See:

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

BodySectionContentProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

body_section_content_property = quicksight.CfnDashboard.BodySectionContentProperty(
    layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
        free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
            elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                element_id="elementId",
                element_type="elementType",
                height="height",
                width="width",
                x_axis_location="xAxisLocation",
                y_axis_location="yAxisLocation",

                # the properties below are optional
                background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                    visibility="visibility"
                ),
                rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                    configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                        visibility="visibility"
                    ),
                    expression="expression"
                )],
                selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                visibility="visibility"
            )]
        )
    )
)

Attributes

layout

The layout configuration of a body section.

See:

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

BoxPlotAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-boxplotaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

box_plot_aggregated_field_wells_property = quicksight.CfnDashboard.BoxPlotAggregatedFieldWellsProperty(
    group_by=[quicksight.CfnDashboard.DimensionFieldProperty(
        categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            date_granularity="dateGranularity",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    )],
    values=[quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        )
    )]
)

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-dashboard-boxplotaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-boxplotaggregatedfieldwells.html#cfn-quicksight-dashboard-boxplotaggregatedfieldwells-values

BoxPlotChartConfigurationProperty

class CfnDashboard.BoxPlotChartConfigurationProperty(*, box_plot_options=None, category_axis=None, category_label_options=None, field_wells=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-dashboard-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-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-categorylabeloptions

field_wells

The field wells of the visual.

See:

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

legend

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-primaryyaxislabeloptions

reference_lines

The reference line setup of the visual.

See:

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

sort_configuration

The sort configuration of a BoxPlotVisual .

See:

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

tooltip

The tooltip display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-boxplotchartconfiguration.html#cfn-quicksight-dashboard-boxplotchartconfiguration-visualpalette

BoxPlotFieldWellsProperty

class CfnDashboard.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-dashboard-boxplotfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

box_plot_field_wells_property = quicksight.CfnDashboard.BoxPlotFieldWellsProperty(
    box_plot_aggregated_field_wells=quicksight.CfnDashboard.BoxPlotAggregatedFieldWellsProperty(
        group_by=[quicksight.CfnDashboard.DimensionFieldProperty(
            categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            ),
            date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                date_granularity="dateGranularity",
                format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                    date_time_format="dateTimeFormat",
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            ),
            numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            )
        )],
        values=[quicksight.CfnDashboard.MeasureFieldProperty(
            calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
                expression="expression",
                field_id="fieldId"
            ),
            categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function="aggregationFunction",
                format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function="aggregationFunction",
                format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                    date_time_format="dateTimeFormat",
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                ),
                format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            )
        )]
    )
)

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-dashboard-boxplotfieldwells.html#cfn-quicksight-dashboard-boxplotfieldwells-boxplotaggregatedfieldwells

BoxPlotOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

box_plot_options_property = quicksight.CfnDashboard.BoxPlotOptionsProperty(
    all_data_points_visibility="allDataPointsVisibility",
    outlier_visibility="outlierVisibility",
    style_options=quicksight.CfnDashboard.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-dashboard-boxplotoptions.html#cfn-quicksight-dashboard-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-dashboard-boxplotoptions.html#cfn-quicksight-dashboard-boxplotoptions-outliervisibility

style_options

The style options of the box plot.

See:

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

BoxPlotSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

box_plot_sort_configuration_property = quicksight.CfnDashboard.BoxPlotSortConfigurationProperty(
    category_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    pagination_configuration=quicksight.CfnDashboard.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-dashboard-boxplotsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-boxplotsortconfiguration.html#cfn-quicksight-dashboard-boxplotsortconfiguration-paginationconfiguration

BoxPlotStyleOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

box_plot_style_options_property = quicksight.CfnDashboard.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-dashboard-boxplotstyleoptions.html#cfn-quicksight-dashboard-boxplotstyleoptions-fillstyle

BoxPlotVisualProperty

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

Bases: object

A box plot.

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

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-boxplotvisual-actions

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-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-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-boxplotvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-boxplotvisual.html#cfn-quicksight-dashboard-boxplotvisual-visualid

CalculatedFieldProperty

class CfnDashboard.CalculatedFieldProperty(*, data_set_identifier, expression, name)

Bases: object

The calculated field of an analysis.

Parameters:

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

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

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

See:

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

calculated_field_property = quicksight.CfnDashboard.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-dashboard-calculatedfield.html#cfn-quicksight-dashboard-calculatedfield-datasetidentifier

expression

The expression of the calculated field.

See:

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

name

The name of the calculated field.

See:

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

CalculatedMeasureFieldProperty

class CfnDashboard.CalculatedMeasureFieldProperty(*, expression, field_id)

Bases: object

The table calculation measure field for pivot tables.

Parameters:

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

  • field_id (str) – The custom field ID.

See:

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

calculated_measure_field_property = quicksight.CfnDashboard.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-dashboard-calculatedmeasurefield.html#cfn-quicksight-dashboard-calculatedmeasurefield-expression

field_id

The custom field ID.

See:

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

CascadingControlConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

cascading_control_configuration_property = quicksight.CfnDashboard.CascadingControlConfigurationProperty(
    source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
        column_to_match=quicksight.CfnDashboard.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-dashboard-cascadingcontrolconfiguration.html#cfn-quicksight-dashboard-cascadingcontrolconfiguration-sourcecontrols

CascadingControlSourceProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

cascading_control_source_property = quicksight.CfnDashboard.CascadingControlSourceProperty(
    column_to_match=quicksight.CfnDashboard.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-dashboard-cascadingcontrolsource.html#cfn-quicksight-dashboard-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-dashboard-cascadingcontrolsource.html#cfn-quicksight-dashboard-cascadingcontrolsource-sourcesheetcontrolid

CategoricalDimensionFieldProperty

class CfnDashboard.CategoricalDimensionFieldProperty(*, column, field_id, 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-dashboard-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 import aws_quicksight as quicksight

categorical_dimension_field_property = quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",

    # the properties below are optional
    format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        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-dashboard-categoricaldimensionfield.html#cfn-quicksight-dashboard-categoricaldimensionfield-column

field_id

The custom field ID.

See:

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

format_configuration

The format configuration of the field.

See:

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

hierarchy_id

The custom hierarchy ID.

See:

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

CategoricalMeasureFieldProperty

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

Bases: object

The measure type field with categorical type columns.

Parameters:

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

  • field_id (str) – The custom field ID.

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

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

categorical_measure_field_property = quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",

    # the properties below are optional
    aggregation_function="aggregationFunction",
    format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        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-dashboard-categoricalmeasurefield.html#cfn-quicksight-dashboard-categoricalmeasurefield-aggregationfunction

column

The column that is used in the CategoricalMeasureField .

See:

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

field_id

The custom field ID.

See:

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

format_configuration

The format configuration of the field.

See:

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

CategoryDrillDownFilterProperty

class CfnDashboard.CategoryDrillDownFilterProperty(*, category_values, column)

Bases: object

The category drill down filter.

Parameters:

  • category_values (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]]) – The column that the filter is applied to.

See:

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

category_drill_down_filter_property = quicksight.CfnDashboard.CategoryDrillDownFilterProperty(
    category_values=["categoryValues"],
    column=quicksight.CfnDashboard.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-dashboard-categorydrilldownfilter.html#cfn-quicksight-dashboard-categorydrilldownfilter-categoryvalues

column

The column that the filter is applied to.

See:

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

CategoryFilterConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

category_filter_configuration_property = quicksight.CfnDashboard.CategoryFilterConfigurationProperty(
    custom_filter_configuration=quicksight.CfnDashboard.CustomFilterConfigurationProperty(
        match_operator="matchOperator",
        null_option="nullOption",

        # the properties below are optional
        category_value="categoryValue",
        parameter_name="parameterName",
        select_all_options="selectAllOptions"
    ),
    custom_filter_list_configuration=quicksight.CfnDashboard.CustomFilterListConfigurationProperty(
        match_operator="matchOperator",
        null_option="nullOption",

        # the properties below are optional
        category_values=["categoryValues"],
        select_all_options="selectAllOptions"
    ),
    filter_list_configuration=quicksight.CfnDashboard.FilterListConfigurationProperty(
        match_operator="matchOperator",

        # the properties below are optional
        category_values=["categoryValues"],
        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-dashboard-categoryfilterconfiguration.html#cfn-quicksight-dashboard-categoryfilterconfiguration-customfilterconfiguration

custom_filter_list_configuration

A list of custom filter values.

In the Amazon QuickSight console, this filter type is called a custom filter list.

See:

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

filter_list_configuration

A list of filter configurations.

In the Amazon QuickSight console, this filter type is called a filter list.

See:

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

CategoryFilterProperty

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

Bases: object

A CategoryFilter filters text values.

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

Parameters:
See:

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

category_filter_property = quicksight.CfnDashboard.CategoryFilterProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    configuration=quicksight.CfnDashboard.CategoryFilterConfigurationProperty(
        custom_filter_configuration=quicksight.CfnDashboard.CustomFilterConfigurationProperty(
            match_operator="matchOperator",
            null_option="nullOption",

            # the properties below are optional
            category_value="categoryValue",
            parameter_name="parameterName",
            select_all_options="selectAllOptions"
        ),
        custom_filter_list_configuration=quicksight.CfnDashboard.CustomFilterListConfigurationProperty(
            match_operator="matchOperator",
            null_option="nullOption",

            # the properties below are optional
            category_values=["categoryValues"],
            select_all_options="selectAllOptions"
        ),
        filter_list_configuration=quicksight.CfnDashboard.FilterListConfigurationProperty(
            match_operator="matchOperator",

            # the properties below are optional
            category_values=["categoryValues"],
            null_option="nullOption",
            select_all_options="selectAllOptions"
        )
    ),
    filter_id="filterId",

    # the properties below are optional
    default_filter_control_configuration=quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
        control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
                display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
                maximum_value=123,
                minimum_value=123,
                step_size=123,

                # the properties below are optional
                display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.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-dashboard-categoryfilter.html#cfn-quicksight-dashboard-categoryfilter-column

configuration

The configuration for a CategoryFilter .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilter.html#cfn-quicksight-dashboard-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-dashboard-categoryfilter.html#cfn-quicksight-dashboard-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-dashboard-categoryfilter.html#cfn-quicksight-dashboard-categoryfilter-filterid

CategoryInnerFilterProperty

class CfnDashboard.CategoryInnerFilterProperty(*, column, configuration, 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-dashboard-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 import aws_quicksight as quicksight

category_inner_filter_property = quicksight.CfnDashboard.CategoryInnerFilterProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    configuration=quicksight.CfnDashboard.CategoryFilterConfigurationProperty(
        custom_filter_configuration=quicksight.CfnDashboard.CustomFilterConfigurationProperty(
            match_operator="matchOperator",
            null_option="nullOption",

            # the properties below are optional
            category_value="categoryValue",
            parameter_name="parameterName",
            select_all_options="selectAllOptions"
        ),
        custom_filter_list_configuration=quicksight.CfnDashboard.CustomFilterListConfigurationProperty(
            match_operator="matchOperator",
            null_option="nullOption",

            # the properties below are optional
            category_values=["categoryValues"],
            select_all_options="selectAllOptions"
        ),
        filter_list_configuration=quicksight.CfnDashboard.FilterListConfigurationProperty(
            match_operator="matchOperator",

            # the properties below are optional
            category_values=["categoryValues"],
            null_option="nullOption",
            select_all_options="selectAllOptions"
        )
    ),

    # the properties below are optional
    default_filter_control_configuration=quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
        control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
                display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
                maximum_value=123,
                minimum_value=123,
                step_size=123,

                # the properties below are optional
                display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    )
)

Attributes

column

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

Type:

see

configuration

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

Type:

see

default_filter_control_configuration

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

Type:

see

ChartAxisLabelOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

chart_axis_label_options_property = quicksight.CfnDashboard.ChartAxisLabelOptionsProperty(
    axis_label_options=[quicksight.CfnDashboard.AxisLabelOptionsProperty(
        apply_to=quicksight.CfnDashboard.AxisLabelReferenceOptionsProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId"
        ),
        custom_label="customLabel",
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-chartaxislabeloptions.html#cfn-quicksight-dashboard-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-dashboard-chartaxislabeloptions.html#cfn-quicksight-dashboard-chartaxislabeloptions-sorticonvisibility

visibility

.

  • VISIBLE : Shows the axis.

  • HIDDEN : Hides the axis.

See:

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

Type:

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

ClusterMarkerConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

cluster_marker_configuration_property = quicksight.CfnDashboard.ClusterMarkerConfigurationProperty(
    cluster_marker=quicksight.CfnDashboard.ClusterMarkerProperty(
        simple_cluster_marker=quicksight.CfnDashboard.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-dashboard-clustermarkerconfiguration.html#cfn-quicksight-dashboard-clustermarkerconfiguration-clustermarker

ClusterMarkerProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

cluster_marker_property = quicksight.CfnDashboard.ClusterMarkerProperty(
    simple_cluster_marker=quicksight.CfnDashboard.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-dashboard-clustermarker.html#cfn-quicksight-dashboard-clustermarker-simpleclustermarker

ColorScaleProperty

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

Bases: object

Determines the color scale that is applied to the visual.

Parameters:

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

  • colors (Union[IResolvable, Sequence[Union[IResolvable, DataColorProperty, Dict[str, Any]]]]) – 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-dashboard-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 import aws_quicksight as quicksight

color_scale_property = quicksight.CfnDashboard.ColorScaleProperty(
    color_fill_type="colorFillType",
    colors=[quicksight.CfnDashboard.DataColorProperty(
        color="color",
        data_value=123
    )],

    # the properties below are optional
    null_value_color=quicksight.CfnDashboard.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-dashboard-colorscale.html#cfn-quicksight-dashboard-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-dashboard-colorscale.html#cfn-quicksight-dashboard-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-dashboard-colorscale.html#cfn-quicksight-dashboard-colorscale-nullvaluecolor

ColorsConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

colors_configuration_property = quicksight.CfnDashboard.ColorsConfigurationProperty(
    custom_colors=[quicksight.CfnDashboard.CustomColorProperty(
        color="color",

        # the properties below are optional
        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-dashboard-colorsconfiguration.html#cfn-quicksight-dashboard-colorsconfiguration-customcolors

ColumnConfigurationProperty

class CfnDashboard.ColumnConfigurationProperty(*, column, colors_configuration=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-dashboard-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 import aws_quicksight as quicksight

column_configuration_property = quicksight.CfnDashboard.ColumnConfigurationProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),

    # the properties below are optional
    colors_configuration=quicksight.CfnDashboard.ColorsConfigurationProperty(
        custom_colors=[quicksight.CfnDashboard.CustomColorProperty(
            color="color",

            # the properties below are optional
            field_value="fieldValue",
            special_value="specialValue"
        )]
    ),
    format_configuration=quicksight.CfnDashboard.FormatConfigurationProperty(
        date_time_format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
            date_time_format="dateTimeFormat",
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        number_format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
            format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        string_format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            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-dashboard-columnconfiguration.html#cfn-quicksight-dashboard-columnconfiguration-colorsconfiguration

column

The column.

See:

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

format_configuration

The format configuration of a column.

See:

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

role

The role of the column.

See:

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

ColumnHierarchyProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

column_hierarchy_property = quicksight.CfnDashboard.ColumnHierarchyProperty(
    date_time_hierarchy=quicksight.CfnDashboard.DateTimeHierarchyProperty(
        hierarchy_id="hierarchyId",

        # the properties below are optional
        drill_down_filters=[quicksight.CfnDashboard.DrillDownFilterProperty(
            category_filter=quicksight.CfnDashboard.CategoryDrillDownFilterProperty(
                category_values=["categoryValues"],
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            numeric_equality_filter=quicksight.CfnDashboard.NumericEqualityDrillDownFilterProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                value=123
            ),
            time_range_filter=quicksight.CfnDashboard.TimeRangeDrillDownFilterProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                range_maximum="rangeMaximum",
                range_minimum="rangeMinimum",
                time_granularity="timeGranularity"
            )
        )]
    ),
    explicit_hierarchy=quicksight.CfnDashboard.ExplicitHierarchyProperty(
        columns=[quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )],
        hierarchy_id="hierarchyId",

        # the properties below are optional
        drill_down_filters=[quicksight.CfnDashboard.DrillDownFilterProperty(
            category_filter=quicksight.CfnDashboard.CategoryDrillDownFilterProperty(
                category_values=["categoryValues"],
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            numeric_equality_filter=quicksight.CfnDashboard.NumericEqualityDrillDownFilterProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                value=123
            ),
            time_range_filter=quicksight.CfnDashboard.TimeRangeDrillDownFilterProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                range_maximum="rangeMaximum",
                range_minimum="rangeMinimum",
                time_granularity="timeGranularity"
            )
        )]
    ),
    predefined_hierarchy=quicksight.CfnDashboard.PredefinedHierarchyProperty(
        columns=[quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )],
        hierarchy_id="hierarchyId",

        # the properties below are optional
        drill_down_filters=[quicksight.CfnDashboard.DrillDownFilterProperty(
            category_filter=quicksight.CfnDashboard.CategoryDrillDownFilterProperty(
                category_values=["categoryValues"],
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            numeric_equality_filter=quicksight.CfnDashboard.NumericEqualityDrillDownFilterProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                value=123
            ),
            time_range_filter=quicksight.CfnDashboard.TimeRangeDrillDownFilterProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                range_maximum="rangeMaximum",
                range_minimum="rangeMinimum",
                time_granularity="timeGranularity"
            )
        )]
    )
)

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-dashboard-columnhierarchy.html#cfn-quicksight-dashboard-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-dashboard-columnhierarchy.html#cfn-quicksight-dashboard-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-dashboard-columnhierarchy.html#cfn-quicksight-dashboard-columnhierarchy-predefinedhierarchy

ColumnIdentifierProperty

class CfnDashboard.ColumnIdentifierProperty(*, column_name, data_set_identifier)

Bases: object

A column of a data set.

Parameters:

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

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

See:

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

column_identifier_property = quicksight.CfnDashboard.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-dashboard-columnidentifier.html#cfn-quicksight-dashboard-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-dashboard-columnidentifier.html#cfn-quicksight-dashboard-columnidentifier-datasetidentifier

ColumnSortProperty

class CfnDashboard.ColumnSortProperty(*, direction, sort_by, aggregation_function=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-dashboard-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 import aws_quicksight as quicksight

column_sort_property = quicksight.CfnDashboard.ColumnSortProperty(
    direction="direction",
    sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),

    # the properties below are optional
    aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    )
)

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-dashboard-columnsort.html#cfn-quicksight-dashboard-columnsort-aggregationfunction

direction

The sort direction.

See:

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

sort_by

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

Type:

see

ColumnTooltipItemProperty

class CfnDashboard.ColumnTooltipItemProperty(*, column, aggregation=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:

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

  • aggregation (Union[IResolvable, AggregationFunctionProperty, Dict[str, Any], None]) – The aggregation function of the column 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-dashboard-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 import aws_quicksight as quicksight

column_tooltip_item_property = quicksight.CfnDashboard.ColumnTooltipItemProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),

    # the properties below are optional
    aggregation=quicksight.CfnDashboard.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    ),
    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-dashboard-columntooltipitem.html#cfn-quicksight-dashboard-columntooltipitem-aggregation

column

The target column of the tooltip item.

See:

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

label

The label of the tooltip item.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columntooltipitem.html#cfn-quicksight-dashboard-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-dashboard-columntooltipitem.html#cfn-quicksight-dashboard-columntooltipitem-tooltiptarget

visibility

The visibility of the tooltip item.

See:

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

ComboChartAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-combochartaggregatedfieldwells.html#cfn-quicksight-dashboard-combochartaggregatedfieldwells-barvalues

category

The aggregated category field wells of a combo chart.

See:

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

colors

The aggregated colors field well of a combo chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-combochartaggregatedfieldwells.html#cfn-quicksight-dashboard-combochartaggregatedfieldwells-linevalues

ComboChartConfigurationProperty

class CfnDashboard.ComboChartConfigurationProperty(*, bar_data_labels=None, bars_arrangement=None, category_axis=None, category_label_options=None, color_label_options=None, field_wells=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.

  • 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-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-colorlabeloptions

field_wells

The field wells of the visual.

See:

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

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-primaryyaxislabeloptions

reference_lines

The reference line setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-secondaryyaxislabeloptions

single_axis_options

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

Type:

see

sort_configuration

The sort configuration of a ComboChartVisual .

See:

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

tooltip

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartconfiguration.html#cfn-quicksight-dashboard-combochartconfiguration-visualpalette

ComboChartFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-combochartfieldwells.html#cfn-quicksight-dashboard-combochartfieldwells-combochartaggregatedfieldwells

ComboChartSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

combo_chart_sort_configuration_property = quicksight.CfnDashboard.ComboChartSortConfigurationProperty(
    category_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    color_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    color_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-combochartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-combochartsortconfiguration.html#cfn-quicksight-dashboard-combochartsortconfiguration-colorsort

ComboChartVisualProperty

class CfnDashboard.ComboChartVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=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 QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-combochartvisual.html#cfn-quicksight-dashboard-combochartvisual-actions

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-combochartvisual.html#cfn-quicksight-dashboard-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-dashboard-combochartvisual.html#cfn-quicksight-dashboard-combochartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-combochartvisual.html#cfn-quicksight-dashboard-combochartvisual-visualid

ComparisonConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

comparison_configuration_property = quicksight.CfnDashboard.ComparisonConfigurationProperty(
    comparison_format=quicksight.CfnDashboard.ComparisonFormatConfigurationProperty(
        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    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-dashboard-comparisonconfiguration.html#cfn-quicksight-dashboard-comparisonconfiguration-comparisonformat

comparison_method

.

  • DIFFERENCE

  • PERCENT_DIFFERENCE

  • PERCENT

See:

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

Type:

The method of the comparison. Choose from the following options

ComparisonFormatConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

comparison_format_configuration_property = quicksight.CfnDashboard.ComparisonFormatConfigurationProperty(
    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
            decimal_places=123
        ),
        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
            display_mode="displayMode"
        ),
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        number_scale="numberScale",
        prefix="prefix",
        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
            decimal_separator="decimalSeparator",
            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                symbol="symbol",
                visibility="visibility"
            )
        ),
        suffix="suffix"
    ),
    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
            decimal_places=123
        ),
        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
            display_mode="displayMode"
        ),
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        prefix="prefix",
        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
            decimal_separator="decimalSeparator",
            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                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-dashboard-comparisonformatconfiguration.html#cfn-quicksight-dashboard-comparisonformatconfiguration-numberdisplayformatconfiguration

percentage_display_format_configuration

The percentage display format.

See:

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

ComputationProperty

class CfnDashboard.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-dashboard-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-dashboard-computation.html#cfn-quicksight-dashboard-computation-forecast

growth_rate

The growth rate computation configuration.

See:

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

maximum_minimum

The maximum and minimum computation configuration.

See:

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

metric_comparison

The metric comparison computation configuration.

See:

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

period_over_period

The period over period computation configuration.

See:

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

period_to_date

The period to DataSetIdentifier computation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-computation.html#cfn-quicksight-dashboard-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-dashboard-computation.html#cfn-quicksight-dashboard-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-dashboard-computation.html#cfn-quicksight-dashboard-computation-topbottomranked

total_aggregation

The total aggregation computation configuration.

See:

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

unique_values

The unique values computation configuration.

See:

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

ConditionalFormattingColorProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

conditional_formatting_color_property = quicksight.CfnDashboard.ConditionalFormattingColorProperty(
    gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
        color=quicksight.CfnDashboard.GradientColorProperty(
            stops=[quicksight.CfnDashboard.GradientStopProperty(
                gradient_offset=123,

                # the properties below are optional
                color="color",
                data_value=123
            )]
        ),
        expression="expression"
    ),
    solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
        expression="expression",

        # the properties below are optional
        color="color"
    )
)

Attributes

gradient

Formatting configuration for gradient color.

See:

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

solid

Formatting configuration for solid color.

See:

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

ConditionalFormattingCustomIconConditionProperty

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

Bases: object

Determines the custom condition for an icon set.

Parameters:
See:

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

conditional_formatting_custom_icon_condition_property = quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
    expression="expression",
    icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
        icon="icon",
        unicode_icon="unicodeIcon"
    ),

    # the properties below are optional
    color="color",
    display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
        icon_display_option="iconDisplayOption"
    )
)

Attributes

color

Determines the color of the icon.

See:

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

display_configuration

Determines the icon display configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingcustomiconcondition.html#cfn-quicksight-dashboard-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-dashboard-conditionalformattingcustomiconcondition.html#cfn-quicksight-dashboard-conditionalformattingcustomiconcondition-expression

icon_options

Custom icon options for an icon set.

See:

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

ConditionalFormattingCustomIconOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

conditional_formatting_custom_icon_options_property = quicksight.CfnDashboard.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-dashboard-conditionalformattingcustomiconoptions.html#cfn-quicksight-dashboard-conditionalformattingcustomiconoptions-icon

unicode_icon

Determines the Unicode icon type.

See:

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

ConditionalFormattingGradientColorProperty

class CfnDashboard.ConditionalFormattingGradientColorProperty(*, color, expression)

Bases: object

Formatting configuration for gradient color.

Parameters:

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

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

See:

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

conditional_formatting_gradient_color_property = quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
    color=quicksight.CfnDashboard.GradientColorProperty(
        stops=[quicksight.CfnDashboard.GradientStopProperty(
            gradient_offset=123,

            # the properties below are optional
            color="color",
            data_value=123
        )]
    ),
    expression="expression"
)

Attributes

color

Determines the color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattinggradientcolor.html#cfn-quicksight-dashboard-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-dashboard-conditionalformattinggradientcolor.html#cfn-quicksight-dashboard-conditionalformattinggradientcolor-expression

ConditionalFormattingIconDisplayConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

conditional_formatting_icon_display_configuration_property = quicksight.CfnDashboard.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-dashboard-conditionalformattingicondisplayconfiguration.html#cfn-quicksight-dashboard-conditionalformattingicondisplayconfiguration-icondisplayoption

ConditionalFormattingIconProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

conditional_formatting_icon_property = quicksight.CfnDashboard.ConditionalFormattingIconProperty(
    custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
        expression="expression",
        icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
            icon="icon",
            unicode_icon="unicodeIcon"
        ),

        # the properties below are optional
        color="color",
        display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
            icon_display_option="iconDisplayOption"
        )
    ),
    icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
        expression="expression",

        # the properties below are optional
        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-dashboard-conditionalformattingicon.html#cfn-quicksight-dashboard-conditionalformattingicon-customcondition

icon_set

Formatting configuration for icon set.

See:

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

ConditionalFormattingIconSetProperty

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

Bases: object

Formatting configuration for icon set.

Parameters:

  • expression (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-dashboard-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 import aws_quicksight as quicksight

conditional_formatting_icon_set_property = quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
    expression="expression",

    # the properties below are optional
    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-dashboard-conditionalformattingiconset.html#cfn-quicksight-dashboard-conditionalformattingiconset-expression

icon_set_type

Determines the icon set type.

See:

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

ConditionalFormattingSolidColorProperty

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

Bases: object

Formatting configuration for solid color.

Parameters:

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

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

See:

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

conditional_formatting_solid_color_property = quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
    expression="expression",

    # the properties below are optional
    color="color"
)

Attributes

color

Determines the color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-conditionalformattingsolidcolor.html#cfn-quicksight-dashboard-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-dashboard-conditionalformattingsolidcolor.html#cfn-quicksight-dashboard-conditionalformattingsolidcolor-expression

ContributionAnalysisDefaultProperty

class CfnDashboard.ContributionAnalysisDefaultProperty(*, contributor_dimensions, measure_field_id)

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]]]]) – The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .

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

See:

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

contribution_analysis_default_property = quicksight.CfnDashboard.ContributionAnalysisDefaultProperty(
    contributor_dimensions=[quicksight.CfnDashboard.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-dashboard-contributionanalysisdefault.html#cfn-quicksight-dashboard-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-dashboard-contributionanalysisdefault.html#cfn-quicksight-dashboard-contributionanalysisdefault-measurefieldid

CurrencyDisplayFormatConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

currency_display_format_configuration_property = quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
        decimal_places=123
    ),
    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
        display_mode="displayMode"
    ),
    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    number_scale="numberScale",
    prefix="prefix",
    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
        decimal_separator="decimalSeparator",
        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
            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-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-currencydisplayformatconfiguration.html#cfn-quicksight-dashboard-currencydisplayformatconfiguration-numberscale

prefix

Determines the prefix value of the currency format.

See:

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

separator_configuration

The options that determine the numeric separator configuration.

See:

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

suffix

Determines the suffix value of the currency format.

See:

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

symbol

Determines the symbol for the currency format.

See:

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

CustomActionFilterOperationProperty

class CfnDashboard.CustomActionFilterOperationProperty(*, selected_fields_configuration, target_visuals_configuration)

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

custom_action_filter_operation_property = quicksight.CfnDashboard.CustomActionFilterOperationProperty(
    selected_fields_configuration=quicksight.CfnDashboard.FilterOperationSelectedFieldsConfigurationProperty(
        selected_columns=[quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )],
        selected_field_options="selectedFieldOptions",
        selected_fields=["selectedFields"]
    ),
    target_visuals_configuration=quicksight.CfnDashboard.FilterOperationTargetVisualsConfigurationProperty(
        same_sheet_target_visual_configuration=quicksight.CfnDashboard.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-dashboard-customactionfilteroperation.html#cfn-quicksight-dashboard-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-dashboard-customactionfilteroperation.html#cfn-quicksight-dashboard-customactionfilteroperation-targetvisualsconfiguration

CustomActionNavigationOperationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

custom_action_navigation_operation_property = quicksight.CfnDashboard.CustomActionNavigationOperationProperty(
    local_navigation_configuration=quicksight.CfnDashboard.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-dashboard-customactionnavigationoperation.html#cfn-quicksight-dashboard-customactionnavigationoperation-localnavigationconfiguration

CustomActionSetParametersOperationProperty

class CfnDashboard.CustomActionSetParametersOperationProperty(*, parameter_value_configurations)

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]]]]) – The parameter that determines the value configuration.

See:

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

custom_action_set_parameters_operation_property = quicksight.CfnDashboard.CustomActionSetParametersOperationProperty(
    parameter_value_configurations=[quicksight.CfnDashboard.SetParameterValueConfigurationProperty(
        destination_parameter_name="destinationParameterName",
        value=quicksight.CfnDashboard.DestinationParameterValueConfigurationProperty(
            custom_values_configuration=quicksight.CfnDashboard.CustomValuesConfigurationProperty(
                custom_values=quicksight.CfnDashboard.CustomParameterValuesProperty(
                    date_time_values=["dateTimeValues"],
                    decimal_values=[123],
                    integer_values=[123],
                    string_values=["stringValues"]
                ),

                # the properties below are optional
                include_null_value=False
            ),
            select_all_value_options="selectAllValueOptions",
            source_column=quicksight.CfnDashboard.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-dashboard-customactionsetparametersoperation.html#cfn-quicksight-dashboard-customactionsetparametersoperation-parametervalueconfigurations

CustomActionURLOperationProperty

class CfnDashboard.CustomActionURLOperationProperty(*, url_target, url_template)

Bases: object

The URL operation that opens a link to another webpage.

Parameters:

  • url_target (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 (str) – THe URL link of the CustomActionURLOperation .

See:

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

custom_action_uRLOperation_property = quicksight.CfnDashboard.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-dashboard-customactionurloperation.html#cfn-quicksight-dashboard-customactionurloperation-urltarget

url_template

THe URL link of the CustomActionURLOperation .

See:

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

CustomColorProperty

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

Bases: object

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

Parameters:

  • color (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-dashboard-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 import aws_quicksight as quicksight

custom_color_property = quicksight.CfnDashboard.CustomColorProperty(
    color="color",

    # the properties below are optional
    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-dashboard-customcolor.html#cfn-quicksight-dashboard-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-dashboard-customcolor.html#cfn-quicksight-dashboard-customcolor-fieldvalue

special_value

The value of a special data value.

See:

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

CustomContentConfigurationProperty

class CfnDashboard.CustomContentConfigurationProperty(*, content_type=None, content_url=None, image_scaling=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' .

See:

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

custom_content_configuration_property = quicksight.CfnDashboard.CustomContentConfigurationProperty(
    content_type="contentType",
    content_url="contentUrl",
    image_scaling="imageScaling"
)

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-dashboard-customcontentconfiguration.html#cfn-quicksight-dashboard-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-dashboard-customcontentconfiguration.html#cfn-quicksight-dashboard-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-dashboard-customcontentconfiguration.html#cfn-quicksight-dashboard-customcontentconfiguration-imagescaling

CustomContentVisualProperty

class CfnDashboard.CustomContentVisualProperty(*, data_set_identifier, visual_id, actions=None, chart_configuration=None, subtitle=None, title=None)

Bases: object

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide .

Parameters:

  • data_set_identifier (str) – The dataset that is used to create the custom content visual. You can’t create a visual without a dataset.

  • visual_id (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.

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

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

See:

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

custom_content_visual_property = quicksight.CfnDashboard.CustomContentVisualProperty(
    data_set_identifier="dataSetIdentifier",
    visual_id="visualId",

    # the properties below are optional
    actions=[quicksight.CfnDashboard.VisualCustomActionProperty(
        action_operations=[quicksight.CfnDashboard.VisualCustomActionOperationProperty(
            filter_operation=quicksight.CfnDashboard.CustomActionFilterOperationProperty(
                selected_fields_configuration=quicksight.CfnDashboard.FilterOperationSelectedFieldsConfigurationProperty(
                    selected_columns=[quicksight.CfnDashboard.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    )],
                    selected_field_options="selectedFieldOptions",
                    selected_fields=["selectedFields"]
                ),
                target_visuals_configuration=quicksight.CfnDashboard.FilterOperationTargetVisualsConfigurationProperty(
                    same_sheet_target_visual_configuration=quicksight.CfnDashboard.SameSheetTargetVisualConfigurationProperty(
                        target_visual_options="targetVisualOptions",
                        target_visuals=["targetVisuals"]
                    )
                )
            ),
            navigation_operation=quicksight.CfnDashboard.CustomActionNavigationOperationProperty(
                local_navigation_configuration=quicksight.CfnDashboard.LocalNavigationConfigurationProperty(
                    target_sheet_id="targetSheetId"
                )
            ),
            set_parameters_operation=quicksight.CfnDashboard.CustomActionSetParametersOperationProperty(
                parameter_value_configurations=[quicksight.CfnDashboard.SetParameterValueConfigurationProperty(
                    destination_parameter_name="destinationParameterName",
                    value=quicksight.CfnDashboard.DestinationParameterValueConfigurationProperty(
                        custom_values_configuration=quicksight.CfnDashboard.CustomValuesConfigurationProperty(
                            custom_values=quicksight.CfnDashboard.CustomParameterValuesProperty(
                                date_time_values=["dateTimeValues"],
                                decimal_values=[123],
                                integer_values=[123],
                                string_values=["stringValues"]
                            ),

                            # the properties below are optional
                            include_null_value=False
                        ),
                        select_all_value_options="selectAllValueOptions",
                        source_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                            column_name="columnName",
                            data_set_identifier="dataSetIdentifier"
                        ),
                        source_field="sourceField",
                        source_parameter_name="sourceParameterName"
                    )
                )]
            ),
            url_operation=quicksight.CfnDashboard.CustomActionURLOperationProperty(
                url_target="urlTarget",
                url_template="urlTemplate"
            )
        )],
        custom_action_id="customActionId",
        name="name",
        trigger="trigger",

        # the properties below are optional
        status="status"
    )],
    chart_configuration=quicksight.CfnDashboard.CustomContentConfigurationProperty(
        content_type="contentType",
        content_url="contentUrl",
        image_scaling="imageScaling"
    ),
    subtitle=quicksight.CfnDashboard.VisualSubtitleLabelOptionsProperty(
        format_text=quicksight.CfnDashboard.LongFormatTextProperty(
            plain_text="plainText",
            rich_text="richText"
        ),
        visibility="visibility"
    ),
    title=quicksight.CfnDashboard.VisualTitleLabelOptionsProperty(
        format_text=quicksight.CfnDashboard.ShortFormatTextProperty(
            plain_text="plainText",
            rich_text="richText"
        ),
        visibility="visibility"
    )
)

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-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-actions

chart_configuration

The configuration of a CustomContentVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-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-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-datasetidentifier

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-customcontentvisual.html#cfn-quicksight-dashboard-customcontentvisual-visualid

CustomFilterConfigurationProperty

class CfnDashboard.CustomFilterConfigurationProperty(*, match_operator, null_option, category_value=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:

  • match_operator (str) – The match operator that is used to determine if a filter should be applied.

  • null_option (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.

  • category_value (Optional[str]) – The category value for the filter. This field is mutually exclusive to ParameterName .

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

custom_filter_configuration_property = quicksight.CfnDashboard.CustomFilterConfigurationProperty(
    match_operator="matchOperator",
    null_option="nullOption",

    # the properties below are optional
    category_value="categoryValue",
    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-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-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-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-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-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-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-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-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-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-selectalloptions

CustomFilterListConfigurationProperty

class CfnDashboard.CustomFilterListConfigurationProperty(*, match_operator, null_option, category_values=None, select_all_options=None)

Bases: object

A list of custom filter values.

Parameters:

  • match_operator (str) – The match operator that is used to determine if a filter should be applied.

  • null_option (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.

  • category_values (Optional[Sequence[str]]) – The list of category values for the filter.

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

custom_filter_list_configuration_property = quicksight.CfnDashboard.CustomFilterListConfigurationProperty(
    match_operator="matchOperator",
    null_option="nullOption",

    # the properties below are optional
    category_values=["categoryValues"],
    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-dashboard-customfilterlistconfiguration.html#cfn-quicksight-dashboard-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-dashboard-customfilterlistconfiguration.html#cfn-quicksight-dashboard-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-dashboard-customfilterlistconfiguration.html#cfn-quicksight-dashboard-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-dashboard-customfilterlistconfiguration.html#cfn-quicksight-dashboard-customfilterlistconfiguration-selectalloptions

CustomNarrativeOptionsProperty

class CfnDashboard.CustomNarrativeOptionsProperty(*, narrative)

Bases: object

The custom narrative options.

Parameters:

narrative (str) – The string input of custom narrative.

See:

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

custom_narrative_options_property = quicksight.CfnDashboard.CustomNarrativeOptionsProperty(
    narrative="narrative"
)

Attributes

narrative

The string input of custom narrative.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customnarrativeoptions.html#cfn-quicksight-dashboard-customnarrativeoptions-narrative

CustomParameterValuesProperty

class CfnDashboard.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[IResolvable, Sequence[Union[int, float]], None]) – A list of decimal-type parameter values.

  • integer_values (Union[IResolvable, Sequence[Union[int, float]], 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-dashboard-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 import aws_quicksight as quicksight

custom_parameter_values_property = quicksight.CfnDashboard.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-dashboard-customparametervalues.html#cfn-quicksight-dashboard-customparametervalues-datetimevalues

decimal_values

A list of decimal-type parameter values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customparametervalues.html#cfn-quicksight-dashboard-customparametervalues-decimalvalues

integer_values

A list of integer-type parameter values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customparametervalues.html#cfn-quicksight-dashboard-customparametervalues-integervalues

string_values

A list of string-type parameter values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customparametervalues.html#cfn-quicksight-dashboard-customparametervalues-stringvalues

CustomValuesConfigurationProperty

class CfnDashboard.CustomValuesConfigurationProperty(*, custom_values, 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-dashboard-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 import aws_quicksight as quicksight

custom_values_configuration_property = quicksight.CfnDashboard.CustomValuesConfigurationProperty(
    custom_values=quicksight.CfnDashboard.CustomParameterValuesProperty(
        date_time_values=["dateTimeValues"],
        decimal_values=[123],
        integer_values=[123],
        string_values=["stringValues"]
    ),

    # the properties below are optional
    include_null_value=False
)

Attributes

custom_values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customvaluesconfiguration.html#cfn-quicksight-dashboard-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-dashboard-customvaluesconfiguration.html#cfn-quicksight-dashboard-customvaluesconfiguration-includenullvalue

DashboardErrorProperty

class CfnDashboard.DashboardErrorProperty(*, message=None, type=None, violated_entities=None)

Bases: object

Dashboard error.

Parameters:

  • message (Optional[str]) – Message.

  • type (Optional[str]) – Type.

  • violated_entities (Union[IResolvable, Sequence[Union[IResolvable, EntityProperty, Dict[str, Any]]], None]) – Lists the violated entities that caused the dashboard error.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboarderror.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

dashboard_error_property = quicksight.CfnDashboard.DashboardErrorProperty(
    message="message",
    type="type",
    violated_entities=[quicksight.CfnDashboard.EntityProperty(
        path="path"
    )]
)

Attributes

message

Message.

See:

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

type

Type.

See:

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

violated_entities

Lists the violated entities that caused the dashboard error.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboarderror.html#cfn-quicksight-dashboard-dashboarderror-violatedentities

DashboardPublishOptionsProperty

class CfnDashboard.DashboardPublishOptionsProperty(*, ad_hoc_filtering_option=None, data_point_drill_up_down_option=None, data_point_menu_label_option=None, data_point_tooltip_option=None, export_to_csv_option=None, export_with_hidden_fields_option=None, sheet_controls_option=None, sheet_layout_element_maximization_option=None, visual_axis_sort_option=None, visual_menu_option=None, visual_publish_options=None)

Bases: object

Dashboard publish options.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

dashboard_publish_options_property = quicksight.CfnDashboard.DashboardPublishOptionsProperty(
    ad_hoc_filtering_option=quicksight.CfnDashboard.AdHocFilteringOptionProperty(
        availability_status="availabilityStatus"
    ),
    data_point_drill_up_down_option=quicksight.CfnDashboard.DataPointDrillUpDownOptionProperty(
        availability_status="availabilityStatus"
    ),
    data_point_menu_label_option=quicksight.CfnDashboard.DataPointMenuLabelOptionProperty(
        availability_status="availabilityStatus"
    ),
    data_point_tooltip_option=quicksight.CfnDashboard.DataPointTooltipOptionProperty(
        availability_status="availabilityStatus"
    ),
    export_to_csv_option=quicksight.CfnDashboard.ExportToCSVOptionProperty(
        availability_status="availabilityStatus"
    ),
    export_with_hidden_fields_option=quicksight.CfnDashboard.ExportWithHiddenFieldsOptionProperty(
        availability_status="availabilityStatus"
    ),
    sheet_controls_option=quicksight.CfnDashboard.SheetControlsOptionProperty(
        visibility_state="visibilityState"
    ),
    sheet_layout_element_maximization_option=quicksight.CfnDashboard.SheetLayoutElementMaximizationOptionProperty(
        availability_status="availabilityStatus"
    ),
    visual_axis_sort_option=quicksight.CfnDashboard.VisualAxisSortOptionProperty(
        availability_status="availabilityStatus"
    ),
    visual_menu_option=quicksight.CfnDashboard.VisualMenuOptionProperty(
        availability_status="availabilityStatus"
    ),
    visual_publish_options=quicksight.CfnDashboard.DashboardVisualPublishOptionsProperty(
        export_hidden_fields_option=quicksight.CfnDashboard.ExportHiddenFieldsOptionProperty(
            availability_status="availabilityStatus"
        )
    )
)

Attributes

ad_hoc_filtering_option

Ad hoc (one-time) filtering option.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-adhocfilteringoption

data_point_drill_up_down_option

The drill-down options of data points in a dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-datapointdrillupdownoption

data_point_menu_label_option

The data point menu label options of a dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-datapointmenulabeloption

data_point_tooltip_option

The data point tool tip options of a dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-datapointtooltipoption

export_to_csv_option

Export to .csv option.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-exporttocsvoption

export_with_hidden_fields_option

Determines if hidden fields are exported with a dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-exportwithhiddenfieldsoption

sheet_controls_option

Sheet controls option.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-sheetcontrolsoption

sheet_layout_element_maximization_option

The sheet layout maximization options of a dashbaord.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-sheetlayoutelementmaximizationoption

visual_axis_sort_option

The axis sort options of a dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-visualaxissortoption

visual_menu_option

The menu options of a visual in a dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-visualmenuoption

visual_publish_options

The visual publish options of a visual in a dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-visualpublishoptions

DashboardSourceEntityProperty

class CfnDashboard.DashboardSourceEntityProperty(*, source_template=None)

Bases: object

Dashboard source entity.

Parameters:

source_template (Union[IResolvable, DashboardSourceTemplateProperty, Dict[str, Any], None]) – Source template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardsourceentity.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

dashboard_source_entity_property = quicksight.CfnDashboard.DashboardSourceEntityProperty(
    source_template=quicksight.CfnDashboard.DashboardSourceTemplateProperty(
        arn="arn",
        data_set_references=[quicksight.CfnDashboard.DataSetReferenceProperty(
            data_set_arn="dataSetArn",
            data_set_placeholder="dataSetPlaceholder"
        )]
    )
)

Attributes

source_template

Source template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardsourceentity.html#cfn-quicksight-dashboard-dashboardsourceentity-sourcetemplate

DashboardSourceTemplateProperty

class CfnDashboard.DashboardSourceTemplateProperty(*, arn, data_set_references)

Bases: object

Dashboard source template.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardsourcetemplate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

dashboard_source_template_property = quicksight.CfnDashboard.DashboardSourceTemplateProperty(
    arn="arn",
    data_set_references=[quicksight.CfnDashboard.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-dashboard-dashboardsourcetemplate.html#cfn-quicksight-dashboard-dashboardsourcetemplate-arn

data_set_references

Dataset references.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardsourcetemplate.html#cfn-quicksight-dashboard-dashboardsourcetemplate-datasetreferences

DashboardVersionDefinitionProperty

class CfnDashboard.DashboardVersionDefinitionProperty(*, data_set_identifier_declarations, analysis_defaults=None, calculated_fields=None, column_configurations=None, filter_groups=None, options=None, parameter_declarations=None, sheets=None)

Bases: object

The contents of a dashboard.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
analysis_defaults

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

Type:

see

calculated_fields

An array of calculated field definitions for the dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-calculatedfields

column_configurations

An array of dashboard-level column configurations.

Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-columnconfigurations

data_set_identifier_declarations

An array of dataset identifier declarations.

With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard’s sub-structures.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-datasetidentifierdeclarations

filter_groups

The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-filtergroups

options

An array of option definitions for a dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-options

parameter_declarations

The parameter declarations for a dashboard.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-parameterdeclarations

sheets

An array of sheet definitions for a dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-sheets

DashboardVersionProperty

class CfnDashboard.DashboardVersionProperty(*, arn=None, created_time=None, data_set_arns=None, description=None, errors=None, sheets=None, source_entity_arn=None, status=None, theme_arn=None, version_number=None)

Bases: object

Dashboard version.

Parameters:

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

  • created_time (Optional[str]) – The time that this dashboard version was created.

  • data_set_arns (Optional[Sequence[str]]) – The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.

  • description (Optional[str]) – Description.

  • errors (Union[IResolvable, Sequence[Union[IResolvable, DashboardErrorProperty, Dict[str, Any]]], None]) – Errors associated with this dashboard 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]) – Source entity ARN.

  • status (Optional[str]) – The HTTP status of the request.

  • theme_arn (Optional[str]) – The ARN of the theme associated with a version of the dashboard.

  • version_number (Union[int, float, None]) – Version number for this version of the dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

dashboard_version_property = quicksight.CfnDashboard.DashboardVersionProperty(
    arn="arn",
    created_time="createdTime",
    data_set_arns=["dataSetArns"],
    description="description",
    errors=[quicksight.CfnDashboard.DashboardErrorProperty(
        message="message",
        type="type",
        violated_entities=[quicksight.CfnDashboard.EntityProperty(
            path="path"
        )]
    )],
    sheets=[quicksight.CfnDashboard.SheetProperty(
        name="name",
        sheet_id="sheetId"
    )],
    source_entity_arn="sourceEntityArn",
    status="status",
    theme_arn="themeArn",
    version_number=123
)

Attributes

arn

The Amazon Resource Name (ARN) of the resource.

See:

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

created_time

The time that this dashboard version was created.

See:

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

data_set_arns

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-datasetarns

description

Description.

See:

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

errors

Errors associated with this dashboard version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-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-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-sheets

source_entity_arn

Source entity ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-sourceentityarn

status

The HTTP status of the request.

See:

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

theme_arn

The ARN of the theme associated with a version of the dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversion.html#cfn-quicksight-dashboard-dashboardversion-themearn

version_number

Version number for this version of the dashboard.

See:

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

DashboardVisualPublishOptionsProperty

class CfnDashboard.DashboardVisualPublishOptionsProperty(*, export_hidden_fields_option=None)

Bases: object

The visual publish options of a visual in a dashboard.

Parameters:

export_hidden_fields_option (Union[IResolvable, ExportHiddenFieldsOptionProperty, Dict[str, Any], None]) – Determines if hidden fields are included in an exported dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardvisualpublishoptions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

dashboard_visual_publish_options_property = quicksight.CfnDashboard.DashboardVisualPublishOptionsProperty(
    export_hidden_fields_option=quicksight.CfnDashboard.ExportHiddenFieldsOptionProperty(
        availability_status="availabilityStatus"
    )
)

Attributes

export_hidden_fields_option

Determines if hidden fields are included in an exported dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardvisualpublishoptions.html#cfn-quicksight-dashboard-dashboardvisualpublishoptions-exporthiddenfieldsoption

DataBarsOptionsProperty

class CfnDashboard.DataBarsOptionsProperty(*, field_id, negative_color=None, positive_color=None)

Bases: object

The options for data bars.

Parameters:

  • field_id (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-dashboard-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 import aws_quicksight as quicksight

data_bars_options_property = quicksight.CfnDashboard.DataBarsOptionsProperty(
    field_id="fieldId",

    # the properties below are optional
    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-dashboard-databarsoptions.html#cfn-quicksight-dashboard-databarsoptions-fieldid

negative_color

The color of the negative data bar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-databarsoptions.html#cfn-quicksight-dashboard-databarsoptions-negativecolor

positive_color

The color of the positive data bar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-databarsoptions.html#cfn-quicksight-dashboard-databarsoptions-positivecolor

DataColorProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

data_color_property = quicksight.CfnDashboard.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-dashboard-datacolor.html#cfn-quicksight-dashboard-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-dashboard-datacolor.html#cfn-quicksight-dashboard-datacolor-datavalue

DataFieldSeriesItemProperty

class CfnDashboard.DataFieldSeriesItemProperty(*, axis_binding, field_id, field_value=None, settings=None)

Bases: object

The data field series item configuration of a line chart.

Parameters:

  • axis_binding (str) – The axis that you are binding the field to.

  • field_id (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-dashboard-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 import aws_quicksight as quicksight

data_field_series_item_property = quicksight.CfnDashboard.DataFieldSeriesItemProperty(
    axis_binding="axisBinding",
    field_id="fieldId",

    # the properties below are optional
    field_value="fieldValue",
    settings=quicksight.CfnDashboard.LineChartSeriesSettingsProperty(
        line_style_settings=quicksight.CfnDashboard.LineChartLineStyleSettingsProperty(
            line_interpolation="lineInterpolation",
            line_style="lineStyle",
            line_visibility="lineVisibility",
            line_width="lineWidth"
        ),
        marker_style_settings=quicksight.CfnDashboard.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-dashboard-datafieldseriesitem.html#cfn-quicksight-dashboard-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-dashboard-datafieldseriesitem.html#cfn-quicksight-dashboard-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-dashboard-datafieldseriesitem.html#cfn-quicksight-dashboard-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-dashboard-datafieldseriesitem.html#cfn-quicksight-dashboard-datafieldseriesitem-settings

DataLabelOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

data_label_options_property = quicksight.CfnDashboard.DataLabelOptionsProperty(
    category_label_visibility="categoryLabelVisibility",
    data_label_types=[quicksight.CfnDashboard.DataLabelTypeProperty(
        data_path_label_type=quicksight.CfnDashboard.DataPathLabelTypeProperty(
            field_id="fieldId",
            field_value="fieldValue",
            visibility="visibility"
        ),
        field_label_type=quicksight.CfnDashboard.FieldLabelTypeProperty(
            field_id="fieldId",
            visibility="visibility"
        ),
        maximum_label_type=quicksight.CfnDashboard.MaximumLabelTypeProperty(
            visibility="visibility"
        ),
        minimum_label_type=quicksight.CfnDashboard.MinimumLabelTypeProperty(
            visibility="visibility"
        ),
        range_ends_label_type=quicksight.CfnDashboard.RangeEndsLabelTypeProperty(
            visibility="visibility"
        )
    )],
    label_color="labelColor",
    label_content="labelContent",
    label_font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.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-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-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-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-datalabeltypes

label_color

Determines the color of the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-labelcolor

label_content

Determines the content of the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-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-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-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-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-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-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-overlap

position

Determines the position of the data labels.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-position

totals_visibility

Determines the visibility of the total.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datalabeloptions.html#cfn-quicksight-dashboard-datalabeloptions-totalsvisibility

visibility

Determines the visibility of the data labels.

See:

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

DataLabelTypeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

data_label_type_property = quicksight.CfnDashboard.DataLabelTypeProperty(
    data_path_label_type=quicksight.CfnDashboard.DataPathLabelTypeProperty(
        field_id="fieldId",
        field_value="fieldValue",
        visibility="visibility"
    ),
    field_label_type=quicksight.CfnDashboard.FieldLabelTypeProperty(
        field_id="fieldId",
        visibility="visibility"
    ),
    maximum_label_type=quicksight.CfnDashboard.MaximumLabelTypeProperty(
        visibility="visibility"
    ),
    minimum_label_type=quicksight.CfnDashboard.MinimumLabelTypeProperty(
        visibility="visibility"
    ),
    range_ends_label_type=quicksight.CfnDashboard.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-dashboard-datalabeltype.html#cfn-quicksight-dashboard-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-dashboard-datalabeltype.html#cfn-quicksight-dashboard-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-dashboard-datalabeltype.html#cfn-quicksight-dashboard-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-dashboard-datalabeltype.html#cfn-quicksight-dashboard-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-dashboard-datalabeltype.html#cfn-quicksight-dashboard-datalabeltype-rangeendslabeltype

DataPathColorProperty

class CfnDashboard.DataPathColorProperty(*, color, element, time_granularity=None)

Bases: object

The color map that determines the color options for a particular element.

Parameters:

  • color (str) – The color that needs to be applied to the element.

  • element (Union[IResolvable, DataPathValueProperty, Dict[str, Any]]) – 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-dashboard-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 import aws_quicksight as quicksight

data_path_color_property = quicksight.CfnDashboard.DataPathColorProperty(
    color="color",
    element=quicksight.CfnDashboard.DataPathValueProperty(
        data_path_type=quicksight.CfnDashboard.DataPathTypeProperty(
            pivot_table_data_path_type="pivotTableDataPathType"
        ),
        field_id="fieldId",
        field_value="fieldValue"
    ),

    # the properties below are optional
    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-dashboard-datapathcolor.html#cfn-quicksight-dashboard-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-dashboard-datapathcolor.html#cfn-quicksight-dashboard-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-dashboard-datapathcolor.html#cfn-quicksight-dashboard-datapathcolor-timegranularity

DataPathLabelTypeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

data_path_label_type_property = quicksight.CfnDashboard.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-dashboard-datapathlabeltype.html#cfn-quicksight-dashboard-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-dashboard-datapathlabeltype.html#cfn-quicksight-dashboard-datapathlabeltype-fieldvalue

visibility

The visibility of the data label.

See:

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

DataPathSortProperty

class CfnDashboard.DataPathSortProperty(*, direction, sort_paths)

Bases: object

Allows data paths to be sorted by a specific data value.

Parameters:
See:

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

data_path_sort_property = quicksight.CfnDashboard.DataPathSortProperty(
    direction="direction",
    sort_paths=[quicksight.CfnDashboard.DataPathValueProperty(
        data_path_type=quicksight.CfnDashboard.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-dashboard-datapathsort.html#cfn-quicksight-dashboard-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-dashboard-datapathsort.html#cfn-quicksight-dashboard-datapathsort-sortpaths

DataPathTypeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

data_path_type_property = quicksight.CfnDashboard.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-dashboard-datapathtype.html#cfn-quicksight-dashboard-datapathtype-pivottabledatapathtype

Type:

The type of data path value utilized in a pivot table. Choose one of the following options

DataPathValueProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

data_path_value_property = quicksight.CfnDashboard.DataPathValueProperty(
    data_path_type=quicksight.CfnDashboard.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-dashboard-datapathvalue.html#cfn-quicksight-dashboard-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-dashboard-datapathvalue.html#cfn-quicksight-dashboard-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-dashboard-datapathvalue.html#cfn-quicksight-dashboard-datapathvalue-fieldvalue

DataPointDrillUpDownOptionProperty

class CfnDashboard.DataPointDrillUpDownOptionProperty(*, availability_status=None)

Bases: object

The drill down options for data points in a dashbaord.

Parameters:

availability_status (Optional[str]) – The status of the drill down options of data points.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapointdrillupdownoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

data_point_drill_up_down_option_property = quicksight.CfnDashboard.DataPointDrillUpDownOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

The status of the drill down options of data points.

See:

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

DataPointMenuLabelOptionProperty

class CfnDashboard.DataPointMenuLabelOptionProperty(*, availability_status=None)

Bases: object

The data point menu options of a dashboard.

Parameters:

availability_status (Optional[str]) – The status of the data point menu options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapointmenulabeloption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

data_point_menu_label_option_property = quicksight.CfnDashboard.DataPointMenuLabelOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

The status of the data point menu options.

See:

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

DataPointTooltipOptionProperty

class CfnDashboard.DataPointTooltipOptionProperty(*, availability_status=None)

Bases: object

The data point tooltip options.

Parameters:

availability_status (Optional[str]) – The status of the data point tool tip options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datapointtooltipoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

data_point_tooltip_option_property = quicksight.CfnDashboard.DataPointTooltipOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

The status of the data point tool tip options.

See:

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

DataSetIdentifierDeclarationProperty

class CfnDashboard.DataSetIdentifierDeclarationProperty(*, data_set_arn, identifier)

Bases: object

A data set.

Parameters:

  • data_set_arn (str) – The Amazon Resource Name (ARN) of the data set.

  • identifier (str) – The identifier of the data set, typically the data set’s name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetidentifierdeclaration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

data_set_identifier_declaration_property = quicksight.CfnDashboard.DataSetIdentifierDeclarationProperty(
    data_set_arn="dataSetArn",
    identifier="identifier"
)

Attributes

data_set_arn

The Amazon Resource Name (ARN) of the data set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetidentifierdeclaration.html#cfn-quicksight-dashboard-datasetidentifierdeclaration-datasetarn

identifier

The identifier of the data set, typically the data set’s name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetidentifierdeclaration.html#cfn-quicksight-dashboard-datasetidentifierdeclaration-identifier

DataSetReferenceProperty

class CfnDashboard.DataSetReferenceProperty(*, data_set_arn, data_set_placeholder)

Bases: object

Dataset reference.

Parameters:

  • data_set_arn (str) – Dataset Amazon Resource Name (ARN).

  • data_set_placeholder (str) – Dataset placeholder.

See:

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

data_set_reference_property = quicksight.CfnDashboard.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-dashboard-datasetreference.html#cfn-quicksight-dashboard-datasetreference-datasetarn

data_set_placeholder

Dataset placeholder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetreference.html#cfn-quicksight-dashboard-datasetreference-datasetplaceholder

DateAxisOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

date_axis_options_property = quicksight.CfnDashboard.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-dashboard-dateaxisoptions.html#cfn-quicksight-dashboard-dateaxisoptions-missingdatevisibility

DateDimensionFieldProperty

class CfnDashboard.DateDimensionFieldProperty(*, column, field_id, date_granularity=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]]) – The column that is used in the DateDimensionField .

  • field_id (str) – The custom field ID.

  • 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

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

date_dimension_field_property = quicksight.CfnDashboard.DateDimensionFieldProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",

    # the properties below are optional
    date_granularity="dateGranularity",
    format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
        date_time_format="dateTimeFormat",
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        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-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-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-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-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-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-fieldid

format_configuration

The format configuration of the field.

See:

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

hierarchy_id

The custom hierarchy ID.

See:

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

DateMeasureFieldProperty

class CfnDashboard.DateMeasureFieldProperty(*, column, field_id, aggregation_function=None, format_configuration=None)

Bases: object

The measure type field with date type columns.

Parameters:
See:

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

date_measure_field_property = quicksight.CfnDashboard.DateMeasureFieldProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",

    # the properties below are optional
    aggregation_function="aggregationFunction",
    format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
        date_time_format="dateTimeFormat",
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        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-dashboard-datemeasurefield.html#cfn-quicksight-dashboard-datemeasurefield-aggregationfunction

column

The column that is used in the DateMeasureField .

See:

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

field_id

The custom field ID.

See:

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

format_configuration

The format configuration of the field.

See:

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

DateTimeDefaultValuesProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

date_time_default_values_property = quicksight.CfnDashboard.DateTimeDefaultValuesProperty(
    dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
        default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),

        # the properties below are optional
        group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        user_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    ),
    rolling_date=quicksight.CfnDashboard.RollingDateConfigurationProperty(
        expression="expression",

        # the properties below are optional
        data_set_identifier="dataSetIdentifier"
    ),
    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-dashboard-datetimedefaultvalues.html#cfn-quicksight-dashboard-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-dashboard-datetimedefaultvalues.html#cfn-quicksight-dashboard-datetimedefaultvalues-rollingdate

static_values

The static values of the DataTimeDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimedefaultvalues.html#cfn-quicksight-dashboard-datetimedefaultvalues-staticvalues

DateTimeFormatConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

date_time_format_configuration_property = quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
    date_time_format="dateTimeFormat",
    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix",
            symbol="symbol"
        ),
        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    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-dashboard-datetimeformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-datetimeformatconfiguration.html#cfn-quicksight-dashboard-datetimeformatconfiguration-nullvalueformatconfiguration

numeric_format_configuration

The formatting configuration for numeric DateTime fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeformatconfiguration.html#cfn-quicksight-dashboard-datetimeformatconfiguration-numericformatconfiguration

DateTimeHierarchyProperty

class CfnDashboard.DateTimeHierarchyProperty(*, hierarchy_id, drill_down_filters=None)

Bases: object

The option that determines the hierarchy of any DateTime fields.

Parameters:

  • hierarchy_id (str) – The hierarchy ID of the DateTime hierarchy.

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

See:

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

date_time_hierarchy_property = quicksight.CfnDashboard.DateTimeHierarchyProperty(
    hierarchy_id="hierarchyId",

    # the properties below are optional
    drill_down_filters=[quicksight.CfnDashboard.DrillDownFilterProperty(
        category_filter=quicksight.CfnDashboard.CategoryDrillDownFilterProperty(
            category_values=["categoryValues"],
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        numeric_equality_filter=quicksight.CfnDashboard.NumericEqualityDrillDownFilterProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            value=123
        ),
        time_range_filter=quicksight.CfnDashboard.TimeRangeDrillDownFilterProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            range_maximum="rangeMaximum",
            range_minimum="rangeMinimum",
            time_granularity="timeGranularity"
        )
    )]
)

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-dashboard-datetimehierarchy.html#cfn-quicksight-dashboard-datetimehierarchy-drilldownfilters

hierarchy_id

The hierarchy ID of the DateTime hierarchy.

See:

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

DateTimeParameterDeclarationProperty

class CfnDashboard.DateTimeParameterDeclarationProperty(*, name, default_values=None, mapped_data_set_parameters=None, time_granularity=None, value_when_unset=None)

Bases: object

A parameter declaration for the DateTime data type.

Parameters:

  • name (str) – The name of the parameter that is being declared.

  • 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]) –

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

date_time_parameter_declaration_property = quicksight.CfnDashboard.DateTimeParameterDeclarationProperty(
    name="name",

    # the properties below are optional
    default_values=quicksight.CfnDashboard.DateTimeDefaultValuesProperty(
        dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
            default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            user_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        rolling_date=quicksight.CfnDashboard.RollingDateConfigurationProperty(
            expression="expression",

            # the properties below are optional
            data_set_identifier="dataSetIdentifier"
        ),
        static_values=["staticValues"]
    ),
    mapped_data_set_parameters=[quicksight.CfnDashboard.MappedDataSetParameterProperty(
        data_set_identifier="dataSetIdentifier",
        data_set_parameter_name="dataSetParameterName"
    )],
    time_granularity="timeGranularity",
    value_when_unset=quicksight.CfnDashboard.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-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-defaultvalues

mapped_data_set_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-datetimeparameterdeclaration.html#cfn-quicksight-dashboard-datetimeparameterdeclaration-valuewhenunset

DateTimeParameterProperty

class CfnDashboard.DateTimeParameterProperty(*, name, values)

Bases: object

A date-time parameter.

Parameters:

  • name (str) – A display name for the date-time parameter.

  • values (Sequence[str]) – The values for the date-time parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimeparameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

date_time_parameter_property = quicksight.CfnDashboard.DateTimeParameterProperty(
    name="name",
    values=["values"]
)

Attributes

name

A display name for the date-time parameter.

See:

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

values

The values for the date-time parameter.

See:

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

DateTimePickerControlDisplayOptionsProperty

class CfnDashboard.DateTimePickerControlDisplayOptionsProperty(*, 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-dashboard-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 import aws_quicksight as quicksight

date_time_picker_control_display_options_property = quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
    date_time_format="dateTimeFormat",
    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-datetimepickercontroldisplayoptions.html#cfn-quicksight-dashboard-datetimepickercontroldisplayoptions-datetimeformat

info_icon_label_options

The configuration of info icon label options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datetimepickercontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-datetimepickercontroldisplayoptions.html#cfn-quicksight-dashboard-datetimepickercontroldisplayoptions-titleoptions

DateTimeValueWhenUnsetConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

date_time_value_when_unset_configuration_property = quicksight.CfnDashboard.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-dashboard-datetimevaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-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-dashboard-datetimevaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-datetimevaluewhenunsetconfiguration-valuewhenunsetoption

Type:

The built-in options for default values. The value can be one of the following

DecimalDefaultValuesProperty

class CfnDashboard.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[IResolvable, Sequence[Union[int, float]], None]) – The static values of the DecimalDefaultValues .

See:

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

decimal_default_values_property = quicksight.CfnDashboard.DecimalDefaultValuesProperty(
    dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
        default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),

        # the properties below are optional
        group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        user_name_column=quicksight.CfnDashboard.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-dashboard-decimaldefaultvalues.html#cfn-quicksight-dashboard-decimaldefaultvalues-dynamicvalue

static_values

The static values of the DecimalDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimaldefaultvalues.html#cfn-quicksight-dashboard-decimaldefaultvalues-staticvalues

DecimalParameterDeclarationProperty

class CfnDashboard.DecimalParameterDeclarationProperty(*, name, parameter_value_type, default_values=None, mapped_data_set_parameters=None, value_when_unset=None)

Bases: object

A parameter declaration for the Decimal data type.

Parameters:

  • name (str) – The name of the parameter that is being declared.

  • parameter_value_type (str) – The value type determines whether the parameter is a single-value or multi-value parameter.

  • 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]) –

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

decimal_parameter_declaration_property = quicksight.CfnDashboard.DecimalParameterDeclarationProperty(
    name="name",
    parameter_value_type="parameterValueType",

    # the properties below are optional
    default_values=quicksight.CfnDashboard.DecimalDefaultValuesProperty(
        dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
            default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            user_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        static_values=[123]
    ),
    mapped_data_set_parameters=[quicksight.CfnDashboard.MappedDataSetParameterProperty(
        data_set_identifier="dataSetIdentifier",
        data_set_parameter_name="dataSetParameterName"
    )],
    value_when_unset=quicksight.CfnDashboard.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-dashboard-decimalparameterdeclaration.html#cfn-quicksight-dashboard-decimalparameterdeclaration-defaultvalues

mapped_data_set_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-decimalparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-decimalparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-decimalparameterdeclaration.html#cfn-quicksight-dashboard-decimalparameterdeclaration-valuewhenunset

DecimalParameterProperty

class CfnDashboard.DecimalParameterProperty(*, name, values)

Bases: object

A decimal parameter.

Parameters:

  • name (str) – A display name for the decimal parameter.

  • values (Union[IResolvable, Sequence[Union[int, float]]]) – The values for the decimal parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-decimalparameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

decimal_parameter_property = quicksight.CfnDashboard.DecimalParameterProperty(
    name="name",
    values=[123]
)

Attributes

name

A display name for the decimal parameter.

See:

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

values

The values for the decimal parameter.

See:

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

DecimalPlacesConfigurationProperty

class CfnDashboard.DecimalPlacesConfigurationProperty(*, decimal_places)

Bases: object

The option that determines the decimal places configuration.

Parameters:

decimal_places (Union[int, float]) – The values of the decimal places.

See:

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

decimal_places_configuration_property = quicksight.CfnDashboard.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-dashboard-decimalplacesconfiguration.html#cfn-quicksight-dashboard-decimalplacesconfiguration-decimalplaces

DecimalValueWhenUnsetConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

decimal_value_when_unset_configuration_property = quicksight.CfnDashboard.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-dashboard-decimalvaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-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-dashboard-decimalvaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-decimalvaluewhenunsetconfiguration-valuewhenunsetoption

Type:

The built-in options for default values. The value can be one of the following

DefaultDateTimePickerControlOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

default_date_time_picker_control_options_property = quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
    commit_mode="commitMode",
    display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
        date_time_format="dateTimeFormat",
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-defaultdatetimepickercontroloptions.html#cfn-quicksight-dashboard-defaultdatetimepickercontroloptions-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultdatetimepickercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultdatetimepickercontroloptions.html#cfn-quicksight-dashboard-defaultdatetimepickercontroloptions-type

Type:

The date time picker type of the DefaultDateTimePickerControlOptions . Choose one of the following options

DefaultFilterControlConfigurationProperty

class CfnDashboard.DefaultFilterControlConfigurationProperty(*, control_options, title)

Bases: object

The default configuration for all dependent controls of the filter.

Parameters:

  • control_options (Union[IResolvable, DefaultFilterControlOptionsProperty, Dict[str, Any]]) – The control option for the DefaultFilterControlConfiguration .

  • title (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-dashboard-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 import aws_quicksight as quicksight

default_filter_control_configuration_property = quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
    control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
        default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
            commit_mode="commitMode",
            display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                date_time_format="dateTimeFormat",
                info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_size=quicksight.CfnDashboard.FontSizeProperty(
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight.CfnDashboard.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            ),
            type="type"
        ),
        default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
            commit_mode="commitMode",
            display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                    visibility="visibility"
                ),
                title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_size=quicksight.CfnDashboard.FontSizeProperty(
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight.CfnDashboard.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            ),
            selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                values=["values"]
            ),
            type="type"
        ),
        default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
            display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                    visibility="visibility"
                ),
                select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                    visibility="visibility"
                ),
                title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_size=quicksight.CfnDashboard.FontSizeProperty(
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight.CfnDashboard.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            ),
            selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                values=["values"]
            ),
            type="type"
        ),
        default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
            commit_mode="commitMode",
            display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                date_time_format="dateTimeFormat",
                info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_size=quicksight.CfnDashboard.FontSizeProperty(
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight.CfnDashboard.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            )
        ),
        default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
            maximum_value=123,
            minimum_value=123,
            step_size=123,

            # the properties below are optional
            display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_size=quicksight.CfnDashboard.FontSizeProperty(
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight.CfnDashboard.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            ),
            type="type"
        ),
        default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
            delimiter="delimiter",
            display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                    visibility="visibility"
                ),
                title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_size=quicksight.CfnDashboard.FontSizeProperty(
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight.CfnDashboard.FontWeightProperty(
                            name="name"
                        )
                    ),
                    visibility="visibility"
                )
            )
        ),
        default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
            display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                    info_icon_text="infoIconText",
                    visibility="visibility"
                ),
                placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                    visibility="visibility"
                ),
                title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                    custom_label="customLabel",
                    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_size=quicksight.CfnDashboard.FontSizeProperty(
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight.CfnDashboard.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-dashboard-defaultfiltercontrolconfiguration.html#cfn-quicksight-dashboard-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-dashboard-defaultfiltercontrolconfiguration.html#cfn-quicksight-dashboard-defaultfiltercontrolconfiguration-title

DefaultFilterControlOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

default_filter_control_options_property = quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
    default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
        commit_mode="commitMode",
        display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
            date_time_format="dateTimeFormat",
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        type="type"
    ),
    default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
        commit_mode="commitMode",
        display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
            values=["values"]
        ),
        type="type"
    ),
    default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
        display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                visibility="visibility"
            ),
            select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
            values=["values"]
        ),
        type="type"
    ),
    default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
        commit_mode="commitMode",
        display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
            date_time_format="dateTimeFormat",
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    ),
    default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
        maximum_value=123,
        minimum_value=123,
        step_size=123,

        # the properties below are optional
        display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        type="type"
    ),
    default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
        delimiter="delimiter",
        display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    ),
    default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
        display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.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-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultfiltercontroloptions.html#cfn-quicksight-dashboard-defaultfiltercontroloptions-defaulttextfieldoptions

DefaultFilterDropDownControlOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

default_filter_drop_down_control_options_property = quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
    commit_mode="commitMode",
    display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    selectable_values=quicksight.CfnDashboard.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-dashboard-defaultfilterdropdowncontroloptions.html#cfn-quicksight-dashboard-defaultfilterdropdowncontroloptions-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultfilterdropdowncontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultfilterdropdowncontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultfilterdropdowncontroloptions.html#cfn-quicksight-dashboard-defaultfilterdropdowncontroloptions-type

Type:

The type of the FilterDropDownControl . Choose one of the following options

DefaultFilterListControlOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

default_filter_list_control_options_property = quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
    display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
            visibility="visibility"
        ),
        select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    selectable_values=quicksight.CfnDashboard.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-dashboard-defaultfilterlistcontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultfilterlistcontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultfilterlistcontroloptions.html#cfn-quicksight-dashboard-defaultfilterlistcontroloptions-type

Type:

The type of the DefaultFilterListControlOptions . Choose one of the following options

DefaultFreeFormLayoutConfigurationProperty

class CfnDashboard.DefaultFreeFormLayoutConfigurationProperty(*, canvas_size_options)

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]]) – Determines the screen canvas size options for a free-form layout.

See:

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

default_free_form_layout_configuration_property = quicksight.CfnDashboard.DefaultFreeFormLayoutConfigurationProperty(
    canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutCanvasSizeOptionsProperty(
        screen_canvas_size_options=quicksight.CfnDashboard.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-dashboard-defaultfreeformlayoutconfiguration.html#cfn-quicksight-dashboard-defaultfreeformlayoutconfiguration-canvassizeoptions

DefaultGridLayoutConfigurationProperty

class CfnDashboard.DefaultGridLayoutConfigurationProperty(*, canvas_size_options)

Bases: object

The options that determine the default settings for a grid layout configuration.

Parameters:

canvas_size_options (Union[IResolvable, GridLayoutCanvasSizeOptionsProperty, Dict[str, Any]]) – Determines the screen canvas size options for a grid layout.

See:

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

default_grid_layout_configuration_property = quicksight.CfnDashboard.DefaultGridLayoutConfigurationProperty(
    canvas_size_options=quicksight.CfnDashboard.GridLayoutCanvasSizeOptionsProperty(
        screen_canvas_size_options=quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
            resize_option="resizeOption",

            # the properties below are optional
            optimized_view_port_width="optimizedViewPortWidth"
        )
    )
)

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-dashboard-defaultgridlayoutconfiguration.html#cfn-quicksight-dashboard-defaultgridlayoutconfiguration-canvassizeoptions

DefaultInteractiveLayoutConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

default_interactive_layout_configuration_property = quicksight.CfnDashboard.DefaultInteractiveLayoutConfigurationProperty(
    free_form=quicksight.CfnDashboard.DefaultFreeFormLayoutConfigurationProperty(
        canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutCanvasSizeOptionsProperty(
            screen_canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutScreenCanvasSizeOptionsProperty(
                optimized_view_port_width="optimizedViewPortWidth"
            )
        )
    ),
    grid=quicksight.CfnDashboard.DefaultGridLayoutConfigurationProperty(
        canvas_size_options=quicksight.CfnDashboard.GridLayoutCanvasSizeOptionsProperty(
            screen_canvas_size_options=quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
                resize_option="resizeOption",

                # the properties below are optional
                optimized_view_port_width="optimizedViewPortWidth"
            )
        )
    )
)

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-dashboard-defaultinteractivelayoutconfiguration.html#cfn-quicksight-dashboard-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-dashboard-defaultinteractivelayoutconfiguration.html#cfn-quicksight-dashboard-defaultinteractivelayoutconfiguration-grid

DefaultNewSheetConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

default_new_sheet_configuration_property = quicksight.CfnDashboard.DefaultNewSheetConfigurationProperty(
    interactive_layout_configuration=quicksight.CfnDashboard.DefaultInteractiveLayoutConfigurationProperty(
        free_form=quicksight.CfnDashboard.DefaultFreeFormLayoutConfigurationProperty(
            canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutCanvasSizeOptionsProperty(
                screen_canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutScreenCanvasSizeOptionsProperty(
                    optimized_view_port_width="optimizedViewPortWidth"
                )
            )
        ),
        grid=quicksight.CfnDashboard.DefaultGridLayoutConfigurationProperty(
            canvas_size_options=quicksight.CfnDashboard.GridLayoutCanvasSizeOptionsProperty(
                screen_canvas_size_options=quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
                    resize_option="resizeOption",

                    # the properties below are optional
                    optimized_view_port_width="optimizedViewPortWidth"
                )
            )
        )
    ),
    paginated_layout_configuration=quicksight.CfnDashboard.DefaultPaginatedLayoutConfigurationProperty(
        section_based=quicksight.CfnDashboard.DefaultSectionBasedLayoutConfigurationProperty(
            canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutCanvasSizeOptionsProperty(
                paper_canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
                    paper_margin=quicksight.CfnDashboard.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-dashboard-defaultnewsheetconfiguration.html#cfn-quicksight-dashboard-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-dashboard-defaultnewsheetconfiguration.html#cfn-quicksight-dashboard-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-dashboard-defaultnewsheetconfiguration.html#cfn-quicksight-dashboard-defaultnewsheetconfiguration-sheetcontenttype

DefaultPaginatedLayoutConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

default_paginated_layout_configuration_property = quicksight.CfnDashboard.DefaultPaginatedLayoutConfigurationProperty(
    section_based=quicksight.CfnDashboard.DefaultSectionBasedLayoutConfigurationProperty(
        canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutCanvasSizeOptionsProperty(
            paper_canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
                paper_margin=quicksight.CfnDashboard.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-dashboard-defaultpaginatedlayoutconfiguration.html#cfn-quicksight-dashboard-defaultpaginatedlayoutconfiguration-sectionbased

DefaultRelativeDateTimeControlOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

default_relative_date_time_control_options_property = quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
    commit_mode="commitMode",
    display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
        date_time_format="dateTimeFormat",
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-defaultrelativedatetimecontroloptions.html#cfn-quicksight-dashboard-defaultrelativedatetimecontroloptions-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultrelativedatetimecontroloptions.html#cfn-quicksight-dashboard-defaultrelativedatetimecontroloptions-displayoptions

DefaultSectionBasedLayoutConfigurationProperty

class CfnDashboard.DefaultSectionBasedLayoutConfigurationProperty(*, canvas_size_options)

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]]) – Determines the screen canvas size options for a section-based layout.

See:

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

default_section_based_layout_configuration_property = quicksight.CfnDashboard.DefaultSectionBasedLayoutConfigurationProperty(
    canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutCanvasSizeOptionsProperty(
        paper_canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
            paper_margin=quicksight.CfnDashboard.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-dashboard-defaultsectionbasedlayoutconfiguration.html#cfn-quicksight-dashboard-defaultsectionbasedlayoutconfiguration-canvassizeoptions

DefaultSliderControlOptionsProperty

class CfnDashboard.DefaultSliderControlOptionsProperty(*, maximum_value, minimum_value, step_size, display_options=None, type=None)

Bases: object

The default options that correspond to the Slider filter control type.

Parameters:

  • maximum_value (Union[int, float]) – The larger value that is displayed at the right of the slider. Default: - 0

  • minimum_value (Union[int, float]) – The smaller value that is displayed at the left of the slider. Default: - 0

  • step_size (Union[int, float]) – The number of increments that the slider bar is divided into. Default: - 0

  • display_options (Union[IResolvable, SliderControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

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

default_slider_control_options_property = quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
    maximum_value=123,
    minimum_value=123,
    step_size=123,

    # the properties below are optional
    display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    type="type"
)

Attributes

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaultslidercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultslidercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultslidercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultslidercontroloptions.html#cfn-quicksight-dashboard-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-dashboard-defaultslidercontroloptions.html#cfn-quicksight-dashboard-defaultslidercontroloptions-type

Type:

The type of the DefaultSliderControlOptions . Choose one of the following options

DefaultTextAreaControlOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

default_text_area_control_options_property = quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
    delimiter="delimiter",
    display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-defaulttextareacontroloptions.html#cfn-quicksight-dashboard-defaulttextareacontroloptions-delimiter

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-defaulttextareacontroloptions.html#cfn-quicksight-dashboard-defaulttextareacontroloptions-displayoptions

DefaultTextFieldControlOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

default_text_field_control_options_property = quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
    display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-defaulttextfieldcontroloptions.html#cfn-quicksight-dashboard-defaulttextfieldcontroloptions-displayoptions

DestinationParameterValueConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

destination_parameter_value_configuration_property = quicksight.CfnDashboard.DestinationParameterValueConfigurationProperty(
    custom_values_configuration=quicksight.CfnDashboard.CustomValuesConfigurationProperty(
        custom_values=quicksight.CfnDashboard.CustomParameterValuesProperty(
            date_time_values=["dateTimeValues"],
            decimal_values=[123],
            integer_values=[123],
            string_values=["stringValues"]
        ),

        # the properties below are optional
        include_null_value=False
    ),
    select_all_value_options="selectAllValueOptions",
    source_column=quicksight.CfnDashboard.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-dashboard-destinationparametervalueconfiguration.html#cfn-quicksight-dashboard-destinationparametervalueconfiguration-customvaluesconfiguration

select_all_value_options

The configuration that selects all options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-destinationparametervalueconfiguration.html#cfn-quicksight-dashboard-destinationparametervalueconfiguration-selectallvalueoptions

source_column

A column of a data set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-destinationparametervalueconfiguration.html#cfn-quicksight-dashboard-destinationparametervalueconfiguration-sourcecolumn

source_field

The source field ID of the destination parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-destinationparametervalueconfiguration.html#cfn-quicksight-dashboard-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-dashboard-destinationparametervalueconfiguration.html#cfn-quicksight-dashboard-destinationparametervalueconfiguration-sourceparametername

DimensionFieldProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

dimension_field_property = quicksight.CfnDashboard.DimensionFieldProperty(
    categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",

        # the properties below are optional
        format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        hierarchy_id="hierarchyId"
    ),
    date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",

        # the properties below are optional
        date_granularity="dateGranularity",
        format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
            date_time_format="dateTimeFormat",
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        hierarchy_id="hierarchyId"
    ),
    numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",

        # the properties below are optional
        format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
            format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            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-dashboard-dimensionfield.html#cfn-quicksight-dashboard-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-dashboard-dimensionfield.html#cfn-quicksight-dashboard-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-dashboard-dimensionfield.html#cfn-quicksight-dashboard-dimensionfield-numericaldimensionfield

DonutCenterOptionsProperty

class CfnDashboard.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 Amazon QuickSight console, this option is called 'Show total' .

See:

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

donut_center_options_property = quicksight.CfnDashboard.DonutCenterOptionsProperty(
    label_visibility="labelVisibility"
)

Attributes

label_visibility

Determines the visibility of the label in a donut chart.

In the Amazon QuickSight console, this option is called 'Show total' .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-donutcenteroptions.html#cfn-quicksight-dashboard-donutcenteroptions-labelvisibility

DonutOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

donut_options_property = quicksight.CfnDashboard.DonutOptionsProperty(
    arc_options=quicksight.CfnDashboard.ArcOptionsProperty(
        arc_thickness="arcThickness"
    ),
    donut_center_options=quicksight.CfnDashboard.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-dashboard-donutoptions.html#cfn-quicksight-dashboard-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-dashboard-donutoptions.html#cfn-quicksight-dashboard-donutoptions-donutcenteroptions

DrillDownFilterProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

drill_down_filter_property = quicksight.CfnDashboard.DrillDownFilterProperty(
    category_filter=quicksight.CfnDashboard.CategoryDrillDownFilterProperty(
        category_values=["categoryValues"],
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        )
    ),
    numeric_equality_filter=quicksight.CfnDashboard.NumericEqualityDrillDownFilterProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        value=123
    ),
    time_range_filter=quicksight.CfnDashboard.TimeRangeDrillDownFilterProperty(
        column=quicksight.CfnDashboard.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-dashboard-drilldownfilter.html#cfn-quicksight-dashboard-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-dashboard-drilldownfilter.html#cfn-quicksight-dashboard-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-dashboard-drilldownfilter.html#cfn-quicksight-dashboard-drilldownfilter-timerangefilter

DynamicDefaultValueProperty

class CfnDashboard.DynamicDefaultValueProperty(*, default_value_column, 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-dashboard-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 import aws_quicksight as quicksight

dynamic_default_value_property = quicksight.CfnDashboard.DynamicDefaultValueProperty(
    default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),

    # the properties below are optional
    group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    user_name_column=quicksight.CfnDashboard.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-dashboard-dynamicdefaultvalue.html#cfn-quicksight-dashboard-dynamicdefaultvalue-defaultvaluecolumn

group_name_column

The column that contains the group name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dynamicdefaultvalue.html#cfn-quicksight-dashboard-dynamicdefaultvalue-groupnamecolumn

user_name_column

The column that contains the username.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dynamicdefaultvalue.html#cfn-quicksight-dashboard-dynamicdefaultvalue-usernamecolumn

EmptyVisualProperty

class CfnDashboard.EmptyVisualProperty(*, data_set_identifier, visual_id, actions=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 Amazon QuickSight console is considered an EmptyVisual until a visual type is selected.

Parameters:

  • data_set_identifier (str) – The data set that is used in the empty visual. Every visual requires a dataset to render.

  • visual_id (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.

  • actions (Union[IResolvable, Sequence[Union[IResolvable, VisualCustomActionProperty, Dict[str, Any]]], None]) – The list of custom actions that are configured for a visual.

See:

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

empty_visual_property = quicksight.CfnDashboard.EmptyVisualProperty(
    data_set_identifier="dataSetIdentifier",
    visual_id="visualId",

    # the properties below are optional
    actions=[quicksight.CfnDashboard.VisualCustomActionProperty(
        action_operations=[quicksight.CfnDashboard.VisualCustomActionOperationProperty(
            filter_operation=quicksight.CfnDashboard.CustomActionFilterOperationProperty(
                selected_fields_configuration=quicksight.CfnDashboard.FilterOperationSelectedFieldsConfigurationProperty(
                    selected_columns=[quicksight.CfnDashboard.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    )],
                    selected_field_options="selectedFieldOptions",
                    selected_fields=["selectedFields"]
                ),
                target_visuals_configuration=quicksight.CfnDashboard.FilterOperationTargetVisualsConfigurationProperty(
                    same_sheet_target_visual_configuration=quicksight.CfnDashboard.SameSheetTargetVisualConfigurationProperty(
                        target_visual_options="targetVisualOptions",
                        target_visuals=["targetVisuals"]
                    )
                )
            ),
            navigation_operation=quicksight.CfnDashboard.CustomActionNavigationOperationProperty(
                local_navigation_configuration=quicksight.CfnDashboard.LocalNavigationConfigurationProperty(
                    target_sheet_id="targetSheetId"
                )
            ),
            set_parameters_operation=quicksight.CfnDashboard.CustomActionSetParametersOperationProperty(
                parameter_value_configurations=[quicksight.CfnDashboard.SetParameterValueConfigurationProperty(
                    destination_parameter_name="destinationParameterName",
                    value=quicksight.CfnDashboard.DestinationParameterValueConfigurationProperty(
                        custom_values_configuration=quicksight.CfnDashboard.CustomValuesConfigurationProperty(
                            custom_values=quicksight.CfnDashboard.CustomParameterValuesProperty(
                                date_time_values=["dateTimeValues"],
                                decimal_values=[123],
                                integer_values=[123],
                                string_values=["stringValues"]
                            ),

                            # the properties below are optional
                            include_null_value=False
                        ),
                        select_all_value_options="selectAllValueOptions",
                        source_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                            column_name="columnName",
                            data_set_identifier="dataSetIdentifier"
                        ),
                        source_field="sourceField",
                        source_parameter_name="sourceParameterName"
                    )
                )]
            ),
            url_operation=quicksight.CfnDashboard.CustomActionURLOperationProperty(
                url_target="urlTarget",
                url_template="urlTemplate"
            )
        )],
        custom_action_id="customActionId",
        name="name",
        trigger="trigger",

        # the properties below are optional
        status="status"
    )]
)

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-dashboard-emptyvisual.html#cfn-quicksight-dashboard-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-dashboard-emptyvisual.html#cfn-quicksight-dashboard-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-dashboard-emptyvisual.html#cfn-quicksight-dashboard-emptyvisual-visualid

EntityProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

entity_property = quicksight.CfnDashboard.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-dashboard-entity.html#cfn-quicksight-dashboard-entity-path

ExcludePeriodConfigurationProperty

class CfnDashboard.ExcludePeriodConfigurationProperty(*, amount, granularity, status=None)

Bases: object

The exclude period of TimeRangeFilter or RelativeDatesFilter .

Parameters:

  • amount (Union[int, float]) – The amount or number of the exclude period.

  • granularity (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-dashboard-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 import aws_quicksight as quicksight

exclude_period_configuration_property = quicksight.CfnDashboard.ExcludePeriodConfigurationProperty(
    amount=123,
    granularity="granularity",

    # the properties below are optional
    status="status"
)

Attributes

amount

The amount or number of the exclude period.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-excludeperiodconfiguration.html#cfn-quicksight-dashboard-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-dashboard-excludeperiodconfiguration.html#cfn-quicksight-dashboard-excludeperiodconfiguration-granularity

status

.

  • ENABLED

  • DISABLED

See:

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

Type:

The status of the exclude period. Choose from the following options

ExplicitHierarchyProperty

class CfnDashboard.ExplicitHierarchyProperty(*, columns, hierarchy_id, drill_down_filters=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-dashboard-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 import aws_quicksight as quicksight

explicit_hierarchy_property = quicksight.CfnDashboard.ExplicitHierarchyProperty(
    columns=[quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    )],
    hierarchy_id="hierarchyId",

    # the properties below are optional
    drill_down_filters=[quicksight.CfnDashboard.DrillDownFilterProperty(
        category_filter=quicksight.CfnDashboard.CategoryDrillDownFilterProperty(
            category_values=["categoryValues"],
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        numeric_equality_filter=quicksight.CfnDashboard.NumericEqualityDrillDownFilterProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            value=123
        ),
        time_range_filter=quicksight.CfnDashboard.TimeRangeDrillDownFilterProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            range_maximum="rangeMaximum",
            range_minimum="rangeMinimum",
            time_granularity="timeGranularity"
        )
    )]
)

Attributes

columns

The list of columns that define the explicit hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-explicithierarchy.html#cfn-quicksight-dashboard-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-dashboard-explicithierarchy.html#cfn-quicksight-dashboard-explicithierarchy-drilldownfilters

hierarchy_id

The hierarchy ID of the explicit hierarchy.

See:

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

ExportHiddenFieldsOptionProperty

class CfnDashboard.ExportHiddenFieldsOptionProperty(*, availability_status=None)

Bases: object

Determines if hidden fields are included in an exported dashboard.

Parameters:

availability_status (Optional[str]) – The status of the export hidden fields options of a dashbaord.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-exporthiddenfieldsoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

export_hidden_fields_option_property = quicksight.CfnDashboard.ExportHiddenFieldsOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

The status of the export hidden fields options of a dashbaord.

See:

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

ExportToCSVOptionProperty

class CfnDashboard.ExportToCSVOptionProperty(*, availability_status=None)

Bases: object

Export to .csv option.

Parameters:

availability_status (Optional[str]) – Availability status.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-exporttocsvoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

export_to_cSVOption_property = quicksight.CfnDashboard.ExportToCSVOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

Availability status.

See:

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

ExportWithHiddenFieldsOptionProperty

class CfnDashboard.ExportWithHiddenFieldsOptionProperty(*, availability_status=None)

Bases: object

Determines whether or not hidden fields are visible on exported dashbaords.

Parameters:

availability_status (Optional[str]) – The status of the export with hidden fields options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-exportwithhiddenfieldsoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

export_with_hidden_fields_option_property = quicksight.CfnDashboard.ExportWithHiddenFieldsOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

The status of the export with hidden fields options.

See:

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

FieldBasedTooltipProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

field_based_tooltip_property = quicksight.CfnDashboard.FieldBasedTooltipProperty(
    aggregation_visibility="aggregationVisibility",
    tooltip_fields=[quicksight.CfnDashboard.TooltipItemProperty(
        column_tooltip_item=quicksight.CfnDashboard.ColumnTooltipItemProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            ),
            label="label",
            tooltip_target="tooltipTarget",
            visibility="visibility"
        ),
        field_tooltip_item=quicksight.CfnDashboard.FieldTooltipItemProperty(
            field_id="fieldId",

            # the properties below are optional
            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-dashboard-fieldbasedtooltip.html#cfn-quicksight-dashboard-fieldbasedtooltip-aggregationvisibility

tooltip_fields

The fields configuration in the tooltip.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldbasedtooltip.html#cfn-quicksight-dashboard-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-dashboard-fieldbasedtooltip.html#cfn-quicksight-dashboard-fieldbasedtooltip-tooltiptitletype

Type:

The type for the >tooltip title. Choose one of the following options

FieldLabelTypeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

field_label_type_property = quicksight.CfnDashboard.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-dashboard-fieldlabeltype.html#cfn-quicksight-dashboard-fieldlabeltype-fieldid

visibility

The visibility of the field label.

See:

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

FieldSeriesItemProperty

class CfnDashboard.FieldSeriesItemProperty(*, axis_binding, field_id, settings=None)

Bases: object

The field series item configuration of a line chart.

Parameters:

  • axis_binding (str) – The axis that you are binding the field to.

  • field_id (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-dashboard-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 import aws_quicksight as quicksight

field_series_item_property = quicksight.CfnDashboard.FieldSeriesItemProperty(
    axis_binding="axisBinding",
    field_id="fieldId",

    # the properties below are optional
    settings=quicksight.CfnDashboard.LineChartSeriesSettingsProperty(
        line_style_settings=quicksight.CfnDashboard.LineChartLineStyleSettingsProperty(
            line_interpolation="lineInterpolation",
            line_style="lineStyle",
            line_visibility="lineVisibility",
            line_width="lineWidth"
        ),
        marker_style_settings=quicksight.CfnDashboard.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-dashboard-fieldseriesitem.html#cfn-quicksight-dashboard-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-dashboard-fieldseriesitem.html#cfn-quicksight-dashboard-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-dashboard-fieldseriesitem.html#cfn-quicksight-dashboard-fieldseriesitem-settings

FieldSortOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

field_sort_options_property = quicksight.CfnDashboard.FieldSortOptionsProperty(
    column_sort=quicksight.CfnDashboard.ColumnSortProperty(
        direction="direction",
        sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),

        # the properties below are optional
        aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        )
    ),
    field_sort=quicksight.CfnDashboard.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-dashboard-fieldsortoptions.html#cfn-quicksight-dashboard-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-dashboard-fieldsortoptions.html#cfn-quicksight-dashboard-fieldsortoptions-fieldsort

FieldSortProperty

class CfnDashboard.FieldSortProperty(*, direction, field_id)

Bases: object

The sort configuration for a field in a field well.

Parameters:

  • direction (str) – The sort direction. Choose one of the following options:. - ASC : Ascending - DESC : Descending

  • field_id (str) – The sort configuration target field.

See:

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

field_sort_property = quicksight.CfnDashboard.FieldSortProperty(
    direction="direction",
    field_id="fieldId"
)

Attributes

direction

.

  • ASC : Ascending

  • DESC : Descending

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldsort.html#cfn-quicksight-dashboard-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-dashboard-fieldsort.html#cfn-quicksight-dashboard-fieldsort-fieldid

FieldTooltipItemProperty

class CfnDashboard.FieldTooltipItemProperty(*, field_id, label=None, tooltip_target=None, visibility=None)

Bases: object

The tooltip item for the fields.

Parameters:

  • field_id (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-dashboard-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 import aws_quicksight as quicksight

field_tooltip_item_property = quicksight.CfnDashboard.FieldTooltipItemProperty(
    field_id="fieldId",

    # the properties below are optional
    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-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-fieldtooltipitem-fieldid

label

The label of the tooltip item.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-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-dashboard-fieldtooltipitem.html#cfn-quicksight-dashboard-fieldtooltipitem-tooltiptarget

visibility

The visibility of the tooltip item.

See:

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

FilledMapAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-filledmapaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

filled_map_aggregated_field_wells_property = quicksight.CfnDashboard.FilledMapAggregatedFieldWellsProperty(
    geospatial=[quicksight.CfnDashboard.DimensionFieldProperty(
        categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            date_granularity="dateGranularity",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    )],
    values=[quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        )
    )]
)

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-dashboard-filledmapaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-filledmapaggregatedfieldwells.html#cfn-quicksight-dashboard-filledmapaggregatedfieldwells-values

FilledMapConditionalFormattingOptionProperty

class CfnDashboard.FilledMapConditionalFormattingOptionProperty(*, shape)

Bases: object

Conditional formatting options of a FilledMapVisual .

Parameters:

shape (Union[IResolvable, FilledMapShapeConditionalFormattingProperty, Dict[str, Any]]) – The conditional formatting that determines the shape of the filled map.

See:

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

filled_map_conditional_formatting_option_property = quicksight.CfnDashboard.FilledMapConditionalFormattingOptionProperty(
    shape=quicksight.CfnDashboard.FilledMapShapeConditionalFormattingProperty(
        field_id="fieldId",

        # the properties below are optional
        format=quicksight.CfnDashboard.ShapeConditionalFormatProperty(
            background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            )
        )
    )
)

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-dashboard-filledmapconditionalformattingoption.html#cfn-quicksight-dashboard-filledmapconditionalformattingoption-shape

FilledMapConditionalFormattingProperty

class CfnDashboard.FilledMapConditionalFormattingProperty(*, conditional_formatting_options)

Bases: object

The conditional formatting of a FilledMapVisual .

Parameters:

conditional_formatting_options (Union[IResolvable, Sequence[Union[IResolvable, FilledMapConditionalFormattingOptionProperty, Dict[str, Any]]]]) – Conditional formatting options of a FilledMapVisual .

See:

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

filled_map_conditional_formatting_property = quicksight.CfnDashboard.FilledMapConditionalFormattingProperty(
    conditional_formatting_options=[quicksight.CfnDashboard.FilledMapConditionalFormattingOptionProperty(
        shape=quicksight.CfnDashboard.FilledMapShapeConditionalFormattingProperty(
            field_id="fieldId",

            # the properties below are optional
            format=quicksight.CfnDashboard.ShapeConditionalFormatProperty(
                background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                    gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                        color=quicksight.CfnDashboard.GradientColorProperty(
                            stops=[quicksight.CfnDashboard.GradientStopProperty(
                                gradient_offset=123,

                                # the properties below are optional
                                color="color",
                                data_value=123
                            )]
                        ),
                        expression="expression"
                    ),
                    solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                        expression="expression",

                        # the properties below are optional
                        color="color"
                    )
                )
            )
        )
    )]
)

Attributes

conditional_formatting_options

Conditional formatting options of a FilledMapVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconditionalformatting.html#cfn-quicksight-dashboard-filledmapconditionalformatting-conditionalformattingoptions

FilledMapConfigurationProperty

class CfnDashboard.FilledMapConfigurationProperty(*, field_wells=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-dashboard-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-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-filledmapconfiguration-fieldwells

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-filledmapconfiguration-mapstyleoptions

sort_configuration

The sort configuration of a FilledMapVisual .

See:

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

tooltip

The tooltip display setup of the visual.

See:

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

window_options

The window options of the filled map visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapconfiguration.html#cfn-quicksight-dashboard-filledmapconfiguration-windowoptions

FilledMapFieldWellsProperty

class CfnDashboard.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-dashboard-filledmapfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

filled_map_field_wells_property = quicksight.CfnDashboard.FilledMapFieldWellsProperty(
    filled_map_aggregated_field_wells=quicksight.CfnDashboard.FilledMapAggregatedFieldWellsProperty(
        geospatial=[quicksight.CfnDashboard.DimensionFieldProperty(
            categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            ),
            date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                date_granularity="dateGranularity",
                format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                    date_time_format="dateTimeFormat",
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            ),
            numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            )
        )],
        values=[quicksight.CfnDashboard.MeasureFieldProperty(
            calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
                expression="expression",
                field_id="fieldId"
            ),
            categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function="aggregationFunction",
                format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function="aggregationFunction",
                format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                    date_time_format="dateTimeFormat",
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                ),
                format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            )
        )]
    )
)

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-dashboard-filledmapfieldwells.html#cfn-quicksight-dashboard-filledmapfieldwells-filledmapaggregatedfieldwells

FilledMapShapeConditionalFormattingProperty

class CfnDashboard.FilledMapShapeConditionalFormattingProperty(*, field_id, format=None)

Bases: object

The conditional formatting that determines the shape of the filled map.

Parameters:

  • field_id (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-dashboard-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 import aws_quicksight as quicksight

filled_map_shape_conditional_formatting_property = quicksight.CfnDashboard.FilledMapShapeConditionalFormattingProperty(
    field_id="fieldId",

    # the properties below are optional
    format=quicksight.CfnDashboard.ShapeConditionalFormatProperty(
        background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        )
    )
)

Attributes

field_id

The field ID of the filled map shape.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapshapeconditionalformatting.html#cfn-quicksight-dashboard-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-dashboard-filledmapshapeconditionalformatting.html#cfn-quicksight-dashboard-filledmapshapeconditionalformatting-format

FilledMapSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

filled_map_sort_configuration_property = quicksight.CfnDashboard.FilledMapSortConfigurationProperty(
    category_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-filledmapsortconfiguration.html#cfn-quicksight-dashboard-filledmapsortconfiguration-categorysort

FilledMapVisualProperty

class CfnDashboard.FilledMapVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, conditional_formatting=None, subtitle=None, title=None)

Bases: object

A filled map.

For more information, see Creating filled maps in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-actions

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-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-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-columnhierarchies

conditional_formatting

The conditional formatting of a FilledMapVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-conditionalformatting

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-filledmapvisual.html#cfn-quicksight-dashboard-filledmapvisual-visualid

FilterControlProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

filter_control_property = quicksight.CfnDashboard.FilterControlProperty(
    cross_sheet=quicksight.CfnDashboard.FilterCrossSheetControlProperty(
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",

        # the properties below are optional
        cascading_control_configuration=quicksight.CfnDashboard.CascadingControlConfigurationProperty(
            source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
                column_to_match=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_sheet_control_id="sourceSheetControlId"
            )]
        )
    ),
    date_time_picker=quicksight.CfnDashboard.FilterDateTimePickerControlProperty(
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",
        title="title",

        # the properties below are optional
        commit_mode="commitMode",
        display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
            date_time_format="dateTimeFormat",
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        type="type"
    ),
    dropdown=quicksight.CfnDashboard.FilterDropDownControlProperty(
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",
        title="title",

        # the properties below are optional
        cascading_control_configuration=quicksight.CfnDashboard.CascadingControlConfigurationProperty(
            source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
                column_to_match=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_sheet_control_id="sourceSheetControlId"
            )]
        ),
        commit_mode="commitMode",
        display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
            values=["values"]
        ),
        type="type"
    ),
    list=quicksight.CfnDashboard.FilterListControlProperty(
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",
        title="title",

        # the properties below are optional
        cascading_control_configuration=quicksight.CfnDashboard.CascadingControlConfigurationProperty(
            source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
                column_to_match=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_sheet_control_id="sourceSheetControlId"
            )]
        ),
        display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                visibility="visibility"
            ),
            select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
            values=["values"]
        ),
        type="type"
    ),
    relative_date_time=quicksight.CfnDashboard.FilterRelativeDateTimeControlProperty(
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",
        title="title",

        # the properties below are optional
        commit_mode="commitMode",
        display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
            date_time_format="dateTimeFormat",
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    ),
    slider=quicksight.CfnDashboard.FilterSliderControlProperty(
        filter_control_id="filterControlId",
        maximum_value=123,
        minimum_value=123,
        source_filter_id="sourceFilterId",
        step_size=123,
        title="title",

        # the properties below are optional
        display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        type="type"
    ),
    text_area=quicksight.CfnDashboard.FilterTextAreaControlProperty(
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",
        title="title",

        # the properties below are optional
        delimiter="delimiter",
        display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    ),
    text_field=quicksight.CfnDashboard.FilterTextFieldControlProperty(
        filter_control_id="filterControlId",
        source_filter_id="sourceFilterId",
        title="title",

        # the properties below are optional
        display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    )
)

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-dashboard-filtercontrol.html#cfn-quicksight-dashboard-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-dashboard-filtercontrol.html#cfn-quicksight-dashboard-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-dashboard-filtercontrol.html#cfn-quicksight-dashboard-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-dashboard-filtercontrol.html#cfn-quicksight-dashboard-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-dashboard-filtercontrol.html#cfn-quicksight-dashboard-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-dashboard-filtercontrol.html#cfn-quicksight-dashboard-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-dashboard-filtercontrol.html#cfn-quicksight-dashboard-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-dashboard-filtercontrol.html#cfn-quicksight-dashboard-filtercontrol-textfield

FilterCrossSheetControlProperty

class CfnDashboard.FilterCrossSheetControlProperty(*, filter_control_id, source_filter_id, cascading_control_configuration=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:

  • filter_control_id (str) – The ID of the FilterCrossSheetControl .

  • source_filter_id (str) – The source filter ID of the FilterCrossSheetControl .

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

See:

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

filter_cross_sheet_control_property = quicksight.CfnDashboard.FilterCrossSheetControlProperty(
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",

    # the properties below are optional
    cascading_control_configuration=quicksight.CfnDashboard.CascadingControlConfigurationProperty(
        source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
            column_to_match=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_sheet_control_id="sourceSheetControlId"
        )]
    )
)

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-dashboard-filtercrosssheetcontrol.html#cfn-quicksight-dashboard-filtercrosssheetcontrol-cascadingcontrolconfiguration

filter_control_id

The ID of the FilterCrossSheetControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercrosssheetcontrol.html#cfn-quicksight-dashboard-filtercrosssheetcontrol-filtercontrolid

source_filter_id

The source filter ID of the FilterCrossSheetControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtercrosssheetcontrol.html#cfn-quicksight-dashboard-filtercrosssheetcontrol-sourcefilterid

FilterDateTimePickerControlProperty

class CfnDashboard.FilterDateTimePickerControlProperty(*, filter_control_id, source_filter_id, title, commit_mode=None, display_options=None, type=None)

Bases: object

A control from a date filter that is used to specify date and time.

Parameters:

  • filter_control_id (str) – The ID of the FilterDateTimePickerControl .

  • source_filter_id (str) – The source filter ID of the FilterDateTimePickerControl .

  • title (str) – The title of the FilterDateTimePickerControl .

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

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

filter_date_time_picker_control_property = quicksight.CfnDashboard.FilterDateTimePickerControlProperty(
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",
    title="title",

    # the properties below are optional
    commit_mode="commitMode",
    display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
        date_time_format="dateTimeFormat",
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    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-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-displayoptions

filter_control_id

The ID of the FilterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-filtercontrolid

source_filter_id

The source filter ID of the FilterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-sourcefilterid

title

The title of the FilterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-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-dashboard-filterdatetimepickercontrol.html#cfn-quicksight-dashboard-filterdatetimepickercontrol-type

Type:

The type of the FilterDropDownControl . Choose one of the following options

FilterDropDownControlProperty

class CfnDashboard.FilterDropDownControlProperty(*, filter_control_id, source_filter_id, title, cascading_control_configuration=None, commit_mode=None, display_options=None, selectable_values=None, type=None)

Bases: object

A control to display a dropdown list with buttons that are used to select a single value.

Parameters:

  • filter_control_id (str) – The ID of the FilterDropDownControl .

  • source_filter_id (str) – The source filter ID of the FilterDropDownControl .

  • title (str) – The title of the FilterDropDownControl .

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

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

filter_drop_down_control_property = quicksight.CfnDashboard.FilterDropDownControlProperty(
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",
    title="title",

    # the properties below are optional
    cascading_control_configuration=quicksight.CfnDashboard.CascadingControlConfigurationProperty(
        source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
            column_to_match=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_sheet_control_id="sourceSheetControlId"
        )]
    ),
    commit_mode="commitMode",
    display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
        values=["values"]
    ),
    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-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-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-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-commitmode

display_options

The display options of the FilterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-displayoptions

filter_control_id

The ID of the FilterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-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-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-selectablevalues

source_filter_id

The source filter ID of the FilterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-sourcefilterid

title

The title of the FilterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-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-dashboard-filterdropdowncontrol.html#cfn-quicksight-dashboard-filterdropdowncontrol-type

Type:

The type of the FilterDropDownControl . Choose one of the following options

FilterGroupProperty

class CfnDashboard.FilterGroupProperty(*, cross_dataset, filter_group_id, filters, scope_configuration, 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 QuickSight User Guide .

Parameters:

  • cross_dataset (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 (str) – The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

  • filters (Union[IResolvable, Sequence[Union[IResolvable, FilterProperty, Dict[str, Any]]]]) – The list of filters that are present in a FilterGroup .

  • scope_configuration (Union[IResolvable, FilterScopeConfigurationProperty, Dict[str, Any]]) – 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-dashboard-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-dashboard-filtergroup.html#cfn-quicksight-dashboard-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-dashboard-filtergroup.html#cfn-quicksight-dashboard-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-dashboard-filtergroup.html#cfn-quicksight-dashboard-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-dashboard-filtergroup.html#cfn-quicksight-dashboard-filtergroup-scopeconfiguration

status

The status of the FilterGroup .

See:

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

FilterListConfigurationProperty

class CfnDashboard.FilterListConfigurationProperty(*, match_operator, category_values=None, null_option=None, select_all_options=None)

Bases: object

A list of filter configurations.

Parameters:

  • match_operator (str) – The match operator that is used to determine if a filter should be applied.

  • category_values (Optional[Sequence[str]]) – The list of category values for the 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.

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

filter_list_configuration_property = quicksight.CfnDashboard.FilterListConfigurationProperty(
    match_operator="matchOperator",

    # the properties below are optional
    category_values=["categoryValues"],
    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-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-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-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-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-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-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-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-filterlistconfiguration-selectalloptions

FilterListControlProperty

class CfnDashboard.FilterListControlProperty(*, filter_control_id, source_filter_id, title, cascading_control_configuration=None, display_options=None, selectable_values=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:

  • filter_control_id (str) – The ID of the FilterListControl .

  • source_filter_id (str) – The source filter ID of the FilterListControl .

  • title (str) – The title of the FilterListControl .

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

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

filter_list_control_property = quicksight.CfnDashboard.FilterListControlProperty(
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",
    title="title",

    # the properties below are optional
    cascading_control_configuration=quicksight.CfnDashboard.CascadingControlConfigurationProperty(
        source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
            column_to_match=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_sheet_control_id="sourceSheetControlId"
        )]
    ),
    display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
            visibility="visibility"
        ),
        select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
        values=["values"]
    ),
    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-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-cascadingcontrolconfiguration

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-displayoptions

filter_control_id

The ID of the FilterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-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-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-selectablevalues

source_filter_id

The source filter ID of the FilterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-sourcefilterid

title

The title of the FilterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-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-dashboard-filterlistcontrol.html#cfn-quicksight-dashboard-filterlistcontrol-type

Type:

The type of the FilterListControl . Choose one of the following options

FilterOperationSelectedFieldsConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

filter_operation_selected_fields_configuration_property = quicksight.CfnDashboard.FilterOperationSelectedFieldsConfigurationProperty(
    selected_columns=[quicksight.CfnDashboard.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-dashboard-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-dashboard-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-dashboard-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-dashboard-filteroperationselectedfieldsconfiguration-selectedfieldoptions

selected_fields

Chooses the fields that are filtered in CustomActionFilterOperation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filteroperationselectedfieldsconfiguration.html#cfn-quicksight-dashboard-filteroperationselectedfieldsconfiguration-selectedfields

FilterOperationTargetVisualsConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

filter_operation_target_visuals_configuration_property = quicksight.CfnDashboard.FilterOperationTargetVisualsConfigurationProperty(
    same_sheet_target_visual_configuration=quicksight.CfnDashboard.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-dashboard-filteroperationtargetvisualsconfiguration.html#cfn-quicksight-dashboard-filteroperationtargetvisualsconfiguration-samesheettargetvisualconfiguration

FilterProperty

class CfnDashboard.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-dashboard-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 QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html#cfn-quicksight-dashboard-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-dashboard-filter.html#cfn-quicksight-dashboard-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-dashboard-filter.html#cfn-quicksight-dashboard-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-dashboard-filter.html#cfn-quicksight-dashboard-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-dashboard-filter.html#cfn-quicksight-dashboard-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-dashboard-filter.html#cfn-quicksight-dashboard-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-dashboard-filter.html#cfn-quicksight-dashboard-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-dashboard-filter.html#cfn-quicksight-dashboard-filter-topbottomfilter

FilterRelativeDateTimeControlProperty

class CfnDashboard.FilterRelativeDateTimeControlProperty(*, filter_control_id, source_filter_id, title, commit_mode=None, display_options=None)

Bases: object

A control from a date filter that is used to specify the relative date.

Parameters:

  • filter_control_id (str) – The ID of the FilterTextAreaControl .

  • source_filter_id (str) – The source filter ID of the FilterTextAreaControl .

  • title (str) – The title of the FilterTextAreaControl .

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

See:

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

filter_relative_date_time_control_property = quicksight.CfnDashboard.FilterRelativeDateTimeControlProperty(
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",
    title="title",

    # the properties below are optional
    commit_mode="commitMode",
    display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
        date_time_format="dateTimeFormat",
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    )
)

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-dashboard-filterrelativedatetimecontrol.html#cfn-quicksight-dashboard-filterrelativedatetimecontrol-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterrelativedatetimecontrol.html#cfn-quicksight-dashboard-filterrelativedatetimecontrol-displayoptions

filter_control_id

The ID of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterrelativedatetimecontrol.html#cfn-quicksight-dashboard-filterrelativedatetimecontrol-filtercontrolid

source_filter_id

The source filter ID of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterrelativedatetimecontrol.html#cfn-quicksight-dashboard-filterrelativedatetimecontrol-sourcefilterid

title

The title of the FilterTextAreaControl .

See:

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

FilterScopeConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

# all_sheets: Any

filter_scope_configuration_property = quicksight.CfnDashboard.FilterScopeConfigurationProperty(
    all_sheets=all_sheets,
    selected_sheets=quicksight.CfnDashboard.SelectedSheetsFilterScopeConfigurationProperty(
        sheet_visual_scoping_configurations=[quicksight.CfnDashboard.SheetVisualScopingConfigurationProperty(
            scope="scope",
            sheet_id="sheetId",

            # the properties below are optional
            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-dashboard-filterscopeconfiguration.html#cfn-quicksight-dashboard-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-dashboard-filterscopeconfiguration.html#cfn-quicksight-dashboard-filterscopeconfiguration-selectedsheets

FilterSelectableValuesProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

filter_selectable_values_property = quicksight.CfnDashboard.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-dashboard-filterselectablevalues.html#cfn-quicksight-dashboard-filterselectablevalues-values

FilterSliderControlProperty

class CfnDashboard.FilterSliderControlProperty(*, filter_control_id, maximum_value, minimum_value, source_filter_id, step_size, title, display_options=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:

  • filter_control_id (str) – The ID of the FilterSliderControl .

  • maximum_value (Union[int, float]) – The larger value that is displayed at the right of the slider. Default: - 0

  • minimum_value (Union[int, float]) – The smaller value that is displayed at the left of the slider. Default: - 0

  • source_filter_id (str) – The source filter ID of the FilterSliderControl .

  • step_size (Union[int, float]) – The number of increments that the slider bar is divided into. Default: - 0

  • title (str) – The title of the FilterSliderControl .

  • display_options (Union[IResolvable, SliderControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

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

filter_slider_control_property = quicksight.CfnDashboard.FilterSliderControlProperty(
    filter_control_id="filterControlId",
    maximum_value=123,
    minimum_value=123,
    source_filter_id="sourceFilterId",
    step_size=123,
    title="title",

    # the properties below are optional
    display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    type="type"
)

Attributes

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-displayoptions

filter_control_id

The ID of the FilterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-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-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-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-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-minimumvalue

source_filter_id

The source filter ID of the FilterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-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-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-stepsize

title

The title of the FilterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-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-dashboard-filterslidercontrol.html#cfn-quicksight-dashboard-filterslidercontrol-type

Type:

The type of the FilterSliderControl . Choose one of the following options

FilterTextAreaControlProperty

class CfnDashboard.FilterTextAreaControlProperty(*, filter_control_id, source_filter_id, title, delimiter=None, display_options=None)

Bases: object

A control to display a text box that is used to enter multiple entries.

Parameters:

  • filter_control_id (str) – The ID of the FilterTextAreaControl .

  • source_filter_id (str) – The source filter ID of the FilterTextAreaControl .

  • title (str) – The title of the FilterTextAreaControl .

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

See:

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

filter_text_area_control_property = quicksight.CfnDashboard.FilterTextAreaControlProperty(
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",
    title="title",

    # the properties below are optional
    delimiter="delimiter",
    display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-filtertextareacontrol.html#cfn-quicksight-dashboard-filtertextareacontrol-delimiter

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextareacontrol.html#cfn-quicksight-dashboard-filtertextareacontrol-displayoptions

filter_control_id

The ID of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextareacontrol.html#cfn-quicksight-dashboard-filtertextareacontrol-filtercontrolid

source_filter_id

The source filter ID of the FilterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextareacontrol.html#cfn-quicksight-dashboard-filtertextareacontrol-sourcefilterid

title

The title of the FilterTextAreaControl .

See:

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

FilterTextFieldControlProperty

class CfnDashboard.FilterTextFieldControlProperty(*, filter_control_id, source_filter_id, title, display_options=None)

Bases: object

A control to display a text box that is used to enter a single entry.

Parameters:

  • filter_control_id (str) – The ID of the FilterTextFieldControl .

  • source_filter_id (str) – The source filter ID of the FilterTextFieldControl .

  • title (str) – The title of the FilterTextFieldControl .

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

filter_text_field_control_property = quicksight.CfnDashboard.FilterTextFieldControlProperty(
    filter_control_id="filterControlId",
    source_filter_id="sourceFilterId",
    title="title",

    # the properties below are optional
    display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-filtertextfieldcontrol.html#cfn-quicksight-dashboard-filtertextfieldcontrol-displayoptions

filter_control_id

The ID of the FilterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextfieldcontrol.html#cfn-quicksight-dashboard-filtertextfieldcontrol-filtercontrolid

source_filter_id

The source filter ID of the FilterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filtertextfieldcontrol.html#cfn-quicksight-dashboard-filtertextfieldcontrol-sourcefilterid

title

The title of the FilterTextFieldControl .

See:

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

FontConfigurationProperty

class CfnDashboard.FontConfigurationProperty(*, font_color=None, font_decoration=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_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-dashboard-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 import aws_quicksight as quicksight

font_configuration_property = quicksight.CfnDashboard.FontConfigurationProperty(
    font_color="fontColor",
    font_decoration="fontDecoration",
    font_size=quicksight.CfnDashboard.FontSizeProperty(
        relative="relative"
    ),
    font_style="fontStyle",
    font_weight=quicksight.CfnDashboard.FontWeightProperty(
        name="name"
    )
)

Attributes

font_color

Determines the color of the text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-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-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-fontconfiguration-fontdecoration

font_size

The option that determines the text display size.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-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-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-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-dashboard-fontconfiguration.html#cfn-quicksight-dashboard-fontconfiguration-fontweight

FontSizeProperty

class CfnDashboard.FontSizeProperty(*, relative=None)

Bases: object

The option that determines the text display size.

Parameters:

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

font_size_property = quicksight.CfnDashboard.FontSizeProperty(
    relative="relative"
)

Attributes

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-dashboard-fontsize.html#cfn-quicksight-dashboard-fontsize-relative

FontWeightProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

font_weight_property = quicksight.CfnDashboard.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-dashboard-fontweight.html#cfn-quicksight-dashboard-fontweight-name

ForecastComputationProperty

class CfnDashboard.ForecastComputationProperty(*, computation_id, 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 (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-dashboard-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-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-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-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-customseasonalityvalue

lower_boundary

The lower boundary setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-lowerboundary

name

The name of a computation.

See:

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

periods_backward

The periods backward setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-periodsbackward

periods_forward

The periods forward setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-periodsforward

prediction_interval

The prediction interval setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-predictioninterval

seasonality

.

  • AUTOMATIC

  • CUSTOM : Checks the custom seasonality value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-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-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-time

upper_boundary

The upper boundary setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-forecastcomputation.html#cfn-quicksight-dashboard-forecastcomputation-upperboundary

value

The value field that is used in a computation.

See:

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

ForecastConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

forecast_configuration_property = quicksight.CfnDashboard.ForecastConfigurationProperty(
    forecast_properties=quicksight.CfnDashboard.TimeBasedForecastPropertiesProperty(
        lower_boundary=123,
        periods_backward=123,
        periods_forward=123,
        prediction_interval=123,
        seasonality=123,
        upper_boundary=123
    ),
    scenario=quicksight.CfnDashboard.ForecastScenarioProperty(
        what_if_point_scenario=quicksight.CfnDashboard.WhatIfPointScenarioProperty(
            date="date",
            value=123
        ),
        what_if_range_scenario=quicksight.CfnDashboard.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-dashboard-forecastconfiguration.html#cfn-quicksight-dashboard-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-dashboard-forecastconfiguration.html#cfn-quicksight-dashboard-forecastconfiguration-scenario

ForecastScenarioProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

forecast_scenario_property = quicksight.CfnDashboard.ForecastScenarioProperty(
    what_if_point_scenario=quicksight.CfnDashboard.WhatIfPointScenarioProperty(
        date="date",
        value=123
    ),
    what_if_range_scenario=quicksight.CfnDashboard.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-dashboard-forecastscenario.html#cfn-quicksight-dashboard-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-dashboard-forecastscenario.html#cfn-quicksight-dashboard-forecastscenario-whatifrangescenario

FormatConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

format_configuration_property = quicksight.CfnDashboard.FormatConfigurationProperty(
    date_time_format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
        date_time_format="dateTimeFormat",
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    ),
    number_format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
        format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        )
    ),
    string_format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        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-dashboard-formatconfiguration.html#cfn-quicksight-dashboard-formatconfiguration-datetimeformatconfiguration

number_format_configuration

Formatting configuration for number fields.

See:

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

string_format_configuration

Formatting configuration for string fields.

See:

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

FreeFormLayoutCanvasSizeOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

free_form_layout_canvas_size_options_property = quicksight.CfnDashboard.FreeFormLayoutCanvasSizeOptionsProperty(
    screen_canvas_size_options=quicksight.CfnDashboard.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-dashboard-freeformlayoutcanvassizeoptions.html#cfn-quicksight-dashboard-freeformlayoutcanvassizeoptions-screencanvassizeoptions

FreeFormLayoutConfigurationProperty

class CfnDashboard.FreeFormLayoutConfigurationProperty(*, elements, canvas_size_options=None)

Bases: object

The configuration of a free-form layout.

Parameters:
See:

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

free_form_layout_configuration_property = quicksight.CfnDashboard.FreeFormLayoutConfigurationProperty(
    elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
        element_id="elementId",
        element_type="elementType",
        height="height",
        width="width",
        x_axis_location="xAxisLocation",
        y_axis_location="yAxisLocation",

        # the properties below are optional
        background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
            color="color",
            visibility="visibility"
        ),
        border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
            color="color",
            visibility="visibility"
        ),
        loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
            visibility="visibility"
        ),
        rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
            configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                visibility="visibility"
            ),
            expression="expression"
        )],
        selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
            color="color",
            visibility="visibility"
        ),
        visibility="visibility"
    )],

    # the properties below are optional
    canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutCanvasSizeOptionsProperty(
        screen_canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutScreenCanvasSizeOptionsProperty(
            optimized_view_port_width="optimizedViewPortWidth"
        )
    )
)

Attributes

canvas_size_options

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutconfiguration.html#cfn-quicksight-dashboard-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-dashboard-freeformlayoutconfiguration.html#cfn-quicksight-dashboard-freeformlayoutconfiguration-elements

FreeFormLayoutElementBackgroundStyleProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

free_form_layout_element_background_style_property = quicksight.CfnDashboard.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-dashboard-freeformlayoutelementbackgroundstyle.html#cfn-quicksight-dashboard-freeformlayoutelementbackgroundstyle-color

visibility

The background visibility of a free-form layout element.

See:

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

FreeFormLayoutElementBorderStyleProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

free_form_layout_element_border_style_property = quicksight.CfnDashboard.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-dashboard-freeformlayoutelementborderstyle.html#cfn-quicksight-dashboard-freeformlayoutelementborderstyle-color

visibility

The border visibility of a free-form layout element.

See:

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

FreeFormLayoutElementProperty

class CfnDashboard.FreeFormLayoutElementProperty(*, element_id, element_type, height, width, x_axis_location, y_axis_location, background_style=None, border_style=None, loading_animation=None, rendering_rules=None, selected_border_style=None, visibility=None)

Bases: object

An element within a free-form layout.

Parameters:

  • element_id (str) – A unique identifier for an element within a free-form layout.

  • element_type (str) – The type of element.

  • height (str) – The height of an element within a free-form layout.

  • width (str) – The width of an element within a free-form layout.

  • x_axis_location (str) – The x-axis coordinate of the element.

  • y_axis_location (str) – The y-axis coordinate of the element.

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

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

See:

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

free_form_layout_element_property = quicksight.CfnDashboard.FreeFormLayoutElementProperty(
    element_id="elementId",
    element_type="elementType",
    height="height",
    width="width",
    x_axis_location="xAxisLocation",
    y_axis_location="yAxisLocation",

    # the properties below are optional
    background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
        color="color",
        visibility="visibility"
    ),
    border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
        color="color",
        visibility="visibility"
    ),
    loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
        visibility="visibility"
    ),
    rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
        configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
            visibility="visibility"
        ),
        expression="expression"
    )],
    selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
        color="color",
        visibility="visibility"
    ),
    visibility="visibility"
)

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-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-elementid

element_type

The type of element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-width

x_axis_location

The x-axis coordinate of the element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-xaxislocation

y_axis_location

The y-axis coordinate of the element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformlayoutelement.html#cfn-quicksight-dashboard-freeformlayoutelement-yaxislocation

FreeFormLayoutScreenCanvasSizeOptionsProperty

class CfnDashboard.FreeFormLayoutScreenCanvasSizeOptionsProperty(*, optimized_view_port_width)

Bases: object

The options that determine the sizing of the canvas used in a free-form layout.

Parameters:

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

free_form_layout_screen_canvas_size_options_property = quicksight.CfnDashboard.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-dashboard-freeformlayoutscreencanvassizeoptions.html#cfn-quicksight-dashboard-freeformlayoutscreencanvassizeoptions-optimizedviewportwidth

FreeFormSectionLayoutConfigurationProperty

class CfnDashboard.FreeFormSectionLayoutConfigurationProperty(*, elements)

Bases: object

The free-form layout configuration of a section.

Parameters:

elements (Union[IResolvable, Sequence[Union[IResolvable, FreeFormLayoutElementProperty, Dict[str, Any]]]]) – The elements that are included in the free-form layout.

See:

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

free_form_section_layout_configuration_property = quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
    elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
        element_id="elementId",
        element_type="elementType",
        height="height",
        width="width",
        x_axis_location="xAxisLocation",
        y_axis_location="yAxisLocation",

        # the properties below are optional
        background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
            color="color",
            visibility="visibility"
        ),
        border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
            color="color",
            visibility="visibility"
        ),
        loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
            visibility="visibility"
        ),
        rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
            configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                visibility="visibility"
            ),
            expression="expression"
        )],
        selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
            color="color",
            visibility="visibility"
        ),
        visibility="visibility"
    )]
)

Attributes

elements

The elements that are included in the free-form layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-freeformsectionlayoutconfiguration.html#cfn-quicksight-dashboard-freeformsectionlayoutconfiguration-elements

FunnelChartAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-funnelchartaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

funnel_chart_aggregated_field_wells_property = quicksight.CfnDashboard.FunnelChartAggregatedFieldWellsProperty(
    category=[quicksight.CfnDashboard.DimensionFieldProperty(
        categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            date_granularity="dateGranularity",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    )],
    values=[quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        )
    )]
)

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-dashboard-funnelchartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-funnelchartaggregatedfieldwells.html#cfn-quicksight-dashboard-funnelchartaggregatedfieldwells-values

FunnelChartConfigurationProperty

class CfnDashboard.FunnelChartConfigurationProperty(*, category_label_options=None, data_label_options=None, field_wells=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-dashboard-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-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-funnelchartconfiguration-datalabeloptions

field_wells

The field well configuration of a FunnelChartVisual .

See:

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

sort_configuration

The sort configuration of a FunnelChartVisual .

See:

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

tooltip

The tooltip configuration of a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-funnelchartconfiguration.html#cfn-quicksight-dashboard-funnelchartconfiguration-valuelabeloptions

visual_palette

The visual palette configuration of a FunnelChartVisual .

See:

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

FunnelChartDataLabelOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

funnel_chart_data_label_options_property = quicksight.CfnDashboard.FunnelChartDataLabelOptionsProperty(
    category_label_visibility="categoryLabelVisibility",
    label_color="labelColor",
    label_font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.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-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-funnelchartdatalabeloptions-categorylabelvisibility

label_color

The color of the data label text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-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-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-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-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-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-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-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-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-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-dashboard-funnelchartdatalabeloptions.html#cfn-quicksight-dashboard-funnelchartdatalabeloptions-visibility

FunnelChartFieldWellsProperty

class CfnDashboard.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-dashboard-funnelchartfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

funnel_chart_field_wells_property = quicksight.CfnDashboard.FunnelChartFieldWellsProperty(
    funnel_chart_aggregated_field_wells=quicksight.CfnDashboard.FunnelChartAggregatedFieldWellsProperty(
        category=[quicksight.CfnDashboard.DimensionFieldProperty(
            categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            ),
            date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                date_granularity="dateGranularity",
                format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                    date_time_format="dateTimeFormat",
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            ),
            numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            )
        )],
        values=[quicksight.CfnDashboard.MeasureFieldProperty(
            calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
                expression="expression",
                field_id="fieldId"
            ),
            categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function="aggregationFunction",
                format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function="aggregationFunction",
                format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                    date_time_format="dateTimeFormat",
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                ),
                format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            )
        )]
    )
)

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-dashboard-funnelchartfieldwells.html#cfn-quicksight-dashboard-funnelchartfieldwells-funnelchartaggregatedfieldwells

FunnelChartSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

funnel_chart_sort_configuration_property = quicksight.CfnDashboard.FunnelChartSortConfigurationProperty(
    category_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-funnelchartsortconfiguration.html#cfn-quicksight-dashboard-funnelchartsortconfiguration-categoryitemslimit

category_sort

The sort configuration of the category fields.

See:

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

FunnelChartVisualProperty

class CfnDashboard.FunnelChartVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None)

Bases: object

A funnel chart.

For more information, see Using funnel charts in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-funnelchartvisual-actions

chart_configuration

The configuration of a FunnelChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-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-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-funnelchartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-funnelchartvisual.html#cfn-quicksight-dashboard-funnelchartvisual-visualid

GaugeChartArcConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

gauge_chart_arc_conditional_formatting_property = quicksight.CfnDashboard.GaugeChartArcConditionalFormattingProperty(
    foreground_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    )
)

Attributes

foreground_color

The conditional formatting of the arc foreground color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartarcconditionalformatting.html#cfn-quicksight-dashboard-gaugechartarcconditionalformatting-foregroundcolor

GaugeChartConditionalFormattingOptionProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

gauge_chart_conditional_formatting_option_property = quicksight.CfnDashboard.GaugeChartConditionalFormattingOptionProperty(
    arc=quicksight.CfnDashboard.GaugeChartArcConditionalFormattingProperty(
        foreground_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        )
    ),
    primary_value=quicksight.CfnDashboard.GaugeChartPrimaryValueConditionalFormattingProperty(
        icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
            custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                expression="expression",
                icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                ),

                # the properties below are optional
                color="color",
                display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                )
            ),
            icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                expression="expression",

                # the properties below are optional
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        )
    )
)

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-dashboard-gaugechartconditionalformattingoption.html#cfn-quicksight-dashboard-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-dashboard-gaugechartconditionalformattingoption.html#cfn-quicksight-dashboard-gaugechartconditionalformattingoption-primaryvalue

GaugeChartConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

gauge_chart_conditional_formatting_property = quicksight.CfnDashboard.GaugeChartConditionalFormattingProperty(
    conditional_formatting_options=[quicksight.CfnDashboard.GaugeChartConditionalFormattingOptionProperty(
        arc=quicksight.CfnDashboard.GaugeChartArcConditionalFormattingProperty(
            foreground_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            )
        ),
        primary_value=quicksight.CfnDashboard.GaugeChartPrimaryValueConditionalFormattingProperty(
            icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
                custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                    expression="expression",
                    icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    ),

                    # the properties below are optional
                    color="color",
                    display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    )
                ),
                icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                    expression="expression",

                    # the properties below are optional
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            )
        )
    )]
)

Attributes

conditional_formatting_options

Conditional formatting options of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconditionalformatting.html#cfn-quicksight-dashboard-gaugechartconditionalformatting-conditionalformattingoptions

GaugeChartConfigurationProperty

class CfnDashboard.GaugeChartConfigurationProperty(*, data_labels=None, field_wells=None, gauge_chart_options=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-dashboard-gaugechartconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
data_labels

The data label configuration of a GaugeChartVisual .

See:

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

field_wells

The field well configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-gaugechartconfiguration.html#cfn-quicksight-dashboard-gaugechartconfiguration-gaugechartoptions

tooltip_options

The tooltip configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartconfiguration.html#cfn-quicksight-dashboard-gaugechartconfiguration-tooltipoptions

visual_palette

The visual palette configuration of a GaugeChartVisual .

See:

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

GaugeChartFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-gaugechartfieldwells.html#cfn-quicksight-dashboard-gaugechartfieldwells-targetvalues

values

The value field wells of a GaugeChartVisual .

See:

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

GaugeChartOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

gauge_chart_options_property = quicksight.CfnDashboard.GaugeChartOptionsProperty(
    arc=quicksight.CfnDashboard.ArcConfigurationProperty(
        arc_angle=123,
        arc_thickness="arcThickness"
    ),
    arc_axis=quicksight.CfnDashboard.ArcAxisConfigurationProperty(
        range=quicksight.CfnDashboard.ArcAxisDisplayRangeProperty(
            max=123,
            min=123
        ),
        reserve_range=123
    ),
    comparison=quicksight.CfnDashboard.ComparisonConfigurationProperty(
        comparison_format=quicksight.CfnDashboard.ComparisonFormatConfigurationProperty(
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        ),
        comparison_method="comparisonMethod"
    ),
    primary_value_display_type="primaryValueDisplayType",
    primary_value_font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.FontWeightProperty(
            name="name"
        )
    )
)

Attributes

arc

The arc configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartoptions.html#cfn-quicksight-dashboard-gaugechartoptions-arc

arc_axis

The arc axis configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartoptions.html#cfn-quicksight-dashboard-gaugechartoptions-arcaxis

comparison

The comparison configuration of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartoptions.html#cfn-quicksight-dashboard-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-dashboard-gaugechartoptions.html#cfn-quicksight-dashboard-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-dashboard-gaugechartoptions.html#cfn-quicksight-dashboard-gaugechartoptions-primaryvaluefontconfiguration

GaugeChartPrimaryValueConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

gauge_chart_primary_value_conditional_formatting_property = quicksight.CfnDashboard.GaugeChartPrimaryValueConditionalFormattingProperty(
    icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
        custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
            expression="expression",
            icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                icon="icon",
                unicode_icon="unicodeIcon"
            ),

            # the properties below are optional
            color="color",
            display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                icon_display_option="iconDisplayOption"
            )
        ),
        icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
            expression="expression",

            # the properties below are optional
            icon_set_type="iconSetType"
        )
    ),
    text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    )
)

Attributes

icon

The conditional formatting of the primary value icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartprimaryvalueconditionalformatting.html#cfn-quicksight-dashboard-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-dashboard-gaugechartprimaryvalueconditionalformatting.html#cfn-quicksight-dashboard-gaugechartprimaryvalueconditionalformatting-textcolor

GaugeChartVisualProperty

class CfnDashboard.GaugeChartVisualProperty(*, visual_id, actions=None, chart_configuration=None, conditional_formatting=None, subtitle=None, title=None)

Bases: object

A gauge chart.

For more information, see Using gauge charts in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-gaugechartvisual.html#cfn-quicksight-dashboard-gaugechartvisual-actions

chart_configuration

The configuration of a GaugeChartVisual .

See:

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

conditional_formatting

The conditional formatting of a GaugeChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gaugechartvisual.html#cfn-quicksight-dashboard-gaugechartvisual-conditionalformatting

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-gaugechartvisual.html#cfn-quicksight-dashboard-gaugechartvisual-visualid

GeospatialCoordinateBoundsProperty

class CfnDashboard.GeospatialCoordinateBoundsProperty(*, east, north, south, west)

Bases: object

The bound options (north, south, west, east) of the geospatial window options.

Parameters:

  • east (Union[int, float]) – The longitude of the east bound of the geospatial coordinate bounds.

  • north (Union[int, float]) – The latitude of the north bound of the geospatial coordinate bounds.

  • south (Union[int, float]) – The latitude of the south bound of the geospatial coordinate bounds.

  • west (Union[int, float]) – The longitude of the west bound of the geospatial coordinate bounds.

See:

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

geospatial_coordinate_bounds_property = quicksight.CfnDashboard.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-dashboard-geospatialcoordinatebounds.html#cfn-quicksight-dashboard-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-dashboard-geospatialcoordinatebounds.html#cfn-quicksight-dashboard-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-dashboard-geospatialcoordinatebounds.html#cfn-quicksight-dashboard-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-dashboard-geospatialcoordinatebounds.html#cfn-quicksight-dashboard-geospatialcoordinatebounds-west

GeospatialHeatmapColorScaleProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

geospatial_heatmap_color_scale_property = quicksight.CfnDashboard.GeospatialHeatmapColorScaleProperty(
    colors=[quicksight.CfnDashboard.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-dashboard-geospatialheatmapcolorscale.html#cfn-quicksight-dashboard-geospatialheatmapcolorscale-colors

GeospatialHeatmapConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

geospatial_heatmap_configuration_property = quicksight.CfnDashboard.GeospatialHeatmapConfigurationProperty(
    heatmap_color=quicksight.CfnDashboard.GeospatialHeatmapColorScaleProperty(
        colors=[quicksight.CfnDashboard.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-dashboard-geospatialheatmapconfiguration.html#cfn-quicksight-dashboard-geospatialheatmapconfiguration-heatmapcolor

GeospatialHeatmapDataColorProperty

class CfnDashboard.GeospatialHeatmapDataColorProperty(*, color)

Bases: object

The color to be used in the heatmap point style.

Parameters:

color (str) – The hex color to be used in the heatmap point style.

See:

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

geospatial_heatmap_data_color_property = quicksight.CfnDashboard.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-dashboard-geospatialheatmapdatacolor.html#cfn-quicksight-dashboard-geospatialheatmapdatacolor-color

GeospatialMapAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-geospatialmapaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-geospatialmapaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-geospatialmapaggregatedfieldwells.html#cfn-quicksight-dashboard-geospatialmapaggregatedfieldwells-values

GeospatialMapConfigurationProperty

class CfnDashboard.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-dashboard-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-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-fieldwells

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-pointstyleoptions

tooltip

The tooltip display setup of the visual.

See:

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

visual_palette

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-geospatialmapconfiguration.html#cfn-quicksight-dashboard-geospatialmapconfiguration-windowoptions

GeospatialMapFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-geospatialmapfieldwells.html#cfn-quicksight-dashboard-geospatialmapfieldwells-geospatialmapaggregatedfieldwells

GeospatialMapStyleOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

geospatial_map_style_options_property = quicksight.CfnDashboard.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-dashboard-geospatialmapstyleoptions.html#cfn-quicksight-dashboard-geospatialmapstyleoptions-basemapstyle

GeospatialMapVisualProperty

class CfnDashboard.GeospatialMapVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None)

Bases: object

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-geospatialmapvisual-actions

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-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-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-geospatialmapvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-geospatialmapvisual.html#cfn-quicksight-dashboard-geospatialmapvisual-visualid

GeospatialPointStyleOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

geospatial_point_style_options_property = quicksight.CfnDashboard.GeospatialPointStyleOptionsProperty(
    cluster_marker_configuration=quicksight.CfnDashboard.ClusterMarkerConfigurationProperty(
        cluster_marker=quicksight.CfnDashboard.ClusterMarkerProperty(
            simple_cluster_marker=quicksight.CfnDashboard.SimpleClusterMarkerProperty(
                color="color"
            )
        )
    ),
    heatmap_configuration=quicksight.CfnDashboard.GeospatialHeatmapConfigurationProperty(
        heatmap_color=quicksight.CfnDashboard.GeospatialHeatmapColorScaleProperty(
            colors=[quicksight.CfnDashboard.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-dashboard-geospatialpointstyleoptions.html#cfn-quicksight-dashboard-geospatialpointstyleoptions-clustermarkerconfiguration

heatmap_configuration

The heatmap configuration of the geospatial point style.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-geospatialpointstyleoptions.html#cfn-quicksight-dashboard-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-dashboard-geospatialpointstyleoptions.html#cfn-quicksight-dashboard-geospatialpointstyleoptions-selectedpointstyle

GeospatialWindowOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

geospatial_window_options_property = quicksight.CfnDashboard.GeospatialWindowOptionsProperty(
    bounds=quicksight.CfnDashboard.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-dashboard-geospatialwindowoptions.html#cfn-quicksight-dashboard-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-dashboard-geospatialwindowoptions.html#cfn-quicksight-dashboard-geospatialwindowoptions-mapzoommode

GlobalTableBorderOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

global_table_border_options_property = quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
    side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
        bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        ),
        inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        ),
        inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        ),
        left=quicksight.CfnDashboard.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        ),
        right=quicksight.CfnDashboard.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        ),
        top=quicksight.CfnDashboard.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        )
    ),
    uniform_border=quicksight.CfnDashboard.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-dashboard-globaltableborderoptions.html#cfn-quicksight-dashboard-globaltableborderoptions-sidespecificborder

uniform_border

Determines the options for uniform border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-globaltableborderoptions.html#cfn-quicksight-dashboard-globaltableborderoptions-uniformborder

GradientColorProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

gradient_color_property = quicksight.CfnDashboard.GradientColorProperty(
    stops=[quicksight.CfnDashboard.GradientStopProperty(
        gradient_offset=123,

        # the properties below are optional
        color="color",
        data_value=123
    )]
)

Attributes

stops

The list of gradient color stops.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gradientcolor.html#cfn-quicksight-dashboard-gradientcolor-stops

GradientStopProperty

class CfnDashboard.GradientStopProperty(*, gradient_offset, color=None, data_value=None)

Bases: object

Determines the gradient stop configuration.

Parameters:

  • gradient_offset (Union[int, float]) – Determines gradient offset value. Default: - 0

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

  • data_value (Union[int, float, None]) – Determines the data value.

See:

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

gradient_stop_property = quicksight.CfnDashboard.GradientStopProperty(
    gradient_offset=123,

    # the properties below are optional
    color="color",
    data_value=123
)

Attributes

color

Determines the color.

See:

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

data_value

Determines the data value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gradientstop.html#cfn-quicksight-dashboard-gradientstop-datavalue

gradient_offset

Determines gradient offset value.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gradientstop.html#cfn-quicksight-dashboard-gradientstop-gradientoffset

GridLayoutCanvasSizeOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

grid_layout_canvas_size_options_property = quicksight.CfnDashboard.GridLayoutCanvasSizeOptionsProperty(
    screen_canvas_size_options=quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
        resize_option="resizeOption",

        # the properties below are optional
        optimized_view_port_width="optimizedViewPortWidth"
    )
)

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-dashboard-gridlayoutcanvassizeoptions.html#cfn-quicksight-dashboard-gridlayoutcanvassizeoptions-screencanvassizeoptions

GridLayoutConfigurationProperty

class CfnDashboard.GridLayoutConfigurationProperty(*, elements, canvas_size_options=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-dashboard-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 import aws_quicksight as quicksight

grid_layout_configuration_property = quicksight.CfnDashboard.GridLayoutConfigurationProperty(
    elements=[quicksight.CfnDashboard.GridLayoutElementProperty(
        column_span=123,
        element_id="elementId",
        element_type="elementType",
        row_span=123,

        # the properties below are optional
        column_index=123,
        row_index=123
    )],

    # the properties below are optional
    canvas_size_options=quicksight.CfnDashboard.GridLayoutCanvasSizeOptionsProperty(
        screen_canvas_size_options=quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
            resize_option="resizeOption",

            # the properties below are optional
            optimized_view_port_width="optimizedViewPortWidth"
        )
    )
)

Attributes

canvas_size_options

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutconfiguration.html#cfn-quicksight-dashboard-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-dashboard-gridlayoutconfiguration.html#cfn-quicksight-dashboard-gridlayoutconfiguration-elements

GridLayoutElementProperty

class CfnDashboard.GridLayoutElementProperty(*, column_span, element_id, element_type, row_span, column_index=None, row_index=None)

Bases: object

An element within a grid layout.

Parameters:

  • column_span (Union[int, float]) – The width of a grid element expressed as a number of grid columns.

  • element_id (str) – A unique identifier for an element within a grid layout.

  • element_type (str) – The type of element.

  • row_span (Union[int, float]) – The height of a grid element expressed as a number of grid rows.

  • column_index (Union[int, float, None]) – The column index for the upper left corner of an element.

  • row_index (Union[int, float, None]) – The row index for the upper left corner of an element.

See:

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

grid_layout_element_property = quicksight.CfnDashboard.GridLayoutElementProperty(
    column_span=123,
    element_id="elementId",
    element_type="elementType",
    row_span=123,

    # the properties below are optional
    column_index=123,
    row_index=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-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-elementid

element_type

The type of element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-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-dashboard-gridlayoutelement.html#cfn-quicksight-dashboard-gridlayoutelement-rowspan

GridLayoutScreenCanvasSizeOptionsProperty

class CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(*, resize_option, optimized_view_port_width=None)

Bases: object

The options that determine the sizing of the canvas used in a grid layout.

Parameters:

  • resize_option (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 Amazon QuickSight console, this option is called Classic . - RESPONSIVE : The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled .

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

grid_layout_screen_canvas_size_options_property = quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
    resize_option="resizeOption",

    # the properties below are optional
    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-dashboard-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-dashboard-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 Amazon QuickSight console, this option is called Classic .

  • RESPONSIVE : The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-dashboard-gridlayoutscreencanvassizeoptions-resizeoption

GrowthRateComputationProperty

class CfnDashboard.GrowthRateComputationProperty(*, computation_id, name=None, period_size=None, time=None, value=None)

Bases: object

The growth rate computation configuration.

Parameters:

  • computation_id (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-dashboard-growthratecomputation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

growth_rate_computation_property = quicksight.CfnDashboard.GrowthRateComputationProperty(
    computation_id="computationId",

    # the properties below are optional
    name="name",
    period_size=123,
    time=quicksight.CfnDashboard.DimensionFieldProperty(
        categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            date_granularity="dateGranularity",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    ),
    value=quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                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-dashboard-growthratecomputation.html#cfn-quicksight-dashboard-growthratecomputation-computationid

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-growthratecomputation.html#cfn-quicksight-dashboard-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-dashboard-growthratecomputation.html#cfn-quicksight-dashboard-growthratecomputation-periodsize

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-growthratecomputation.html#cfn-quicksight-dashboard-growthratecomputation-time

value

The value field that is used in a computation.

See:

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

HeaderFooterSectionConfigurationProperty

class CfnDashboard.HeaderFooterSectionConfigurationProperty(*, layout, section_id, 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-dashboard-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 import aws_quicksight as quicksight

header_footer_section_configuration_property = quicksight.CfnDashboard.HeaderFooterSectionConfigurationProperty(
    layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
        free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
            elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                element_id="elementId",
                element_type="elementType",
                height="height",
                width="width",
                x_axis_location="xAxisLocation",
                y_axis_location="yAxisLocation",

                # the properties below are optional
                background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                    visibility="visibility"
                ),
                rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                    configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                        visibility="visibility"
                    ),
                    expression="expression"
                )],
                selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                visibility="visibility"
            )]
        )
    ),
    section_id="sectionId",

    # the properties below are optional
    style=quicksight.CfnDashboard.SectionStyleProperty(
        height="height",
        padding=quicksight.CfnDashboard.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-dashboard-headerfootersectionconfiguration.html#cfn-quicksight-dashboard-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-dashboard-headerfootersectionconfiguration.html#cfn-quicksight-dashboard-headerfootersectionconfiguration-sectionid

style

The style options of a header or footer section.

See:

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

HeatMapAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-heatmapaggregatedfieldwells.html#cfn-quicksight-dashboard-heatmapaggregatedfieldwells-columns

rows

The rows field well of a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapaggregatedfieldwells.html#cfn-quicksight-dashboard-heatmapaggregatedfieldwells-rows

values

The values field well of a heat map.

See:

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

HeatMapConfigurationProperty

class CfnDashboard.HeatMapConfigurationProperty(*, color_scale=None, column_label_options=None, data_labels=None, field_wells=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-dashboard-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-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-datalabels

field_wells

The field wells of the visual.

See:

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

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-heatmapconfiguration.html#cfn-quicksight-dashboard-heatmapconfiguration-rowlabeloptions

sort_configuration

The sort configuration of a heat map.

See:

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

tooltip

The tooltip display setup of the visual.

See:

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

HeatMapFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-heatmapfieldwells.html#cfn-quicksight-dashboard-heatmapfieldwells-heatmapaggregatedfieldwells

HeatMapSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

heat_map_sort_configuration_property = quicksight.CfnDashboard.HeatMapSortConfigurationProperty(
    heat_map_column_items_limit_configuration=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    heat_map_column_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    heat_map_row_items_limit_configuration=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    heat_map_row_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-heatmapsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-heatmapsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-heatmapsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-heatmapsortconfiguration.html#cfn-quicksight-dashboard-heatmapsortconfiguration-heatmaprowsort

HeatMapVisualProperty

class CfnDashboard.HeatMapVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None)

Bases: object

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-heatmapvisual-actions

chart_configuration

The configuration of a heat map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-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-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-heatmapvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-heatmapvisual.html#cfn-quicksight-dashboard-heatmapvisual-visualid

HistogramAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

histogram_aggregated_field_wells_property = quicksight.CfnDashboard.HistogramAggregatedFieldWellsProperty(
    values=[quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                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-dashboard-histogramaggregatedfieldwells.html#cfn-quicksight-dashboard-histogramaggregatedfieldwells-values

HistogramBinOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

histogram_bin_options_property = quicksight.CfnDashboard.HistogramBinOptionsProperty(
    bin_count=quicksight.CfnDashboard.BinCountOptionsProperty(
        value=123
    ),
    bin_width=quicksight.CfnDashboard.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-dashboard-histogrambinoptions.html#cfn-quicksight-dashboard-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-dashboard-histogrambinoptions.html#cfn-quicksight-dashboard-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-dashboard-histogrambinoptions.html#cfn-quicksight-dashboard-histogrambinoptions-selectedbintype

start_value

The options that determine the bin start value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogrambinoptions.html#cfn-quicksight-dashboard-histogrambinoptions-startvalue

HistogramConfigurationProperty

class CfnDashboard.HistogramConfigurationProperty(*, bin_options=None, data_labels=None, field_wells=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-dashboard-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-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-binoptions

data_labels

The data label configuration of a histogram.

See:

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

field_wells

The field well configuration of a histogram.

See:

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

tooltip

The tooltip configuration of a histogram.

See:

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

visual_palette

The visual palette configuration of a histogram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-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-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-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-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-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-dashboard-histogramconfiguration.html#cfn-quicksight-dashboard-histogramconfiguration-yaxisdisplayoptions

HistogramFieldWellsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

histogram_field_wells_property = quicksight.CfnDashboard.HistogramFieldWellsProperty(
    histogram_aggregated_field_wells=quicksight.CfnDashboard.HistogramAggregatedFieldWellsProperty(
        values=[quicksight.CfnDashboard.MeasureFieldProperty(
            calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
                expression="expression",
                field_id="fieldId"
            ),
            categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function="aggregationFunction",
                format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function="aggregationFunction",
                format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                    date_time_format="dateTimeFormat",
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                ),
                format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    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-dashboard-histogramfieldwells.html#cfn-quicksight-dashboard-histogramfieldwells-histogramaggregatedfieldwells

HistogramVisualProperty

class CfnDashboard.HistogramVisualProperty(*, visual_id, actions=None, chart_configuration=None, subtitle=None, title=None)

Bases: object

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-histogramvisual.html#cfn-quicksight-dashboard-histogramvisual-actions

chart_configuration

The configuration for a HistogramVisual .

See:

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

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-histogramvisual.html#cfn-quicksight-dashboard-histogramvisual-visualid

InnerFilterProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

inner_filter_property = quicksight.CfnDashboard.InnerFilterProperty(
    category_inner_filter=quicksight.CfnDashboard.CategoryInnerFilterProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        configuration=quicksight.CfnDashboard.CategoryFilterConfigurationProperty(
            custom_filter_configuration=quicksight.CfnDashboard.CustomFilterConfigurationProperty(
                match_operator="matchOperator",
                null_option="nullOption",

                # the properties below are optional
                category_value="categoryValue",
                parameter_name="parameterName",
                select_all_options="selectAllOptions"
            ),
            custom_filter_list_configuration=quicksight.CfnDashboard.CustomFilterListConfigurationProperty(
                match_operator="matchOperator",
                null_option="nullOption",

                # the properties below are optional
                category_values=["categoryValues"],
                select_all_options="selectAllOptions"
            ),
            filter_list_configuration=quicksight.CfnDashboard.FilterListConfigurationProperty(
                match_operator="matchOperator",

                # the properties below are optional
                category_values=["categoryValues"],
                null_option="nullOption",
                select_all_options="selectAllOptions"
            )
        ),

        # the properties below are optional
        default_filter_control_configuration=quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
            control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
                default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
                    commit_mode="commitMode",
                    display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                        date_time_format="dateTimeFormat",
                        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_size=quicksight.CfnDashboard.FontSizeProperty(
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    ),
                    type="type"
                ),
                default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
                    commit_mode="commitMode",
                    display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                            visibility="visibility"
                        ),
                        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_size=quicksight.CfnDashboard.FontSizeProperty(
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    ),
                    selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                        values=["values"]
                    ),
                    type="type"
                ),
                default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
                    display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                            visibility="visibility"
                        ),
                        select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                            visibility="visibility"
                        ),
                        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_size=quicksight.CfnDashboard.FontSizeProperty(
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    ),
                    selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                        values=["values"]
                    ),
                    type="type"
                ),
                default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
                    commit_mode="commitMode",
                    display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                        date_time_format="dateTimeFormat",
                        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_size=quicksight.CfnDashboard.FontSizeProperty(
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    )
                ),
                default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
                    maximum_value=123,
                    minimum_value=123,
                    step_size=123,

                    # the properties below are optional
                    display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_size=quicksight.CfnDashboard.FontSizeProperty(
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    ),
                    type="type"
                ),
                default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
                    delimiter="delimiter",
                    display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                            visibility="visibility"
                        ),
                        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_size=quicksight.CfnDashboard.FontSizeProperty(
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                    name="name"
                                )
                            ),
                            visibility="visibility"
                        )
                    )
                ),
                default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
                    display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                            info_icon_text="infoIconText",
                            visibility="visibility"
                        ),
                        placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                            visibility="visibility"
                        ),
                        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                            custom_label="customLabel",
                            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                font_color="fontColor",
                                font_decoration="fontDecoration",
                                font_size=quicksight.CfnDashboard.FontSizeProperty(
                                    relative="relative"
                                ),
                                font_style="fontStyle",
                                font_weight=quicksight.CfnDashboard.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-dashboard-innerfilter.html#cfn-quicksight-dashboard-innerfilter-categoryinnerfilter

InsightConfigurationProperty

class CfnDashboard.InsightConfigurationProperty(*, computations=None, custom_narrative=None)

Bases: object

The configuration of an insight visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-insightconfiguration.html#cfn-quicksight-dashboard-insightconfiguration-computations

custom_narrative

The custom narrative of the insight visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightconfiguration.html#cfn-quicksight-dashboard-insightconfiguration-customnarrative

InsightVisualProperty

class CfnDashboard.InsightVisualProperty(*, data_set_identifier, visual_id, actions=None, insight_configuration=None, subtitle=None, title=None)

Bases: object

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide .

Parameters:

  • data_set_identifier (str) – The dataset that is used in the insight visual.

  • visual_id (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.

  • actions (Union[IResolvable, Sequence[Union[IResolvable, VisualCustomActionProperty, Dict[str, Any]]], None]) – The list of custom actions that are configured for a 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-insightvisual.html#cfn-quicksight-dashboard-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-dashboard-insightvisual.html#cfn-quicksight-dashboard-insightvisual-datasetidentifier

insight_configuration

The configuration of an insight visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-insightvisual.html#cfn-quicksight-dashboard-insightvisual-insightconfiguration

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-insightvisual.html#cfn-quicksight-dashboard-insightvisual-visualid

IntegerDefaultValuesProperty

class CfnDashboard.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[IResolvable, Sequence[Union[int, float]], None]) – The static values of the IntegerDefaultValues .

See:

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

integer_default_values_property = quicksight.CfnDashboard.IntegerDefaultValuesProperty(
    dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
        default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),

        # the properties below are optional
        group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        user_name_column=quicksight.CfnDashboard.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-dashboard-integerdefaultvalues.html#cfn-quicksight-dashboard-integerdefaultvalues-dynamicvalue

static_values

The static values of the IntegerDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerdefaultvalues.html#cfn-quicksight-dashboard-integerdefaultvalues-staticvalues

IntegerParameterDeclarationProperty

class CfnDashboard.IntegerParameterDeclarationProperty(*, name, parameter_value_type, default_values=None, mapped_data_set_parameters=None, value_when_unset=None)

Bases: object

A parameter declaration for the Integer data type.

Parameters:
See:

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

integer_parameter_declaration_property = quicksight.CfnDashboard.IntegerParameterDeclarationProperty(
    name="name",
    parameter_value_type="parameterValueType",

    # the properties below are optional
    default_values=quicksight.CfnDashboard.IntegerDefaultValuesProperty(
        dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
            default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            user_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        static_values=[123]
    ),
    mapped_data_set_parameters=[quicksight.CfnDashboard.MappedDataSetParameterProperty(
        data_set_identifier="dataSetIdentifier",
        data_set_parameter_name="dataSetParameterName"
    )],
    value_when_unset=quicksight.CfnDashboard.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-dashboard-integerparameterdeclaration.html#cfn-quicksight-dashboard-integerparameterdeclaration-defaultvalues

mapped_data_set_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-integerparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-integerparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-integerparameterdeclaration.html#cfn-quicksight-dashboard-integerparameterdeclaration-valuewhenunset

IntegerParameterProperty

class CfnDashboard.IntegerParameterProperty(*, name, values)

Bases: object

An integer parameter.

Parameters:

  • name (str) – The name of the integer parameter.

  • values (Union[IResolvable, Sequence[Union[int, float]]]) – The values for the integer parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-integerparameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

integer_parameter_property = quicksight.CfnDashboard.IntegerParameterProperty(
    name="name",
    values=[123]
)

Attributes

name

The name of the integer parameter.

See:

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

values

The values for the integer parameter.

See:

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

IntegerValueWhenUnsetConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

integer_value_when_unset_configuration_property = quicksight.CfnDashboard.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-dashboard-integervaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-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-dashboard-integervaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-integervaluewhenunsetconfiguration-valuewhenunsetoption

Type:

The built-in options for default values. The value can be one of the following

ItemsLimitConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

items_limit_configuration_property = quicksight.CfnDashboard.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-dashboard-itemslimitconfiguration.html#cfn-quicksight-dashboard-itemslimitconfiguration-itemslimit

other_categories

.

  • INCLUDE

  • EXCLUDE

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-itemslimitconfiguration.html#cfn-quicksight-dashboard-itemslimitconfiguration-othercategories

Type:

The Show other of an axis in the chart. Choose one of the following options

KPIActualValueConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

k_pIActual_value_conditional_formatting_property = quicksight.CfnDashboard.KPIActualValueConditionalFormattingProperty(
    icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
        custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
            expression="expression",
            icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                icon="icon",
                unicode_icon="unicodeIcon"
            ),

            # the properties below are optional
            color="color",
            display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                icon_display_option="iconDisplayOption"
            )
        ),
        icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
            expression="expression",

            # the properties below are optional
            icon_set_type="iconSetType"
        )
    ),
    text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    )
)

Attributes

icon

The conditional formatting of the actual value’s icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiactualvalueconditionalformatting.html#cfn-quicksight-dashboard-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-dashboard-kpiactualvalueconditionalformatting.html#cfn-quicksight-dashboard-kpiactualvalueconditionalformatting-textcolor

KPIComparisonValueConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

k_pIComparison_value_conditional_formatting_property = quicksight.CfnDashboard.KPIComparisonValueConditionalFormattingProperty(
    icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
        custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
            expression="expression",
            icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                icon="icon",
                unicode_icon="unicodeIcon"
            ),

            # the properties below are optional
            color="color",
            display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                icon_display_option="iconDisplayOption"
            )
        ),
        icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
            expression="expression",

            # the properties below are optional
            icon_set_type="iconSetType"
        )
    ),
    text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    )
)

Attributes

icon

The conditional formatting of the comparison value’s icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpicomparisonvalueconditionalformatting.html#cfn-quicksight-dashboard-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-dashboard-kpicomparisonvalueconditionalformatting.html#cfn-quicksight-dashboard-kpicomparisonvalueconditionalformatting-textcolor

KPIConditionalFormattingOptionProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

k_pIConditional_formatting_option_property = quicksight.CfnDashboard.KPIConditionalFormattingOptionProperty(
    actual_value=quicksight.CfnDashboard.KPIActualValueConditionalFormattingProperty(
        icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
            custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                expression="expression",
                icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                ),

                # the properties below are optional
                color="color",
                display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                )
            ),
            icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                expression="expression",

                # the properties below are optional
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        )
    ),
    comparison_value=quicksight.CfnDashboard.KPIComparisonValueConditionalFormattingProperty(
        icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
            custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                expression="expression",
                icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                ),

                # the properties below are optional
                color="color",
                display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                )
            ),
            icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                expression="expression",

                # the properties below are optional
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        )
    ),
    primary_value=quicksight.CfnDashboard.KPIPrimaryValueConditionalFormattingProperty(
        icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
            custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                expression="expression",
                icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                ),

                # the properties below are optional
                color="color",
                display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                )
            ),
            icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                expression="expression",

                # the properties below are optional
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        )
    ),
    progress_bar=quicksight.CfnDashboard.KPIProgressBarConditionalFormattingProperty(
        foreground_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        )
    )
)

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-dashboard-kpiconditionalformattingoption.html#cfn-quicksight-dashboard-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-dashboard-kpiconditionalformattingoption.html#cfn-quicksight-dashboard-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-dashboard-kpiconditionalformattingoption.html#cfn-quicksight-dashboard-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-dashboard-kpiconditionalformattingoption.html#cfn-quicksight-dashboard-kpiconditionalformattingoption-progressbar

KPIConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

k_pIConditional_formatting_property = quicksight.CfnDashboard.KPIConditionalFormattingProperty(
    conditional_formatting_options=[quicksight.CfnDashboard.KPIConditionalFormattingOptionProperty(
        actual_value=quicksight.CfnDashboard.KPIActualValueConditionalFormattingProperty(
            icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
                custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                    expression="expression",
                    icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    ),

                    # the properties below are optional
                    color="color",
                    display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    )
                ),
                icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                    expression="expression",

                    # the properties below are optional
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            )
        ),
        comparison_value=quicksight.CfnDashboard.KPIComparisonValueConditionalFormattingProperty(
            icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
                custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                    expression="expression",
                    icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    ),

                    # the properties below are optional
                    color="color",
                    display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    )
                ),
                icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                    expression="expression",

                    # the properties below are optional
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            )
        ),
        primary_value=quicksight.CfnDashboard.KPIPrimaryValueConditionalFormattingProperty(
            icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
                custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                    expression="expression",
                    icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    ),

                    # the properties below are optional
                    color="color",
                    display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    )
                ),
                icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                    expression="expression",

                    # the properties below are optional
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            )
        ),
        progress_bar=quicksight.CfnDashboard.KPIProgressBarConditionalFormattingProperty(
            foreground_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            )
        )
    )]
)

Attributes

conditional_formatting_options

The conditional formatting options of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconditionalformatting.html#cfn-quicksight-dashboard-kpiconditionalformatting-conditionalformattingoptions

KPIConfigurationProperty

class CfnDashboard.KPIConfigurationProperty(*, field_wells=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-dashboard-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-dashboard-kpiconfiguration.html#cfn-quicksight-dashboard-kpiconfiguration-fieldwells

kpi_options

The options that determine the presentation of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiconfiguration.html#cfn-quicksight-dashboard-kpiconfiguration-kpioptions

sort_configuration

The sort configuration of a KPI visual.

See:

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

KPIFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-kpifieldwells.html#cfn-quicksight-dashboard-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-dashboard-kpifieldwells.html#cfn-quicksight-dashboard-kpifieldwells-trendgroups

values

The value field wells of a KPI visual.

See:

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

KPIOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

k_pIOptions_property = quicksight.CfnDashboard.KPIOptionsProperty(
    comparison=quicksight.CfnDashboard.ComparisonConfigurationProperty(
        comparison_format=quicksight.CfnDashboard.ComparisonFormatConfigurationProperty(
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            )
        ),
        comparison_method="comparisonMethod"
    ),
    primary_value_display_type="primaryValueDisplayType",
    primary_value_font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.FontWeightProperty(
            name="name"
        )
    ),
    progress_bar=quicksight.CfnDashboard.ProgressBarOptionsProperty(
        visibility="visibility"
    ),
    secondary_value=quicksight.CfnDashboard.SecondaryValueOptionsProperty(
        visibility="visibility"
    ),
    secondary_value_font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.FontWeightProperty(
            name="name"
        )
    ),
    sparkline=quicksight.CfnDashboard.KPISparklineOptionsProperty(
        type="type",

        # the properties below are optional
        color="color",
        tooltip_visibility="tooltipVisibility",
        visibility="visibility"
    ),
    trend_arrows=quicksight.CfnDashboard.TrendArrowOptionsProperty(
        visibility="visibility"
    ),
    visual_layout_options=quicksight.CfnDashboard.KPIVisualLayoutOptionsProperty(
        standard_layout=quicksight.CfnDashboard.KPIVisualStandardLayoutProperty(
            type="type"
        )
    )
)

Attributes

comparison

The comparison configuration of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpioptions.html#cfn-quicksight-dashboard-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-dashboard-kpioptions.html#cfn-quicksight-dashboard-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-dashboard-kpioptions.html#cfn-quicksight-dashboard-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-dashboard-kpioptions.html#cfn-quicksight-dashboard-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-dashboard-kpioptions.html#cfn-quicksight-dashboard-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-dashboard-kpioptions.html#cfn-quicksight-dashboard-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-dashboard-kpioptions.html#cfn-quicksight-dashboard-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-dashboard-kpioptions.html#cfn-quicksight-dashboard-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-dashboard-kpioptions.html#cfn-quicksight-dashboard-kpioptions-visuallayoutoptions

KPIPrimaryValueConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

k_pIPrimary_value_conditional_formatting_property = quicksight.CfnDashboard.KPIPrimaryValueConditionalFormattingProperty(
    icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
        custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
            expression="expression",
            icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                icon="icon",
                unicode_icon="unicodeIcon"
            ),

            # the properties below are optional
            color="color",
            display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                icon_display_option="iconDisplayOption"
            )
        ),
        icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
            expression="expression",

            # the properties below are optional
            icon_set_type="iconSetType"
        )
    ),
    text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    )
)

Attributes

icon

The conditional formatting of the primary value’s icon.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpiprimaryvalueconditionalformatting.html#cfn-quicksight-dashboard-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-dashboard-kpiprimaryvalueconditionalformatting.html#cfn-quicksight-dashboard-kpiprimaryvalueconditionalformatting-textcolor

KPIProgressBarConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

k_pIProgress_bar_conditional_formatting_property = quicksight.CfnDashboard.KPIProgressBarConditionalFormattingProperty(
    foreground_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    )
)

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-dashboard-kpiprogressbarconditionalformatting.html#cfn-quicksight-dashboard-kpiprogressbarconditionalformatting-foregroundcolor

KPISortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

k_pISort_configuration_property = quicksight.CfnDashboard.KPISortConfigurationProperty(
    trend_group_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-kpisortconfiguration.html#cfn-quicksight-dashboard-kpisortconfiguration-trendgroupsort

KPISparklineOptionsProperty

class CfnDashboard.KPISparklineOptionsProperty(*, type, color=None, tooltip_visibility=None, visibility=None)

Bases: object

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

Parameters:

  • type (str) – The type of the sparkline.

  • color (Optional[str]) – The color of the sparkline.

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

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

See:

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

k_pISparkline_options_property = quicksight.CfnDashboard.KPISparklineOptionsProperty(
    type="type",

    # the properties below are optional
    color="color",
    tooltip_visibility="tooltipVisibility",
    visibility="visibility"
)

Attributes

color

The color of the sparkline.

See:

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

tooltip_visibility

The tooltip visibility of the sparkline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpisparklineoptions.html#cfn-quicksight-dashboard-kpisparklineoptions-tooltipvisibility

type

The type of the sparkline.

See:

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

visibility

The visibility of the sparkline.

See:

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

KPIVisualLayoutOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

k_pIVisual_layout_options_property = quicksight.CfnDashboard.KPIVisualLayoutOptionsProperty(
    standard_layout=quicksight.CfnDashboard.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-dashboard-kpivisuallayoutoptions.html#cfn-quicksight-dashboard-kpivisuallayoutoptions-standardlayout

KPIVisualProperty

class CfnDashboard.KPIVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, conditional_formatting=None, subtitle=None, title=None)

Bases: object

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-actions

chart_configuration

The configuration of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-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-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-columnhierarchies

conditional_formatting

The conditional formatting of a KPI visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-conditionalformatting

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-kpivisual.html#cfn-quicksight-dashboard-kpivisual-visualid

KPIVisualStandardLayoutProperty

class CfnDashboard.KPIVisualStandardLayoutProperty(*, type)

Bases: object

The standard layout of the KPI visual.

Parameters:

type (str) – The standard layout type.

See:

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

k_pIVisual_standard_layout_property = quicksight.CfnDashboard.KPIVisualStandardLayoutProperty(
    type="type"
)

Attributes

type

The standard layout type.

See:

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

LabelOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

label_options_property = quicksight.CfnDashboard.LabelOptionsProperty(
    custom_label="customLabel",
    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.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-dashboard-labeloptions.html#cfn-quicksight-dashboard-labeloptions-customlabel

font_configuration

The font configuration of the label.

See:

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

visibility

Determines whether or not the label is visible.

See:

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

LayoutConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

layout_configuration_property = quicksight.CfnDashboard.LayoutConfigurationProperty(
    free_form_layout=quicksight.CfnDashboard.FreeFormLayoutConfigurationProperty(
        elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
            element_id="elementId",
            element_type="elementType",
            height="height",
            width="width",
            x_axis_location="xAxisLocation",
            y_axis_location="yAxisLocation",

            # the properties below are optional
            background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                color="color",
                visibility="visibility"
            ),
            border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                color="color",
                visibility="visibility"
            ),
            loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                visibility="visibility"
            ),
            rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                    visibility="visibility"
                ),
                expression="expression"
            )],
            selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                color="color",
                visibility="visibility"
            ),
            visibility="visibility"
        )],

        # the properties below are optional
        canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutCanvasSizeOptionsProperty(
            screen_canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutScreenCanvasSizeOptionsProperty(
                optimized_view_port_width="optimizedViewPortWidth"
            )
        )
    ),
    grid_layout=quicksight.CfnDashboard.GridLayoutConfigurationProperty(
        elements=[quicksight.CfnDashboard.GridLayoutElementProperty(
            column_span=123,
            element_id="elementId",
            element_type="elementType",
            row_span=123,

            # the properties below are optional
            column_index=123,
            row_index=123
        )],

        # the properties below are optional
        canvas_size_options=quicksight.CfnDashboard.GridLayoutCanvasSizeOptionsProperty(
            screen_canvas_size_options=quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
                resize_option="resizeOption",

                # the properties below are optional
                optimized_view_port_width="optimizedViewPortWidth"
            )
        )
    ),
    section_based_layout=quicksight.CfnDashboard.SectionBasedLayoutConfigurationProperty(
        body_sections=[quicksight.CfnDashboard.BodySectionConfigurationProperty(
            content=quicksight.CfnDashboard.BodySectionContentProperty(
                layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
                    free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
                        elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                            element_id="elementId",
                            element_type="elementType",
                            height="height",
                            width="width",
                            x_axis_location="xAxisLocation",
                            y_axis_location="yAxisLocation",

                            # the properties below are optional
                            background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                                visibility="visibility"
                            ),
                            rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                                configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                                    visibility="visibility"
                                ),
                                expression="expression"
                            )],
                            selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            visibility="visibility"
                        )]
                    )
                )
            ),
            section_id="sectionId",

            # the properties below are optional
            page_break_configuration=quicksight.CfnDashboard.SectionPageBreakConfigurationProperty(
                after=quicksight.CfnDashboard.SectionAfterPageBreakProperty(
                    status="status"
                )
            ),
            style=quicksight.CfnDashboard.SectionStyleProperty(
                height="height",
                padding=quicksight.CfnDashboard.SpacingProperty(
                    bottom="bottom",
                    left="left",
                    right="right",
                    top="top"
                )
            )
        )],
        canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutCanvasSizeOptionsProperty(
            paper_canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
                paper_margin=quicksight.CfnDashboard.SpacingProperty(
                    bottom="bottom",
                    left="left",
                    right="right",
                    top="top"
                ),
                paper_orientation="paperOrientation",
                paper_size="paperSize"
            )
        ),
        footer_sections=[quicksight.CfnDashboard.HeaderFooterSectionConfigurationProperty(
            layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
                free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
                    elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                        element_id="elementId",
                        element_type="elementType",
                        height="height",
                        width="width",
                        x_axis_location="xAxisLocation",
                        y_axis_location="yAxisLocation",

                        # the properties below are optional
                        background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                            visibility="visibility"
                        ),
                        rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                            configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                                visibility="visibility"
                            ),
                            expression="expression"
                        )],
                        selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        visibility="visibility"
                    )]
                )
            ),
            section_id="sectionId",

            # the properties below are optional
            style=quicksight.CfnDashboard.SectionStyleProperty(
                height="height",
                padding=quicksight.CfnDashboard.SpacingProperty(
                    bottom="bottom",
                    left="left",
                    right="right",
                    top="top"
                )
            )
        )],
        header_sections=[quicksight.CfnDashboard.HeaderFooterSectionConfigurationProperty(
            layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
                free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
                    elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                        element_id="elementId",
                        element_type="elementType",
                        height="height",
                        width="width",
                        x_axis_location="xAxisLocation",
                        y_axis_location="yAxisLocation",

                        # the properties below are optional
                        background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                            visibility="visibility"
                        ),
                        rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                            configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                                visibility="visibility"
                            ),
                            expression="expression"
                        )],
                        selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        visibility="visibility"
                    )]
                )
            ),
            section_id="sectionId",

            # the properties below are optional
            style=quicksight.CfnDashboard.SectionStyleProperty(
                height="height",
                padding=quicksight.CfnDashboard.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-dashboard-layoutconfiguration.html#cfn-quicksight-dashboard-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-dashboard-layoutconfiguration.html#cfn-quicksight-dashboard-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-dashboard-layoutconfiguration.html#cfn-quicksight-dashboard-layoutconfiguration-sectionbasedlayout

LayoutProperty

class CfnDashboard.LayoutProperty(*, configuration)

Bases: object

A Layout defines the placement of elements within a sheet.

For more information, see Types of layout in the Amazon QuickSight 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]]) – The configuration that determines what the type of layout for a sheet.

See:

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

layout_property = quicksight.CfnDashboard.LayoutProperty(
    configuration=quicksight.CfnDashboard.LayoutConfigurationProperty(
        free_form_layout=quicksight.CfnDashboard.FreeFormLayoutConfigurationProperty(
            elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                element_id="elementId",
                element_type="elementType",
                height="height",
                width="width",
                x_axis_location="xAxisLocation",
                y_axis_location="yAxisLocation",

                # the properties below are optional
                background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                    visibility="visibility"
                ),
                rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                    configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                        visibility="visibility"
                    ),
                    expression="expression"
                )],
                selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                    color="color",
                    visibility="visibility"
                ),
                visibility="visibility"
            )],

            # the properties below are optional
            canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutCanvasSizeOptionsProperty(
                screen_canvas_size_options=quicksight.CfnDashboard.FreeFormLayoutScreenCanvasSizeOptionsProperty(
                    optimized_view_port_width="optimizedViewPortWidth"
                )
            )
        ),
        grid_layout=quicksight.CfnDashboard.GridLayoutConfigurationProperty(
            elements=[quicksight.CfnDashboard.GridLayoutElementProperty(
                column_span=123,
                element_id="elementId",
                element_type="elementType",
                row_span=123,

                # the properties below are optional
                column_index=123,
                row_index=123
            )],

            # the properties below are optional
            canvas_size_options=quicksight.CfnDashboard.GridLayoutCanvasSizeOptionsProperty(
                screen_canvas_size_options=quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
                    resize_option="resizeOption",

                    # the properties below are optional
                    optimized_view_port_width="optimizedViewPortWidth"
                )
            )
        ),
        section_based_layout=quicksight.CfnDashboard.SectionBasedLayoutConfigurationProperty(
            body_sections=[quicksight.CfnDashboard.BodySectionConfigurationProperty(
                content=quicksight.CfnDashboard.BodySectionContentProperty(
                    layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
                        free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
                            elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                                element_id="elementId",
                                element_type="elementType",
                                height="height",
                                width="width",
                                x_axis_location="xAxisLocation",
                                y_axis_location="yAxisLocation",

                                # the properties below are optional
                                background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                                    color="color",
                                    visibility="visibility"
                                ),
                                border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                                    color="color",
                                    visibility="visibility"
                                ),
                                loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                                    visibility="visibility"
                                ),
                                rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                                    configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                                        visibility="visibility"
                                    ),
                                    expression="expression"
                                )],
                                selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                                    color="color",
                                    visibility="visibility"
                                ),
                                visibility="visibility"
                            )]
                        )
                    )
                ),
                section_id="sectionId",

                # the properties below are optional
                page_break_configuration=quicksight.CfnDashboard.SectionPageBreakConfigurationProperty(
                    after=quicksight.CfnDashboard.SectionAfterPageBreakProperty(
                        status="status"
                    )
                ),
                style=quicksight.CfnDashboard.SectionStyleProperty(
                    height="height",
                    padding=quicksight.CfnDashboard.SpacingProperty(
                        bottom="bottom",
                        left="left",
                        right="right",
                        top="top"
                    )
                )
            )],
            canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutCanvasSizeOptionsProperty(
                paper_canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
                    paper_margin=quicksight.CfnDashboard.SpacingProperty(
                        bottom="bottom",
                        left="left",
                        right="right",
                        top="top"
                    ),
                    paper_orientation="paperOrientation",
                    paper_size="paperSize"
                )
            ),
            footer_sections=[quicksight.CfnDashboard.HeaderFooterSectionConfigurationProperty(
                layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
                    free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
                        elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                            element_id="elementId",
                            element_type="elementType",
                            height="height",
                            width="width",
                            x_axis_location="xAxisLocation",
                            y_axis_location="yAxisLocation",

                            # the properties below are optional
                            background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                                visibility="visibility"
                            ),
                            rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                                configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                                    visibility="visibility"
                                ),
                                expression="expression"
                            )],
                            selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            visibility="visibility"
                        )]
                    )
                ),
                section_id="sectionId",

                # the properties below are optional
                style=quicksight.CfnDashboard.SectionStyleProperty(
                    height="height",
                    padding=quicksight.CfnDashboard.SpacingProperty(
                        bottom="bottom",
                        left="left",
                        right="right",
                        top="top"
                    )
                )
            )],
            header_sections=[quicksight.CfnDashboard.HeaderFooterSectionConfigurationProperty(
                layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
                    free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
                        elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                            element_id="elementId",
                            element_type="elementType",
                            height="height",
                            width="width",
                            x_axis_location="xAxisLocation",
                            y_axis_location="yAxisLocation",

                            # the properties below are optional
                            background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                                visibility="visibility"
                            ),
                            rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                                configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                                    visibility="visibility"
                                ),
                                expression="expression"
                            )],
                            selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                                color="color",
                                visibility="visibility"
                            ),
                            visibility="visibility"
                        )]
                    )
                ),
                section_id="sectionId",

                # the properties below are optional
                style=quicksight.CfnDashboard.SectionStyleProperty(
                    height="height",
                    padding=quicksight.CfnDashboard.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-dashboard-layout.html#cfn-quicksight-dashboard-layout-configuration

LegendOptionsProperty

class CfnDashboard.LegendOptionsProperty(*, height=None, position=None, title=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.

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

legend_options_property = quicksight.CfnDashboard.LegendOptionsProperty(
    height="height",
    position="position",
    title=quicksight.CfnDashboard.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                name="name"
            )
        ),
        visibility="visibility"
    ),
    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-dashboard-legendoptions.html#cfn-quicksight-dashboard-legendoptions-height

position

.

  • AUTO

  • RIGHT

  • BOTTOM

  • LEFT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-legendoptions.html#cfn-quicksight-dashboard-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-dashboard-legendoptions.html#cfn-quicksight-dashboard-legendoptions-title

visibility

Determines whether or not the legend is visible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-legendoptions.html#cfn-quicksight-dashboard-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-dashboard-legendoptions.html#cfn-quicksight-dashboard-legendoptions-width

LineChartAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-linechartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-linechartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-linechartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-linechartaggregatedfieldwells.html#cfn-quicksight-dashboard-linechartaggregatedfieldwells-values

LineChartConfigurationProperty

class CfnDashboard.LineChartConfigurationProperty(*, contribution_analysis_defaults=None, data_labels=None, default_series_settings=None, field_wells=None, forecast_configurations=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-dashboard-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-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-contributionanalysisdefaults

data_labels

The data label configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-defaultseriessettings

field_wells

The field well configuration of a line chart.

See:

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

forecast_configurations

The forecast configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-forecastconfigurations

legend

The legend configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-primaryyaxislabeloptions

reference_lines

The reference lines configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-secondaryyaxislabeloptions

series

The series item configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-series

single_axis_options

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-smallmultiplesoptions

sort_configuration

The sort configuration of a line chart.

See:

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

tooltip

The tooltip configuration of a line chart.

See:

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

type

Determines the type of the line chart.

See:

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

visual_palette

The visual palette configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartconfiguration.html#cfn-quicksight-dashboard-linechartconfiguration-xaxislabeloptions

LineChartDefaultSeriesSettingsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

line_chart_default_series_settings_property = quicksight.CfnDashboard.LineChartDefaultSeriesSettingsProperty(
    axis_binding="axisBinding",
    line_style_settings=quicksight.CfnDashboard.LineChartLineStyleSettingsProperty(
        line_interpolation="lineInterpolation",
        line_style="lineStyle",
        line_visibility="lineVisibility",
        line_width="lineWidth"
    ),
    marker_style_settings=quicksight.CfnDashboard.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-dashboard-linechartdefaultseriessettings.html#cfn-quicksight-dashboard-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-dashboard-linechartdefaultseriessettings.html#cfn-quicksight-dashboard-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-dashboard-linechartdefaultseriessettings.html#cfn-quicksight-dashboard-linechartdefaultseriessettings-markerstylesettings

LineChartFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-linechartfieldwells.html#cfn-quicksight-dashboard-linechartfieldwells-linechartaggregatedfieldwells

LineChartLineStyleSettingsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

line_chart_line_style_settings_property = quicksight.CfnDashboard.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-dashboard-linechartlinestylesettings.html#cfn-quicksight-dashboard-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-dashboard-linechartlinestylesettings.html#cfn-quicksight-dashboard-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-dashboard-linechartlinestylesettings.html#cfn-quicksight-dashboard-linechartlinestylesettings-linevisibility

line_width

Width that determines the line thickness.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartlinestylesettings.html#cfn-quicksight-dashboard-linechartlinestylesettings-linewidth

LineChartMarkerStyleSettingsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

line_chart_marker_style_settings_property = quicksight.CfnDashboard.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-dashboard-linechartmarkerstylesettings.html#cfn-quicksight-dashboard-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-dashboard-linechartmarkerstylesettings.html#cfn-quicksight-dashboard-linechartmarkerstylesettings-markershape

marker_size

Size of marker in the series.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartmarkerstylesettings.html#cfn-quicksight-dashboard-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-dashboard-linechartmarkerstylesettings.html#cfn-quicksight-dashboard-linechartmarkerstylesettings-markervisibility

LineChartSeriesSettingsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

line_chart_series_settings_property = quicksight.CfnDashboard.LineChartSeriesSettingsProperty(
    line_style_settings=quicksight.CfnDashboard.LineChartLineStyleSettingsProperty(
        line_interpolation="lineInterpolation",
        line_style="lineStyle",
        line_visibility="lineVisibility",
        line_width="lineWidth"
    ),
    marker_style_settings=quicksight.CfnDashboard.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-dashboard-linechartseriessettings.html#cfn-quicksight-dashboard-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-dashboard-linechartseriessettings.html#cfn-quicksight-dashboard-linechartseriessettings-markerstylesettings

LineChartSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

line_chart_sort_configuration_property = quicksight.CfnDashboard.LineChartSortConfigurationProperty(
    category_items_limit_configuration=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    color_items_limit_configuration=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    small_multiples_limit_configuration=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    small_multiples_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-linechartsortconfiguration.html#cfn-quicksight-dashboard-linechartsortconfiguration-categoryitemslimitconfiguration

category_sort

The sort configuration of the category fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-linechartsortconfiguration.html#cfn-quicksight-dashboard-linechartsortconfiguration-smallmultiplessort

LineChartVisualProperty

class CfnDashboard.LineChartVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None)

Bases: object

A line chart.

For more information, see Using line charts in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-linechartvisual.html#cfn-quicksight-dashboard-linechartvisual-actions

chart_configuration

The configuration of a line chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linechartvisual.html#cfn-quicksight-dashboard-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-dashboard-linechartvisual.html#cfn-quicksight-dashboard-linechartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-linechartvisual.html#cfn-quicksight-dashboard-linechartvisual-visualid

LineSeriesAxisDisplayOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

# data_driven: Any

line_series_axis_display_options_property = quicksight.CfnDashboard.LineSeriesAxisDisplayOptionsProperty(
    axis_options=quicksight.CfnDashboard.AxisDisplayOptionsProperty(
        axis_line_visibility="axisLineVisibility",
        axis_offset="axisOffset",
        data_options=quicksight.CfnDashboard.AxisDataOptionsProperty(
            date_axis_options=quicksight.CfnDashboard.DateAxisOptionsProperty(
                missing_date_visibility="missingDateVisibility"
            ),
            numeric_axis_options=quicksight.CfnDashboard.NumericAxisOptionsProperty(
                range=quicksight.CfnDashboard.AxisDisplayRangeProperty(
                    data_driven=data_driven,
                    min_max=quicksight.CfnDashboard.AxisDisplayMinMaxRangeProperty(
                        maximum=123,
                        minimum=123
                    )
                ),
                scale=quicksight.CfnDashboard.AxisScaleProperty(
                    linear=quicksight.CfnDashboard.AxisLinearScaleProperty(
                        step_count=123,
                        step_size=123
                    ),
                    logarithmic=quicksight.CfnDashboard.AxisLogarithmicScaleProperty(
                        base=123
                    )
                )
            )
        ),
        grid_line_visibility="gridLineVisibility",
        scrollbar_options=quicksight.CfnDashboard.ScrollBarOptionsProperty(
            visibility="visibility",
            visible_range=quicksight.CfnDashboard.VisibleRangeOptionsProperty(
                percent_range=quicksight.CfnDashboard.PercentVisibleRangeProperty(
                    from=123,
                    to=123
                )
            )
        ),
        tick_label_options=quicksight.CfnDashboard.AxisTickLabelOptionsProperty(
            label_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            ),
            rotation_angle=123
        )
    ),
    missing_data_configurations=[quicksight.CfnDashboard.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-dashboard-lineseriesaxisdisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-lineseriesaxisdisplayoptions.html#cfn-quicksight-dashboard-lineseriesaxisdisplayoptions-missingdataconfigurations

LinkSharingConfigurationProperty

class CfnDashboard.LinkSharingConfigurationProperty(*, permissions=None)

Bases: object

A structure that contains the configuration of a shareable link to the dashboard.

Parameters:

permissions (Union[IResolvable, Sequence[Union[IResolvable, ResourcePermissionProperty, Dict[str, Any]]], None]) – A structure that contains the permissions of a shareable link.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linksharingconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

link_sharing_configuration_property = quicksight.CfnDashboard.LinkSharingConfigurationProperty(
    permissions=[quicksight.CfnDashboard.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal",

        # the properties below are optional
        resource="resource"
    )]
)

Attributes

permissions

A structure that contains the permissions of a shareable link.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-linksharingconfiguration.html#cfn-quicksight-dashboard-linksharingconfiguration-permissions

ListControlDisplayOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

list_control_display_options_property = quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
        visibility="visibility"
    ),
    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
        visibility="visibility"
    ),
    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-listcontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-listcontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-listcontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-listcontroldisplayoptions.html#cfn-quicksight-dashboard-listcontroldisplayoptions-titleoptions

ListControlSearchOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

list_control_search_options_property = quicksight.CfnDashboard.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-dashboard-listcontrolsearchoptions.html#cfn-quicksight-dashboard-listcontrolsearchoptions-visibility

ListControlSelectAllOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

list_control_select_all_options_property = quicksight.CfnDashboard.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-dashboard-listcontrolselectalloptions.html#cfn-quicksight-dashboard-listcontrolselectalloptions-visibility

LoadingAnimationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

loading_animation_property = quicksight.CfnDashboard.LoadingAnimationProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility configuration of LoadingAnimation .

See:

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

LocalNavigationConfigurationProperty

class CfnDashboard.LocalNavigationConfigurationProperty(*, target_sheet_id)

Bases: object

The navigation configuration for CustomActionNavigationOperation .

Parameters:

target_sheet_id (str) – The sheet that is targeted for navigation in the same analysis.

See:

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

local_navigation_configuration_property = quicksight.CfnDashboard.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-dashboard-localnavigationconfiguration.html#cfn-quicksight-dashboard-localnavigationconfiguration-targetsheetid

LongFormatTextProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

long_format_text_property = quicksight.CfnDashboard.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-dashboard-longformattext.html#cfn-quicksight-dashboard-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-dashboard-longformattext.html#cfn-quicksight-dashboard-longformattext-richtext

MappedDataSetParameterProperty

class CfnDashboard.MappedDataSetParameterProperty(*, data_set_identifier, data_set_parameter_name)

Bases: object

A dataset parameter that is mapped to an analysis parameter.

Parameters:

  • data_set_identifier (str) – A unique name that identifies a dataset within the analysis or dashboard.

  • data_set_parameter_name (str) – The name of the dataset parameter.

See:

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

mapped_data_set_parameter_property = quicksight.CfnDashboard.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-dashboard-mappeddatasetparameter.html#cfn-quicksight-dashboard-mappeddatasetparameter-datasetidentifier

data_set_parameter_name

The name of the dataset parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-mappeddatasetparameter.html#cfn-quicksight-dashboard-mappeddatasetparameter-datasetparametername

MaximumLabelTypeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

maximum_label_type_property = quicksight.CfnDashboard.MaximumLabelTypeProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility of the maximum label.

See:

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

MaximumMinimumComputationProperty

class CfnDashboard.MaximumMinimumComputationProperty(*, computation_id, type, name=None, time=None, value=None)

Bases: object

The maximum and minimum computation configuration.

Parameters:

  • computation_id (str) – The ID for a computation.

  • type (str) – The type of computation. Choose one of the following options:. - MAXIMUM: A maximum computation. - MINIMUM: A minimum 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-dashboard-maximumminimumcomputation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

maximum_minimum_computation_property = quicksight.CfnDashboard.MaximumMinimumComputationProperty(
    computation_id="computationId",
    type="type",

    # the properties below are optional
    name="name",
    time=quicksight.CfnDashboard.DimensionFieldProperty(
        categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            date_granularity="dateGranularity",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    ),
    value=quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                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-dashboard-maximumminimumcomputation.html#cfn-quicksight-dashboard-maximumminimumcomputation-computationid

name

The name of a computation.

See:

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

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-maximumminimumcomputation.html#cfn-quicksight-dashboard-maximumminimumcomputation-time

type

.

  • MAXIMUM: A maximum computation.

  • MINIMUM: A minimum computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-maximumminimumcomputation.html#cfn-quicksight-dashboard-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-dashboard-maximumminimumcomputation.html#cfn-quicksight-dashboard-maximumminimumcomputation-value

MeasureFieldProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

measure_field_property = quicksight.CfnDashboard.MeasureFieldProperty(
    calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
        expression="expression",
        field_id="fieldId"
    ),
    categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",

        # the properties below are optional
        aggregation_function="aggregationFunction",
        format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        )
    ),
    date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",

        # the properties below are optional
        aggregation_function="aggregationFunction",
        format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
            date_time_format="dateTimeFormat",
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        )
    ),
    numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",

        # the properties below are optional
        aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        ),
        format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
            format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            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-dashboard-measurefield.html#cfn-quicksight-dashboard-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-dashboard-measurefield.html#cfn-quicksight-dashboard-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-dashboard-measurefield.html#cfn-quicksight-dashboard-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-dashboard-measurefield.html#cfn-quicksight-dashboard-measurefield-numericalmeasurefield

MetricComparisonComputationProperty

class CfnDashboard.MetricComparisonComputationProperty(*, computation_id, from_value=None, name=None, target_value=None, time=None)

Bases: object

The metric comparison computation configuration.

Parameters:

  • computation_id (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-dashboard-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-dashboard-metriccomparisoncomputation.html#cfn-quicksight-dashboard-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-dashboard-metriccomparisoncomputation.html#cfn-quicksight-dashboard-metriccomparisoncomputation-fromvalue

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-metriccomparisoncomputation.html#cfn-quicksight-dashboard-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-dashboard-metriccomparisoncomputation.html#cfn-quicksight-dashboard-metriccomparisoncomputation-targetvalue

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-metriccomparisoncomputation.html#cfn-quicksight-dashboard-metriccomparisoncomputation-time

MinimumLabelTypeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

minimum_label_type_property = quicksight.CfnDashboard.MinimumLabelTypeProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility of the minimum label.

See:

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

MissingDataConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

missing_data_configuration_property = quicksight.CfnDashboard.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-dashboard-missingdataconfiguration.html#cfn-quicksight-dashboard-missingdataconfiguration-treatmentoption

Type:

The treatment option that determines how missing data should be rendered. Choose from the following options

NegativeValueConfigurationProperty

class CfnDashboard.NegativeValueConfigurationProperty(*, display_mode)

Bases: object

The options that determine the negative value configuration.

Parameters:

display_mode (str) – Determines the display mode of the negative value configuration.

See:

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

negative_value_configuration_property = quicksight.CfnDashboard.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-dashboard-negativevalueconfiguration.html#cfn-quicksight-dashboard-negativevalueconfiguration-displaymode

NestedFilterProperty

class CfnDashboard.NestedFilterProperty(*, column, filter_id, include_inner_set, inner_filter)

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]]) – The column that the filter is applied to.

  • filter_id (str) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • include_inner_set (Union[bool, IResolvable]) – 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]]) – 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-dashboard-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 import aws_quicksight as quicksight

nested_filter_property = quicksight.CfnDashboard.NestedFilterProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    filter_id="filterId",
    include_inner_set=False,
    inner_filter=quicksight.CfnDashboard.InnerFilterProperty(
        category_inner_filter=quicksight.CfnDashboard.CategoryInnerFilterProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            configuration=quicksight.CfnDashboard.CategoryFilterConfigurationProperty(
                custom_filter_configuration=quicksight.CfnDashboard.CustomFilterConfigurationProperty(
                    match_operator="matchOperator",
                    null_option="nullOption",

                    # the properties below are optional
                    category_value="categoryValue",
                    parameter_name="parameterName",
                    select_all_options="selectAllOptions"
                ),
                custom_filter_list_configuration=quicksight.CfnDashboard.CustomFilterListConfigurationProperty(
                    match_operator="matchOperator",
                    null_option="nullOption",

                    # the properties below are optional
                    category_values=["categoryValues"],
                    select_all_options="selectAllOptions"
                ),
                filter_list_configuration=quicksight.CfnDashboard.FilterListConfigurationProperty(
                    match_operator="matchOperator",

                    # the properties below are optional
                    category_values=["categoryValues"],
                    null_option="nullOption",
                    select_all_options="selectAllOptions"
                )
            ),

            # the properties below are optional
            default_filter_control_configuration=quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
                control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
                    default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
                        commit_mode="commitMode",
                        display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                            date_time_format="dateTimeFormat",
                            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        ),
                        type="type"
                    ),
                    default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
                        commit_mode="commitMode",
                        display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                                visibility="visibility"
                            ),
                            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        ),
                        selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                            values=["values"]
                        ),
                        type="type"
                    ),
                    default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
                        display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                                visibility="visibility"
                            ),
                            select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                                visibility="visibility"
                            ),
                            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        ),
                        selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                            values=["values"]
                        ),
                        type="type"
                    ),
                    default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
                        commit_mode="commitMode",
                        display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                            date_time_format="dateTimeFormat",
                            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        )
                    ),
                    default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
                        maximum_value=123,
                        minimum_value=123,
                        step_size=123,

                        # the properties below are optional
                        display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        ),
                        type="type"
                    ),
                    default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
                        delimiter="delimiter",
                        display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                                visibility="visibility"
                            ),
                            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                        name="name"
                                    )
                                ),
                                visibility="visibility"
                            )
                        )
                    ),
                    default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
                        display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                                info_icon_text="infoIconText",
                                visibility="visibility"
                            ),
                            placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                                visibility="visibility"
                            ),
                            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                                custom_label="customLabel",
                                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                                    font_color="fontColor",
                                    font_decoration="fontDecoration",
                                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                                        relative="relative"
                                    ),
                                    font_style="fontStyle",
                                    font_weight=quicksight.CfnDashboard.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-dashboard-nestedfilter.html#cfn-quicksight-dashboard-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-dashboard-nestedfilter.html#cfn-quicksight-dashboard-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-dashboard-nestedfilter.html#cfn-quicksight-dashboard-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-dashboard-nestedfilter.html#cfn-quicksight-dashboard-nestedfilter-innerfilter

NullValueFormatConfigurationProperty

class CfnDashboard.NullValueFormatConfigurationProperty(*, null_string)

Bases: object

The options that determine the null value format configuration.

Parameters:

null_string (str) – Determines the null string of null values.

See:

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

null_value_format_configuration_property = quicksight.CfnDashboard.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-dashboard-nullvalueformatconfiguration.html#cfn-quicksight-dashboard-nullvalueformatconfiguration-nullstring

NumberDisplayFormatConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

number_display_format_configuration_property = quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
        decimal_places=123
    ),
    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
        display_mode="displayMode"
    ),
    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    number_scale="numberScale",
    prefix="prefix",
    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
        decimal_separator="decimalSeparator",
        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
            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-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-numberdisplayformatconfiguration.html#cfn-quicksight-dashboard-numberdisplayformatconfiguration-numberscale

prefix

Determines the prefix value of the number format.

See:

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

separator_configuration

The options that determine the numeric separator configuration.

See:

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

suffix

Determines the suffix value of the number format.

See:

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

NumberFormatConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

number_format_configuration_property = quicksight.CfnDashboard.NumberFormatConfigurationProperty(
    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix",
            symbol="symbol"
        ),
        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    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-dashboard-numberformatconfiguration.html#cfn-quicksight-dashboard-numberformatconfiguration-formatconfiguration

NumericAxisOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

# data_driven: Any

numeric_axis_options_property = quicksight.CfnDashboard.NumericAxisOptionsProperty(
    range=quicksight.CfnDashboard.AxisDisplayRangeProperty(
        data_driven=data_driven,
        min_max=quicksight.CfnDashboard.AxisDisplayMinMaxRangeProperty(
            maximum=123,
            minimum=123
        )
    ),
    scale=quicksight.CfnDashboard.AxisScaleProperty(
        linear=quicksight.CfnDashboard.AxisLinearScaleProperty(
            step_count=123,
            step_size=123
        ),
        logarithmic=quicksight.CfnDashboard.AxisLogarithmicScaleProperty(
            base=123
        )
    )
)

Attributes

range

The range setup of a numeric axis.

See:

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

scale

The scale setup of a numeric axis.

See:

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

NumericEqualityDrillDownFilterProperty

class CfnDashboard.NumericEqualityDrillDownFilterProperty(*, column, value)

Bases: object

The numeric equality type drill down filter.

Parameters:

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

  • value (Union[int, float]) – The value of the double input numeric drill down filter. Default: - 0

See:

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

numeric_equality_drill_down_filter_property = quicksight.CfnDashboard.NumericEqualityDrillDownFilterProperty(
    column=quicksight.CfnDashboard.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-dashboard-numericequalitydrilldownfilter.html#cfn-quicksight-dashboard-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-dashboard-numericequalitydrilldownfilter.html#cfn-quicksight-dashboard-numericequalitydrilldownfilter-value

NumericEqualityFilterProperty

class CfnDashboard.NumericEqualityFilterProperty(*, column, filter_id, match_operator, null_option, aggregation_function=None, default_filter_control_configuration=None, parameter_name=None, select_all_options=None, value=None)

Bases: object

A NumericEqualityFilter filters values that are equal to the specified value.

Parameters:

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

  • filter_id (str) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • match_operator (str) – The match operator that is used to determine if a filter should be applied.

  • null_option (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.

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

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

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

numeric_equality_filter_property = quicksight.CfnDashboard.NumericEqualityFilterProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    filter_id="filterId",
    match_operator="matchOperator",
    null_option="nullOption",

    # the properties below are optional
    aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    ),
    default_filter_control_configuration=quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
        control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
                display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
                maximum_value=123,
                minimum_value=123,
                step_size=123,

                # the properties below are optional
                display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    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-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-aggregationfunction

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-numericequalityfilter.html#cfn-quicksight-dashboard-numericequalityfilter-selectalloptions

value

The input value.

See:

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

NumericFormatConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

numeric_format_configuration_property = quicksight.CfnDashboard.NumericFormatConfigurationProperty(
    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
            decimal_places=123
        ),
        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
            display_mode="displayMode"
        ),
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        number_scale="numberScale",
        prefix="prefix",
        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
            decimal_separator="decimalSeparator",
            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                symbol="symbol",
                visibility="visibility"
            )
        ),
        suffix="suffix",
        symbol="symbol"
    ),
    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
            decimal_places=123
        ),
        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
            display_mode="displayMode"
        ),
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        number_scale="numberScale",
        prefix="prefix",
        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
            decimal_separator="decimalSeparator",
            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                symbol="symbol",
                visibility="visibility"
            )
        ),
        suffix="suffix"
    ),
    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
            decimal_places=123
        ),
        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
            display_mode="displayMode"
        ),
        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
            null_string="nullString"
        ),
        prefix="prefix",
        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
            decimal_separator="decimalSeparator",
            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                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-dashboard-numericformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-numericformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-numericformatconfiguration.html#cfn-quicksight-dashboard-numericformatconfiguration-percentagedisplayformatconfiguration

NumericRangeFilterProperty

class CfnDashboard.NumericRangeFilterProperty(*, column, filter_id, null_option, aggregation_function=None, default_filter_control_configuration=None, include_maximum=None, include_minimum=None, range_maximum=None, range_minimum=None, select_all_options=None)

Bases: object

A NumericRangeFilter filters values that are within the value range.

Parameters:

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

  • filter_id (str) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • null_option (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.

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

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

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

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

numeric_range_filter_property = quicksight.CfnDashboard.NumericRangeFilterProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    filter_id="filterId",
    null_option="nullOption",

    # the properties below are optional
    aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    ),
    default_filter_control_configuration=quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
        control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
                display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
                maximum_value=123,
                minimum_value=123,
                step_size=123,

                # the properties below are optional
                display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    include_maximum=False,
    include_minimum=False,
    range_maximum=quicksight.CfnDashboard.NumericRangeFilterValueProperty(
        parameter="parameter",
        static_value=123
    ),
    range_minimum=quicksight.CfnDashboard.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-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-aggregationfunction

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-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-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-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-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-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-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-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-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-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-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-nulloption

range_maximum

The maximum value for the filter value range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-rangemaximum

range_minimum

The minimum value for the filter value range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-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-dashboard-numericrangefilter.html#cfn-quicksight-dashboard-numericrangefilter-selectalloptions

NumericRangeFilterValueProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

numeric_range_filter_value_property = quicksight.CfnDashboard.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-dashboard-numericrangefiltervalue.html#cfn-quicksight-dashboard-numericrangefiltervalue-parameter

static_value

The static value of the numeric range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericrangefiltervalue.html#cfn-quicksight-dashboard-numericrangefiltervalue-staticvalue

NumericSeparatorConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

numeric_separator_configuration_property = quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
    decimal_separator="decimalSeparator",
    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
        symbol="symbol",
        visibility="visibility"
    )
)

Attributes

decimal_separator

Determines the decimal separator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericseparatorconfiguration.html#cfn-quicksight-dashboard-numericseparatorconfiguration-decimalseparator

thousands_separator

The options that determine the thousands separator configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-numericseparatorconfiguration.html#cfn-quicksight-dashboard-numericseparatorconfiguration-thousandsseparator

NumericalAggregationFunctionProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

numerical_aggregation_function_property = quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
    percentile_aggregation=quicksight.CfnDashboard.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-dashboard-numericalaggregationfunction.html#cfn-quicksight-dashboard-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-dashboard-numericalaggregationfunction.html#cfn-quicksight-dashboard-numericalaggregationfunction-simplenumericalaggregation

NumericalDimensionFieldProperty

class CfnDashboard.NumericalDimensionFieldProperty(*, column, field_id, 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-dashboard-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 import aws_quicksight as quicksight

numerical_dimension_field_property = quicksight.CfnDashboard.NumericalDimensionFieldProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",

    # the properties below are optional
    format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
        format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        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-dashboard-numericaldimensionfield.html#cfn-quicksight-dashboard-numericaldimensionfield-column

field_id

The custom field ID.

See:

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

format_configuration

The format configuration of the field.

See:

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

hierarchy_id

The custom hierarchy ID.

See:

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

NumericalMeasureFieldProperty

class CfnDashboard.NumericalMeasureFieldProperty(*, column, field_id, aggregation_function=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-dashboard-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 import aws_quicksight as quicksight

numerical_measure_field_property = quicksight.CfnDashboard.NumericalMeasureFieldProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",

    # the properties below are optional
    aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
        percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
            percentile_value=123
        ),
        simple_numerical_aggregation="simpleNumericalAggregation"
    ),
    format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
        format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        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-dashboard-numericalmeasurefield.html#cfn-quicksight-dashboard-numericalmeasurefield-aggregationfunction

column

The column that is used in the NumericalMeasureField .

See:

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

field_id

The custom field ID.

See:

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

format_configuration

The format configuration of the field.

See:

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

PaginationConfigurationProperty

class CfnDashboard.PaginationConfigurationProperty(*, page_number, page_size)

Bases: object

The pagination configuration for a table visual or boxplot.

Parameters:

  • page_number (Union[int, float]) – Indicates the page number.

  • page_size (Union[int, float]) – Indicates how many items render in one page.

See:

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

pagination_configuration_property = quicksight.CfnDashboard.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-dashboard-paginationconfiguration.html#cfn-quicksight-dashboard-paginationconfiguration-pagenumber

page_size

Indicates how many items render in one page.

See:

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

PanelConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

panel_configuration_property = quicksight.CfnDashboard.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.CfnDashboard.PanelTitleOptionsProperty(
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-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-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-backgroundvisibility

border_color

Sets the line color of panel borders.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-bordercolor

border_style

Sets the line style of panel borders.

See:

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

border_thickness

Sets the line thickness of panel borders.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-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-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-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-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-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-dashboard-panelconfiguration.html#cfn-quicksight-dashboard-panelconfiguration-guttervisibility

title

Configures the title display within each small multiples panel.

See:

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

PanelTitleOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

panel_title_options_property = quicksight.CfnDashboard.PanelTitleOptionsProperty(
    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.FontWeightProperty(
            name="name"
        )
    ),
    horizontal_text_alignment="horizontalTextAlignment",
    visibility="visibility"
)

Attributes

font_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-paneltitleoptions.html#cfn-quicksight-dashboard-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-dashboard-paneltitleoptions.html#cfn-quicksight-dashboard-paneltitleoptions-horizontaltextalignment

visibility

Determines whether or not panel titles are displayed.

See:

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

ParameterControlProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

parameter_control_property = quicksight.CfnDashboard.ParameterControlProperty(
    date_time_picker=quicksight.CfnDashboard.ParameterDateTimePickerControlProperty(
        parameter_control_id="parameterControlId",
        source_parameter_name="sourceParameterName",
        title="title",

        # the properties below are optional
        display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
            date_time_format="dateTimeFormat",
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    ),
    dropdown=quicksight.CfnDashboard.ParameterDropDownControlProperty(
        parameter_control_id="parameterControlId",
        source_parameter_name="sourceParameterName",
        title="title",

        # the properties below are optional
        cascading_control_configuration=quicksight.CfnDashboard.CascadingControlConfigurationProperty(
            source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
                column_to_match=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_sheet_control_id="sourceSheetControlId"
            )]
        ),
        commit_mode="commitMode",
        display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        selectable_values=quicksight.CfnDashboard.ParameterSelectableValuesProperty(
            link_to_data_set_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            values=["values"]
        ),
        type="type"
    ),
    list=quicksight.CfnDashboard.ParameterListControlProperty(
        parameter_control_id="parameterControlId",
        source_parameter_name="sourceParameterName",
        title="title",

        # the properties below are optional
        cascading_control_configuration=quicksight.CfnDashboard.CascadingControlConfigurationProperty(
            source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
                column_to_match=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_sheet_control_id="sourceSheetControlId"
            )]
        ),
        display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                visibility="visibility"
            ),
            select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        ),
        selectable_values=quicksight.CfnDashboard.ParameterSelectableValuesProperty(
            link_to_data_set_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            values=["values"]
        ),
        type="type"
    ),
    slider=quicksight.CfnDashboard.ParameterSliderControlProperty(
        maximum_value=123,
        minimum_value=123,
        parameter_control_id="parameterControlId",
        source_parameter_name="sourceParameterName",
        step_size=123,
        title="title",

        # the properties below are optional
        display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    ),
    text_area=quicksight.CfnDashboard.ParameterTextAreaControlProperty(
        parameter_control_id="parameterControlId",
        source_parameter_name="sourceParameterName",
        title="title",

        # the properties below are optional
        delimiter="delimiter",
        display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    ),
    text_field=quicksight.CfnDashboard.ParameterTextFieldControlProperty(
        parameter_control_id="parameterControlId",
        source_parameter_name="sourceParameterName",
        title="title",

        # the properties below are optional
        display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
            info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                info_icon_text="infoIconText",
                visibility="visibility"
            ),
            placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                visibility="visibility"
            ),
            title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                custom_label="customLabel",
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),
                visibility="visibility"
            )
        )
    )
)

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-dashboard-parametercontrol.html#cfn-quicksight-dashboard-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-dashboard-parametercontrol.html#cfn-quicksight-dashboard-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-dashboard-parametercontrol.html#cfn-quicksight-dashboard-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-dashboard-parametercontrol.html#cfn-quicksight-dashboard-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-dashboard-parametercontrol.html#cfn-quicksight-dashboard-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-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-textfield

ParameterDateTimePickerControlProperty

class CfnDashboard.ParameterDateTimePickerControlProperty(*, parameter_control_id, source_parameter_name, title, display_options=None)

Bases: object

A control from a date parameter that specifies date and time.

Parameters:

  • parameter_control_id (str) – The ID of the ParameterDateTimePickerControl .

  • source_parameter_name (str) – The name of the ParameterDateTimePickerControl .

  • title (str) – The title of the ParameterDateTimePickerControl .

  • display_options (Union[IResolvable, DateTimePickerControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

See:

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

parameter_date_time_picker_control_property = quicksight.CfnDashboard.ParameterDateTimePickerControlProperty(
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    title="title",

    # the properties below are optional
    display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
        date_time_format="dateTimeFormat",
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-parameterdatetimepickercontrol.html#cfn-quicksight-dashboard-parameterdatetimepickercontrol-displayoptions

parameter_control_id

The ID of the ParameterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdatetimepickercontrol.html#cfn-quicksight-dashboard-parameterdatetimepickercontrol-parametercontrolid

source_parameter_name

The name of the ParameterDateTimePickerControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdatetimepickercontrol.html#cfn-quicksight-dashboard-parameterdatetimepickercontrol-sourceparametername

title

The title of the ParameterDateTimePickerControl .

See:

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

ParameterDeclarationProperty

class CfnDashboard.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 QuickSight in the Amazon QuickSight 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-dashboard-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 import aws_quicksight as quicksight

parameter_declaration_property = quicksight.CfnDashboard.ParameterDeclarationProperty(
    date_time_parameter_declaration=quicksight.CfnDashboard.DateTimeParameterDeclarationProperty(
        name="name",

        # the properties below are optional
        default_values=quicksight.CfnDashboard.DateTimeDefaultValuesProperty(
            dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
                default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),

                # the properties below are optional
                group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                user_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            rolling_date=quicksight.CfnDashboard.RollingDateConfigurationProperty(
                expression="expression",

                # the properties below are optional
                data_set_identifier="dataSetIdentifier"
            ),
            static_values=["staticValues"]
        ),
        mapped_data_set_parameters=[quicksight.CfnDashboard.MappedDataSetParameterProperty(
            data_set_identifier="dataSetIdentifier",
            data_set_parameter_name="dataSetParameterName"
        )],
        time_granularity="timeGranularity",
        value_when_unset=quicksight.CfnDashboard.DateTimeValueWhenUnsetConfigurationProperty(
            custom_value="customValue",
            value_when_unset_option="valueWhenUnsetOption"
        )
    ),
    decimal_parameter_declaration=quicksight.CfnDashboard.DecimalParameterDeclarationProperty(
        name="name",
        parameter_value_type="parameterValueType",

        # the properties below are optional
        default_values=quicksight.CfnDashboard.DecimalDefaultValuesProperty(
            dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
                default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),

                # the properties below are optional
                group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                user_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            static_values=[123]
        ),
        mapped_data_set_parameters=[quicksight.CfnDashboard.MappedDataSetParameterProperty(
            data_set_identifier="dataSetIdentifier",
            data_set_parameter_name="dataSetParameterName"
        )],
        value_when_unset=quicksight.CfnDashboard.DecimalValueWhenUnsetConfigurationProperty(
            custom_value=123,
            value_when_unset_option="valueWhenUnsetOption"
        )
    ),
    integer_parameter_declaration=quicksight.CfnDashboard.IntegerParameterDeclarationProperty(
        name="name",
        parameter_value_type="parameterValueType",

        # the properties below are optional
        default_values=quicksight.CfnDashboard.IntegerDefaultValuesProperty(
            dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
                default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),

                # the properties below are optional
                group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                user_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            static_values=[123]
        ),
        mapped_data_set_parameters=[quicksight.CfnDashboard.MappedDataSetParameterProperty(
            data_set_identifier="dataSetIdentifier",
            data_set_parameter_name="dataSetParameterName"
        )],
        value_when_unset=quicksight.CfnDashboard.IntegerValueWhenUnsetConfigurationProperty(
            custom_value=123,
            value_when_unset_option="valueWhenUnsetOption"
        )
    ),
    string_parameter_declaration=quicksight.CfnDashboard.StringParameterDeclarationProperty(
        name="name",
        parameter_value_type="parameterValueType",

        # the properties below are optional
        default_values=quicksight.CfnDashboard.StringDefaultValuesProperty(
            dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
                default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),

                # the properties below are optional
                group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                user_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )
            ),
            static_values=["staticValues"]
        ),
        mapped_data_set_parameters=[quicksight.CfnDashboard.MappedDataSetParameterProperty(
            data_set_identifier="dataSetIdentifier",
            data_set_parameter_name="dataSetParameterName"
        )],
        value_when_unset=quicksight.CfnDashboard.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-dashboard-parameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-parameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-parameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-parameterdeclaration.html#cfn-quicksight-dashboard-parameterdeclaration-stringparameterdeclaration

ParameterDropDownControlProperty

class CfnDashboard.ParameterDropDownControlProperty(*, parameter_control_id, source_parameter_name, title, cascading_control_configuration=None, commit_mode=None, display_options=None, selectable_values=None, type=None)

Bases: object

A control to display a dropdown list with buttons that are used to select a single value.

Parameters:

  • parameter_control_id (str) – The ID of the ParameterDropDownControl .

  • source_parameter_name (str) – The source parameter name of the ParameterDropDownControl .

  • title (str) – The title of the ParameterDropDownControl .

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

  • selectable_values (Union[IResolvable, ParameterSelectableValuesProperty, Dict[str, Any], None]) – A list of selectable values that are used in a control.

  • type (Optional[str]) – The type parameter name of the ParameterDropDownControl .

See:

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

parameter_drop_down_control_property = quicksight.CfnDashboard.ParameterDropDownControlProperty(
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    title="title",

    # the properties below are optional
    cascading_control_configuration=quicksight.CfnDashboard.CascadingControlConfigurationProperty(
        source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
            column_to_match=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_sheet_control_id="sourceSheetControlId"
        )]
    ),
    commit_mode="commitMode",
    display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    selectable_values=quicksight.CfnDashboard.ParameterSelectableValuesProperty(
        link_to_data_set_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        values=["values"]
    ),
    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-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-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-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-commitmode

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-displayoptions

parameter_control_id

The ID of the ParameterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-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-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-selectablevalues

source_parameter_name

The source parameter name of the ParameterDropDownControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterdropdowncontrol.html#cfn-quicksight-dashboard-parameterdropdowncontrol-sourceparametername

title

The title of the ParameterDropDownControl .

See:

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

type

The type parameter name of the ParameterDropDownControl .

See:

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

ParameterListControlProperty

class CfnDashboard.ParameterListControlProperty(*, parameter_control_id, source_parameter_name, title, cascading_control_configuration=None, display_options=None, selectable_values=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:

  • parameter_control_id (str) – The ID of the ParameterListControl .

  • source_parameter_name (str) – The source parameter name of the ParameterListControl .

  • title (str) – The title of the ParameterListControl .

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

  • selectable_values (Union[IResolvable, ParameterSelectableValuesProperty, Dict[str, Any], None]) – A list of selectable values that are used in a control.

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

See:

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

parameter_list_control_property = quicksight.CfnDashboard.ParameterListControlProperty(
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    title="title",

    # the properties below are optional
    cascading_control_configuration=quicksight.CfnDashboard.CascadingControlConfigurationProperty(
        source_controls=[quicksight.CfnDashboard.CascadingControlSourceProperty(
            column_to_match=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            source_sheet_control_id="sourceSheetControlId"
        )]
    ),
    display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
            visibility="visibility"
        ),
        select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            visibility="visibility"
        )
    ),
    selectable_values=quicksight.CfnDashboard.ParameterSelectableValuesProperty(
        link_to_data_set_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        values=["values"]
    ),
    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-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-cascadingcontrolconfiguration

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-displayoptions

parameter_control_id

The ID of the ParameterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-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-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-selectablevalues

source_parameter_name

The source parameter name of the ParameterListControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterlistcontrol.html#cfn-quicksight-dashboard-parameterlistcontrol-sourceparametername

title

The title of the ParameterListControl .

See:

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

type

The type of ParameterListControl .

See:

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

ParameterSelectableValuesProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

parameter_selectable_values_property = quicksight.CfnDashboard.ParameterSelectableValuesProperty(
    link_to_data_set_column=quicksight.CfnDashboard.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-dashboard-parameterselectablevalues.html#cfn-quicksight-dashboard-parameterselectablevalues-linktodatasetcolumn

values

The values that are used in ParameterSelectableValues .

See:

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

ParameterSliderControlProperty

class CfnDashboard.ParameterSliderControlProperty(*, maximum_value, minimum_value, parameter_control_id, source_parameter_name, step_size, title, display_options=None)

Bases: object

A control to display a horizontal toggle bar.

This is used to change a value by sliding the toggle.

Parameters:

  • maximum_value (Union[int, float]) – The larger value that is displayed at the right of the slider. Default: - 0

  • minimum_value (Union[int, float]) – The smaller value that is displayed at the left of the slider. Default: - 0

  • parameter_control_id (str) – The ID of the ParameterSliderControl .

  • source_parameter_name (str) – The source parameter name of the ParameterSliderControl .

  • step_size (Union[int, float]) – The number of increments that the slider bar is divided into. Default: - 0

  • title (str) – The title of the ParameterSliderControl .

  • display_options (Union[IResolvable, SliderControlDisplayOptionsProperty, Dict[str, Any], None]) – The display options of a control.

See:

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

parameter_slider_control_property = quicksight.CfnDashboard.ParameterSliderControlProperty(
    maximum_value=123,
    minimum_value=123,
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    step_size=123,
    title="title",

    # the properties below are optional
    display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-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-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-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-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-minimumvalue

parameter_control_id

The ID of the ParameterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-parametercontrolid

source_parameter_name

The source parameter name of the ParameterSliderControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-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-dashboard-parameterslidercontrol.html#cfn-quicksight-dashboard-parameterslidercontrol-stepsize

title

The title of the ParameterSliderControl .

See:

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

ParameterTextAreaControlProperty

class CfnDashboard.ParameterTextAreaControlProperty(*, parameter_control_id, source_parameter_name, title, delimiter=None, display_options=None)

Bases: object

A control to display a text box that is used to enter multiple entries.

Parameters:

  • parameter_control_id (str) – The ID of the ParameterTextAreaControl .

  • source_parameter_name (str) – The source parameter name of the ParameterTextAreaControl .

  • title (str) – The title of the ParameterTextAreaControl .

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

See:

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

parameter_text_area_control_property = quicksight.CfnDashboard.ParameterTextAreaControlProperty(
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    title="title",

    # the properties below are optional
    delimiter="delimiter",
    display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-parametertextareacontrol.html#cfn-quicksight-dashboard-parametertextareacontrol-delimiter

display_options

The display options of a control.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextareacontrol.html#cfn-quicksight-dashboard-parametertextareacontrol-displayoptions

parameter_control_id

The ID of the ParameterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextareacontrol.html#cfn-quicksight-dashboard-parametertextareacontrol-parametercontrolid

source_parameter_name

The source parameter name of the ParameterTextAreaControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextareacontrol.html#cfn-quicksight-dashboard-parametertextareacontrol-sourceparametername

title

The title of the ParameterTextAreaControl .

See:

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

ParameterTextFieldControlProperty

class CfnDashboard.ParameterTextFieldControlProperty(*, parameter_control_id, source_parameter_name, title, display_options=None)

Bases: object

A control to display a text box that is used to enter a single entry.

Parameters:

  • parameter_control_id (str) – The ID of the ParameterTextFieldControl .

  • source_parameter_name (str) – The source parameter name of the ParameterTextFieldControl .

  • title (str) – The title of the ParameterTextFieldControl .

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

parameter_text_field_control_property = quicksight.CfnDashboard.ParameterTextFieldControlProperty(
    parameter_control_id="parameterControlId",
    source_parameter_name="sourceParameterName",
    title="title",

    # the properties below are optional
    display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
        info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
            info_icon_text="infoIconText",
            visibility="visibility"
        ),
        placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
            visibility="visibility"
        ),
        title_options=quicksight.CfnDashboard.LabelOptionsProperty(
            custom_label="customLabel",
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.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-dashboard-parametertextfieldcontrol.html#cfn-quicksight-dashboard-parametertextfieldcontrol-displayoptions

parameter_control_id

The ID of the ParameterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextfieldcontrol.html#cfn-quicksight-dashboard-parametertextfieldcontrol-parametercontrolid

source_parameter_name

The source parameter name of the ParameterTextFieldControl .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametertextfieldcontrol.html#cfn-quicksight-dashboard-parametertextfieldcontrol-sourceparametername

title

The title of the ParameterTextFieldControl .

See:

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

ParametersProperty

class CfnDashboard.ParametersProperty(*, date_time_parameters=None, decimal_parameters=None, integer_parameters=None, string_parameters=None)

Bases: object

A list of Amazon QuickSight parameters and the list’s override values.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

parameters_property = quicksight.CfnDashboard.ParametersProperty(
    date_time_parameters=[quicksight.CfnDashboard.DateTimeParameterProperty(
        name="name",
        values=["values"]
    )],
    decimal_parameters=[quicksight.CfnDashboard.DecimalParameterProperty(
        name="name",
        values=[123]
    )],
    integer_parameters=[quicksight.CfnDashboard.IntegerParameterProperty(
        name="name",
        values=[123]
    )],
    string_parameters=[quicksight.CfnDashboard.StringParameterProperty(
        name="name",
        values=["values"]
    )]
)

Attributes

date_time_parameters

The parameters that have a data type of date-time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html#cfn-quicksight-dashboard-parameters-datetimeparameters

decimal_parameters

The parameters that have a data type of decimal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html#cfn-quicksight-dashboard-parameters-decimalparameters

integer_parameters

The parameters that have a data type of integer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html#cfn-quicksight-dashboard-parameters-integerparameters

string_parameters

The parameters that have a data type of string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html#cfn-quicksight-dashboard-parameters-stringparameters

PercentVisibleRangeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

percent_visible_range_property = quicksight.CfnDashboard.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-dashboard-percentvisiblerange.html#cfn-quicksight-dashboard-percentvisiblerange-from

to

The top bound of the range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-percentvisiblerange.html#cfn-quicksight-dashboard-percentvisiblerange-to

PercentageDisplayFormatConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

percentage_display_format_configuration_property = quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
        decimal_places=123
    ),
    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
        display_mode="displayMode"
    ),
    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    prefix="prefix",
    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
        decimal_separator="decimalSeparator",
        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
            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-dashboard-percentagedisplayformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-percentagedisplayformatconfiguration.html#cfn-quicksight-dashboard-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-dashboard-percentagedisplayformatconfiguration.html#cfn-quicksight-dashboard-percentagedisplayformatconfiguration-nullvalueformatconfiguration

prefix

Determines the prefix value of the percentage format.

See:

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

separator_configuration

The options that determine the numeric separator configuration.

See:

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

suffix

Determines the suffix value of the percentage format.

See:

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

PercentileAggregationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

percentile_aggregation_property = quicksight.CfnDashboard.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-dashboard-percentileaggregation.html#cfn-quicksight-dashboard-percentileaggregation-percentilevalue

PeriodOverPeriodComputationProperty

class CfnDashboard.PeriodOverPeriodComputationProperty(*, computation_id, name=None, time=None, value=None)

Bases: object

The period over period computation configuration.

Parameters:

  • computation_id (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-dashboard-periodoverperiodcomputation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

period_over_period_computation_property = quicksight.CfnDashboard.PeriodOverPeriodComputationProperty(
    computation_id="computationId",

    # the properties below are optional
    name="name",
    time=quicksight.CfnDashboard.DimensionFieldProperty(
        categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            date_granularity="dateGranularity",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    ),
    value=quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                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-dashboard-periodoverperiodcomputation.html#cfn-quicksight-dashboard-periodoverperiodcomputation-computationid

name

The name of a computation.

See:

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

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodoverperiodcomputation.html#cfn-quicksight-dashboard-periodoverperiodcomputation-time

value

The value field that is used in a computation.

See:

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

PeriodToDateComputationProperty

class CfnDashboard.PeriodToDateComputationProperty(*, computation_id, name=None, period_time_granularity=None, time=None, value=None)

Bases: object

The period to date computation configuration.

Parameters:

  • computation_id (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-dashboard-periodtodatecomputation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

period_to_date_computation_property = quicksight.CfnDashboard.PeriodToDateComputationProperty(
    computation_id="computationId",

    # the properties below are optional
    name="name",
    period_time_granularity="periodTimeGranularity",
    time=quicksight.CfnDashboard.DimensionFieldProperty(
        categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            date_granularity="dateGranularity",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    ),
    value=quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                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-dashboard-periodtodatecomputation.html#cfn-quicksight-dashboard-periodtodatecomputation-computationid

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-periodtodatecomputation.html#cfn-quicksight-dashboard-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-dashboard-periodtodatecomputation.html#cfn-quicksight-dashboard-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-dashboard-periodtodatecomputation.html#cfn-quicksight-dashboard-periodtodatecomputation-time

value

The value field that is used in a computation.

See:

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

PieChartAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-piechartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-piechartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-piechartaggregatedfieldwells.html#cfn-quicksight-dashboard-piechartaggregatedfieldwells-values

PieChartConfigurationProperty

class CfnDashboard.PieChartConfigurationProperty(*, category_label_options=None, contribution_analysis_defaults=None, data_labels=None, donut_options=None, field_wells=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-dashboard-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-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-donutoptions

field_wells

The field wells of the visual.

See:

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

legend

The legend display setup of the visual.

See:

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

small_multiples_options

The small multiples setup for the visual.

See:

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

sort_configuration

The sort configuration of a pie chart.

See:

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

tooltip

The tooltip display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-piechartconfiguration.html#cfn-quicksight-dashboard-piechartconfiguration-visualpalette

PieChartFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-piechartfieldwells.html#cfn-quicksight-dashboard-piechartfieldwells-piechartaggregatedfieldwells

PieChartSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pie_chart_sort_configuration_property = quicksight.CfnDashboard.PieChartSortConfigurationProperty(
    category_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    small_multiples_limit_configuration=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    small_multiples_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-piechartsortconfiguration.html#cfn-quicksight-dashboard-piechartsortconfiguration-categoryitemslimit

category_sort

The sort configuration of the category fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-piechartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-piechartsortconfiguration.html#cfn-quicksight-dashboard-piechartsortconfiguration-smallmultiplessort

PieChartVisualProperty

class CfnDashboard.PieChartVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=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 QuickSight User Guide .

For more information, see Using donut charts in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-piechartvisual.html#cfn-quicksight-dashboard-piechartvisual-actions

chart_configuration

The configuration of a pie chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-piechartvisual.html#cfn-quicksight-dashboard-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-dashboard-piechartvisual.html#cfn-quicksight-dashboard-piechartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-piechartvisual.html#cfn-quicksight-dashboard-piechartvisual-visualid

PivotFieldSortOptionsProperty

class CfnDashboard.PivotFieldSortOptionsProperty(*, field_id, sort_by)

Bases: object

The field sort options for a pivot table sort configuration.

Parameters:

  • field_id (str) – The field ID for the field sort options.

  • sort_by (Union[IResolvable, PivotTableSortByProperty, Dict[str, Any]]) – The sort by field for the field sort options.

See:

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

pivot_field_sort_options_property = quicksight.CfnDashboard.PivotFieldSortOptionsProperty(
    field_id="fieldId",
    sort_by=quicksight.CfnDashboard.PivotTableSortByProperty(
        column=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        data_path=quicksight.CfnDashboard.DataPathSortProperty(
            direction="direction",
            sort_paths=[quicksight.CfnDashboard.DataPathValueProperty(
                data_path_type=quicksight.CfnDashboard.DataPathTypeProperty(
                    pivot_table_data_path_type="pivotTableDataPathType"
                ),
                field_id="fieldId",
                field_value="fieldValue"
            )]
        ),
        field=quicksight.CfnDashboard.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-dashboard-pivotfieldsortoptions.html#cfn-quicksight-dashboard-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-dashboard-pivotfieldsortoptions.html#cfn-quicksight-dashboard-pivotfieldsortoptions-sortby

PivotTableAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-pivottableaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-pivottableaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-pivottableaggregatedfieldwells.html#cfn-quicksight-dashboard-pivottableaggregatedfieldwells-values

PivotTableCellConditionalFormattingProperty

class CfnDashboard.PivotTableCellConditionalFormattingProperty(*, field_id, 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-dashboard-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 import aws_quicksight as quicksight

pivot_table_cell_conditional_formatting_property = quicksight.CfnDashboard.PivotTableCellConditionalFormattingProperty(
    field_id="fieldId",

    # the properties below are optional
    scope=quicksight.CfnDashboard.PivotTableConditionalFormattingScopeProperty(
        role="role"
    ),
    scopes=[quicksight.CfnDashboard.PivotTableConditionalFormattingScopeProperty(
        role="role"
    )],
    text_format=quicksight.CfnDashboard.TextConditionalFormatProperty(
        background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        ),
        icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
            custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                expression="expression",
                icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                ),

                # the properties below are optional
                color="color",
                display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                )
            ),
            icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                expression="expression",

                # the properties below are optional
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        )
    )
)

Attributes

field_id

The field ID of the cell for conditional formatting.

See:

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

scope

The scope of the cell for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablecellconditionalformatting.html#cfn-quicksight-dashboard-pivottablecellconditionalformatting-scope

scopes

A list of cell scopes for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablecellconditionalformatting.html#cfn-quicksight-dashboard-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-dashboard-pivottablecellconditionalformatting.html#cfn-quicksight-dashboard-pivottablecellconditionalformatting-textformat

PivotTableConditionalFormattingOptionProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_conditional_formatting_option_property = quicksight.CfnDashboard.PivotTableConditionalFormattingOptionProperty(
    cell=quicksight.CfnDashboard.PivotTableCellConditionalFormattingProperty(
        field_id="fieldId",

        # the properties below are optional
        scope=quicksight.CfnDashboard.PivotTableConditionalFormattingScopeProperty(
            role="role"
        ),
        scopes=[quicksight.CfnDashboard.PivotTableConditionalFormattingScopeProperty(
            role="role"
        )],
        text_format=quicksight.CfnDashboard.TextConditionalFormatProperty(
            background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            ),
            icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
                custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                    expression="expression",
                    icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    ),

                    # the properties below are optional
                    color="color",
                    display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    )
                ),
                icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                    expression="expression",

                    # the properties below are optional
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            )
        )
    )
)

Attributes

cell

The cell conditional formatting option for a pivot table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconditionalformattingoption.html#cfn-quicksight-dashboard-pivottableconditionalformattingoption-cell

PivotTableConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_conditional_formatting_property = quicksight.CfnDashboard.PivotTableConditionalFormattingProperty(
    conditional_formatting_options=[quicksight.CfnDashboard.PivotTableConditionalFormattingOptionProperty(
        cell=quicksight.CfnDashboard.PivotTableCellConditionalFormattingProperty(
            field_id="fieldId",

            # the properties below are optional
            scope=quicksight.CfnDashboard.PivotTableConditionalFormattingScopeProperty(
                role="role"
            ),
            scopes=[quicksight.CfnDashboard.PivotTableConditionalFormattingScopeProperty(
                role="role"
            )],
            text_format=quicksight.CfnDashboard.TextConditionalFormatProperty(
                background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                    gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                        color=quicksight.CfnDashboard.GradientColorProperty(
                            stops=[quicksight.CfnDashboard.GradientStopProperty(
                                gradient_offset=123,

                                # the properties below are optional
                                color="color",
                                data_value=123
                            )]
                        ),
                        expression="expression"
                    ),
                    solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                        expression="expression",

                        # the properties below are optional
                        color="color"
                    )
                ),
                icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
                    custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                        expression="expression",
                        icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                            icon="icon",
                            unicode_icon="unicodeIcon"
                        ),

                        # the properties below are optional
                        color="color",
                        display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                            icon_display_option="iconDisplayOption"
                        )
                    ),
                    icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                        expression="expression",

                        # the properties below are optional
                        icon_set_type="iconSetType"
                    )
                ),
                text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                    gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                        color=quicksight.CfnDashboard.GradientColorProperty(
                            stops=[quicksight.CfnDashboard.GradientStopProperty(
                                gradient_offset=123,

                                # the properties below are optional
                                color="color",
                                data_value=123
                            )]
                        ),
                        expression="expression"
                    ),
                    solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                        expression="expression",

                        # the properties below are optional
                        color="color"
                    )
                )
            )
        )
    )]
)

Attributes

conditional_formatting_options

Conditional formatting options for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconditionalformatting.html#cfn-quicksight-dashboard-pivottableconditionalformatting-conditionalformattingoptions

PivotTableConditionalFormattingScopeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_conditional_formatting_scope_property = quicksight.CfnDashboard.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-dashboard-pivottableconditionalformattingscope.html#cfn-quicksight-dashboard-pivottableconditionalformattingscope-role

PivotTableConfigurationProperty

class CfnDashboard.PivotTableConfigurationProperty(*, field_options=None, field_wells=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-dashboard-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-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-fieldoptions

field_wells

The field wells of the visual.

See:

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

paginated_report_options

The paginated report options for a pivot table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-paginatedreportoptions

sort_configuration

The sort configuration for a PivotTableVisual .

See:

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

table_options

The table options for a pivot table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-tableoptions

total_options

The total options for a pivot table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableconfiguration.html#cfn-quicksight-dashboard-pivottableconfiguration-totaloptions

PivotTableDataPathOptionProperty

class CfnDashboard.PivotTableDataPathOptionProperty(*, data_path_list, 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]]]]) – 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-dashboard-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 import aws_quicksight as quicksight

pivot_table_data_path_option_property = quicksight.CfnDashboard.PivotTableDataPathOptionProperty(
    data_path_list=[quicksight.CfnDashboard.DataPathValueProperty(
        data_path_type=quicksight.CfnDashboard.DataPathTypeProperty(
            pivot_table_data_path_type="pivotTableDataPathType"
        ),
        field_id="fieldId",
        field_value="fieldValue"
    )],

    # the properties below are optional
    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-dashboard-pivottabledatapathoption.html#cfn-quicksight-dashboard-pivottabledatapathoption-datapathlist

width

The width of the data path option.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabledatapathoption.html#cfn-quicksight-dashboard-pivottabledatapathoption-width

PivotTableFieldCollapseStateOptionProperty

class CfnDashboard.PivotTableFieldCollapseStateOptionProperty(*, target, state=None)

Bases: object

The collapse state options for the pivot table field options.

Parameters:

  • target (Union[IResolvable, PivotTableFieldCollapseStateTargetProperty, Dict[str, Any]]) – A tagged-union object that sets the collapse state.

  • state (Optional[str]) – The state of the field target of a pivot table. Choose one of the following options:. - COLLAPSED - EXPANDED

See:

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

pivot_table_field_collapse_state_option_property = quicksight.CfnDashboard.PivotTableFieldCollapseStateOptionProperty(
    target=quicksight.CfnDashboard.PivotTableFieldCollapseStateTargetProperty(
        field_data_path_values=[quicksight.CfnDashboard.DataPathValueProperty(
            data_path_type=quicksight.CfnDashboard.DataPathTypeProperty(
                pivot_table_data_path_type="pivotTableDataPathType"
            ),
            field_id="fieldId",
            field_value="fieldValue"
        )],
        field_id="fieldId"
    ),

    # the properties below are optional
    state="state"
)

Attributes

state

.

  • COLLAPSED

  • EXPANDED

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablefieldcollapsestateoption.html#cfn-quicksight-dashboard-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-dashboard-pivottablefieldcollapsestateoption.html#cfn-quicksight-dashboard-pivottablefieldcollapsestateoption-target

PivotTableFieldCollapseStateTargetProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_field_collapse_state_target_property = quicksight.CfnDashboard.PivotTableFieldCollapseStateTargetProperty(
    field_data_path_values=[quicksight.CfnDashboard.DataPathValueProperty(
        data_path_type=quicksight.CfnDashboard.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-dashboard-pivottablefieldcollapsestatetarget.html#cfn-quicksight-dashboard-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-dashboard-pivottablefieldcollapsestatetarget.html#cfn-quicksight-dashboard-pivottablefieldcollapsestatetarget-fieldid

PivotTableFieldOptionProperty

class CfnDashboard.PivotTableFieldOptionProperty(*, field_id, custom_label=None, visibility=None)

Bases: object

The selected field options for the pivot table field options.

Parameters:

  • field_id (str) – The field ID of the pivot table field.

  • custom_label (Optional[str]) – The custom label 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-dashboard-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 import aws_quicksight as quicksight

pivot_table_field_option_property = quicksight.CfnDashboard.PivotTableFieldOptionProperty(
    field_id="fieldId",

    # the properties below are optional
    custom_label="customLabel",
    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-dashboard-pivottablefieldoption.html#cfn-quicksight-dashboard-pivottablefieldoption-customlabel

field_id

The field ID of the pivot table field.

See:

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

visibility

The visibility of the pivot table field.

See:

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

PivotTableFieldOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_field_options_property = quicksight.CfnDashboard.PivotTableFieldOptionsProperty(
    collapse_state_options=[quicksight.CfnDashboard.PivotTableFieldCollapseStateOptionProperty(
        target=quicksight.CfnDashboard.PivotTableFieldCollapseStateTargetProperty(
            field_data_path_values=[quicksight.CfnDashboard.DataPathValueProperty(
                data_path_type=quicksight.CfnDashboard.DataPathTypeProperty(
                    pivot_table_data_path_type="pivotTableDataPathType"
                ),
                field_id="fieldId",
                field_value="fieldValue"
            )],
            field_id="fieldId"
        ),

        # the properties below are optional
        state="state"
    )],
    data_path_options=[quicksight.CfnDashboard.PivotTableDataPathOptionProperty(
        data_path_list=[quicksight.CfnDashboard.DataPathValueProperty(
            data_path_type=quicksight.CfnDashboard.DataPathTypeProperty(
                pivot_table_data_path_type="pivotTableDataPathType"
            ),
            field_id="fieldId",
            field_value="fieldValue"
        )],

        # the properties below are optional
        width="width"
    )],
    selected_field_options=[quicksight.CfnDashboard.PivotTableFieldOptionProperty(
        field_id="fieldId",

        # the properties below are optional
        custom_label="customLabel",
        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-dashboard-pivottablefieldoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottablefieldoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottablefieldoptions.html#cfn-quicksight-dashboard-pivottablefieldoptions-selectedfieldoptions

PivotTableFieldSubtotalOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_field_subtotal_options_property = quicksight.CfnDashboard.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-dashboard-pivottablefieldsubtotaloptions.html#cfn-quicksight-dashboard-pivottablefieldsubtotaloptions-fieldid

PivotTableFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-pivottablefieldwells.html#cfn-quicksight-dashboard-pivottablefieldwells-pivottableaggregatedfieldwells

PivotTableOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_options_property = quicksight.CfnDashboard.PivotTableOptionsProperty(
    cell_style=quicksight.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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.CfnDashboard.RowAlternateColorOptionsProperty(
        row_alternate_colors=["rowAlternateColors"],
        status="status",
        use_primary_background_color="usePrimaryBackgroundColor"
    ),
    row_field_names_style=quicksight.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    row_header_style=quicksight.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    rows_label_options=quicksight.CfnDashboard.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-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-columnheaderstyle

column_names_visibility

The visibility of the column names.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-defaultcellwidth

metric_placement

The metric placement (row, column) options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-rowslayout

single_metric_visibility

The visibility of the single metric options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-singlemetricvisibility

toggle_buttons_visibility

Determines the visibility of the pivot table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottableoptions.html#cfn-quicksight-dashboard-pivottableoptions-togglebuttonsvisibility

PivotTablePaginatedReportOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_paginated_report_options_property = quicksight.CfnDashboard.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-dashboard-pivottablepaginatedreportoptions.html#cfn-quicksight-dashboard-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-dashboard-pivottablepaginatedreportoptions.html#cfn-quicksight-dashboard-pivottablepaginatedreportoptions-verticaloverflowvisibility

PivotTableRowsLabelOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_rows_label_options_property = quicksight.CfnDashboard.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-dashboard-pivottablerowslabeloptions.html#cfn-quicksight-dashboard-pivottablerowslabeloptions-customlabel

visibility

The visibility of the rows label.

See:

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

PivotTableSortByProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_sort_by_property = quicksight.CfnDashboard.PivotTableSortByProperty(
    column=quicksight.CfnDashboard.ColumnSortProperty(
        direction="direction",
        sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),

        # the properties below are optional
        aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        )
    ),
    data_path=quicksight.CfnDashboard.DataPathSortProperty(
        direction="direction",
        sort_paths=[quicksight.CfnDashboard.DataPathValueProperty(
            data_path_type=quicksight.CfnDashboard.DataPathTypeProperty(
                pivot_table_data_path_type="pivotTableDataPathType"
            ),
            field_id="fieldId",
            field_value="fieldValue"
        )]
    ),
    field=quicksight.CfnDashboard.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-dashboard-pivottablesortby.html#cfn-quicksight-dashboard-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-dashboard-pivottablesortby.html#cfn-quicksight-dashboard-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-dashboard-pivottablesortby.html#cfn-quicksight-dashboard-pivottablesortby-field

PivotTableSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_table_sort_configuration_property = quicksight.CfnDashboard.PivotTableSortConfigurationProperty(
    field_sort_options=[quicksight.CfnDashboard.PivotFieldSortOptionsProperty(
        field_id="fieldId",
        sort_by=quicksight.CfnDashboard.PivotTableSortByProperty(
            column=quicksight.CfnDashboard.ColumnSortProperty(
                direction="direction",
                sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),

                # the properties below are optional
                aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                    attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                        simple_attribute_aggregation="simpleAttributeAggregation",
                        value_for_multiple_values="valueForMultipleValues"
                    ),
                    categorical_aggregation_function="categoricalAggregationFunction",
                    date_aggregation_function="dateAggregationFunction",
                    numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                        percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                            percentile_value=123
                        ),
                        simple_numerical_aggregation="simpleNumericalAggregation"
                    )
                )
            ),
            data_path=quicksight.CfnDashboard.DataPathSortProperty(
                direction="direction",
                sort_paths=[quicksight.CfnDashboard.DataPathValueProperty(
                    data_path_type=quicksight.CfnDashboard.DataPathTypeProperty(
                        pivot_table_data_path_type="pivotTableDataPathType"
                    ),
                    field_id="fieldId",
                    field_value="fieldValue"
                )]
            ),
            field=quicksight.CfnDashboard.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-dashboard-pivottablesortconfiguration.html#cfn-quicksight-dashboard-pivottablesortconfiguration-fieldsortoptions

PivotTableTotalOptionsProperty

class CfnDashboard.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-dashboard-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-dashboard-pivottabletotaloptions.html#cfn-quicksight-dashboard-pivottabletotaloptions-columnsubtotaloptions

column_total_options

The column total options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabletotaloptions.html#cfn-quicksight-dashboard-pivottabletotaloptions-columntotaloptions

row_subtotal_options

The row subtotal options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabletotaloptions.html#cfn-quicksight-dashboard-pivottabletotaloptions-rowsubtotaloptions

row_total_options

The row total options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottabletotaloptions.html#cfn-quicksight-dashboard-pivottabletotaloptions-rowtotaloptions

PivotTableVisualProperty

class CfnDashboard.PivotTableVisualProperty(*, visual_id, actions=None, chart_configuration=None, conditional_formatting=None, subtitle=None, title=None)

Bases: object

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-pivottablevisual.html#cfn-quicksight-dashboard-pivottablevisual-actions

chart_configuration

The configuration settings of the visual.

See:

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

conditional_formatting

The conditional formatting for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottablevisual.html#cfn-quicksight-dashboard-pivottablevisual-conditionalformatting

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-pivottablevisual.html#cfn-quicksight-dashboard-pivottablevisual-visualid

PivotTotalOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

pivot_total_options_property = quicksight.CfnDashboard.PivotTotalOptionsProperty(
    custom_label="customLabel",
    metric_header_cell_style=quicksight.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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.CfnDashboard.TotalAggregationOptionProperty(
        field_id="fieldId",
        total_aggregation_function=quicksight.CfnDashboard.TotalAggregationFunctionProperty(
            simple_total_aggregation_function="simpleTotalAggregationFunction"
        )
    )],
    total_cell_style=quicksight.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-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-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-metricheadercellstyle

placement

The placement (start, end) for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-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-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-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-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-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-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-totalcellstyle

totals_visibility

The visibility configuration for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-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-dashboard-pivottotaloptions.html#cfn-quicksight-dashboard-pivottotaloptions-valuecellstyle

PredefinedHierarchyProperty

class CfnDashboard.PredefinedHierarchyProperty(*, columns, hierarchy_id, drill_down_filters=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-dashboard-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 import aws_quicksight as quicksight

predefined_hierarchy_property = quicksight.CfnDashboard.PredefinedHierarchyProperty(
    columns=[quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    )],
    hierarchy_id="hierarchyId",

    # the properties below are optional
    drill_down_filters=[quicksight.CfnDashboard.DrillDownFilterProperty(
        category_filter=quicksight.CfnDashboard.CategoryDrillDownFilterProperty(
            category_values=["categoryValues"],
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        numeric_equality_filter=quicksight.CfnDashboard.NumericEqualityDrillDownFilterProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            value=123
        ),
        time_range_filter=quicksight.CfnDashboard.TimeRangeDrillDownFilterProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            range_maximum="rangeMaximum",
            range_minimum="rangeMinimum",
            time_granularity="timeGranularity"
        )
    )]
)

Attributes

columns

The list of columns that define the predefined hierarchy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-predefinedhierarchy.html#cfn-quicksight-dashboard-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-dashboard-predefinedhierarchy.html#cfn-quicksight-dashboard-predefinedhierarchy-drilldownfilters

hierarchy_id

The hierarchy ID of the predefined hierarchy.

See:

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

ProgressBarOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

progress_bar_options_property = quicksight.CfnDashboard.ProgressBarOptionsProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility of the progress bar.

See:

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

RadarChartAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-radarchartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-radarchartaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-radarchartaggregatedfieldwells.html#cfn-quicksight-dashboard-radarchartaggregatedfieldwells-values

RadarChartAreaStyleSettingsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

radar_chart_area_style_settings_property = quicksight.CfnDashboard.RadarChartAreaStyleSettingsProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility settings of a radar chart.

See:

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

RadarChartConfigurationProperty

class CfnDashboard.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, 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 .

  • 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-dashboard-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-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-baseseriessettings

category_axis

The category axis of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-categorylabeloptions

color_axis

The color axis of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-colorlabeloptions

field_wells

The field well configuration of a RadarChartVisual .

See:

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

legend

The legend display setup of the visual.

See:

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

shape

The shape of the radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-shape

sort_configuration

The sort configuration of a RadarChartVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-radarchartconfiguration.html#cfn-quicksight-dashboard-radarchartconfiguration-visualpalette

RadarChartFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-radarchartfieldwells.html#cfn-quicksight-dashboard-radarchartfieldwells-radarchartaggregatedfieldwells

RadarChartSeriesSettingsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

radar_chart_series_settings_property = quicksight.CfnDashboard.RadarChartSeriesSettingsProperty(
    area_style_settings=quicksight.CfnDashboard.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-dashboard-radarchartseriessettings.html#cfn-quicksight-dashboard-radarchartseriessettings-areastylesettings

RadarChartSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

radar_chart_sort_configuration_property = quicksight.CfnDashboard.RadarChartSortConfigurationProperty(
    category_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.FieldSortProperty(
            direction="direction",
            field_id="fieldId"
        )
    )],
    color_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    color_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-radarchartsortconfiguration.html#cfn-quicksight-dashboard-radarchartsortconfiguration-categoryitemslimit

category_sort

The category sort options of a radar chart.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-radarchartsortconfiguration.html#cfn-quicksight-dashboard-radarchartsortconfiguration-coloritemslimit

color_sort

The color sort configuration of a radar chart.

See:

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

RadarChartVisualProperty

class CfnDashboard.RadarChartVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None)

Bases: object

A radar chart visual.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-radarchartvisual-actions

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-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-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-radarchartvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-radarchartvisual.html#cfn-quicksight-dashboard-radarchartvisual-visualid

RangeEndsLabelTypeProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

range_ends_label_type_property = quicksight.CfnDashboard.RangeEndsLabelTypeProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility of the range ends label.

See:

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

ReferenceLineCustomLabelConfigurationProperty

class CfnDashboard.ReferenceLineCustomLabelConfigurationProperty(*, custom_label)

Bases: object

The configuration for a custom label on a ReferenceLine .

Parameters:

custom_label (str) – The string text of the custom label.

See:

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

reference_line_custom_label_configuration_property = quicksight.CfnDashboard.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-dashboard-referencelinecustomlabelconfiguration.html#cfn-quicksight-dashboard-referencelinecustomlabelconfiguration-customlabel

ReferenceLineDataConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

reference_line_data_configuration_property = quicksight.CfnDashboard.ReferenceLineDataConfigurationProperty(
    axis_binding="axisBinding",
    dynamic_configuration=quicksight.CfnDashboard.ReferenceLineDynamicDataConfigurationProperty(
        calculation=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        ),
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),

        # the properties below are optional
        measure_aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        )
    ),
    series_type="seriesType",
    static_configuration=quicksight.CfnDashboard.ReferenceLineStaticDataConfigurationProperty(
        value=123
    )
)

Attributes

axis_binding

.

  • PrimaryY

  • SecondaryY

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedataconfiguration.html#cfn-quicksight-dashboard-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-dashboard-referencelinedataconfiguration.html#cfn-quicksight-dashboard-referencelinedataconfiguration-dynamicconfiguration

series_type

.

  • BAR

  • LINE

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedataconfiguration.html#cfn-quicksight-dashboard-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-dashboard-referencelinedataconfiguration.html#cfn-quicksight-dashboard-referencelinedataconfiguration-staticconfiguration

ReferenceLineDynamicDataConfigurationProperty

class CfnDashboard.ReferenceLineDynamicDataConfigurationProperty(*, calculation, column, 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-dashboard-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 import aws_quicksight as quicksight

reference_line_dynamic_data_configuration_property = quicksight.CfnDashboard.ReferenceLineDynamicDataConfigurationProperty(
    calculation=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
        percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
            percentile_value=123
        ),
        simple_numerical_aggregation="simpleNumericalAggregation"
    ),
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),

    # the properties below are optional
    measure_aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight.CfnDashboard.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-dashboard-referencelinedynamicdataconfiguration.html#cfn-quicksight-dashboard-referencelinedynamicdataconfiguration-calculation

column

The column that the dynamic data targets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinedynamicdataconfiguration.html#cfn-quicksight-dashboard-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-dashboard-referencelinedynamicdataconfiguration.html#cfn-quicksight-dashboard-referencelinedynamicdataconfiguration-measureaggregationfunction

ReferenceLineLabelConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

reference_line_label_configuration_property = quicksight.CfnDashboard.ReferenceLineLabelConfigurationProperty(
    custom_label_configuration=quicksight.CfnDashboard.ReferenceLineCustomLabelConfigurationProperty(
        custom_label="customLabel"
    ),
    font_color="fontColor",
    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.FontWeightProperty(
            name="name"
        )
    ),
    horizontal_position="horizontalPosition",
    value_label_configuration=quicksight.CfnDashboard.ReferenceLineValueLabelConfigurationProperty(
        format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
            currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix",
                symbol="symbol"
            ),
            number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                number_scale="numberScale",
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        symbol="symbol",
                        visibility="visibility"
                    )
                ),
                suffix="suffix"
            ),
            percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                    decimal_places=123
                ),
                negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                    display_mode="displayMode"
                ),
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                prefix="prefix",
                separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                    decimal_separator="decimalSeparator",
                    thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                        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-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-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-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-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-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-referencelinelabelconfiguration-fontconfiguration

horizontal_position

.

  • LEFT

  • CENTER

  • RIGHT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-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-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-referencelinelabelconfiguration-valuelabelconfiguration

vertical_position

.

  • ABOVE

  • BELOW

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinelabelconfiguration.html#cfn-quicksight-dashboard-referencelinelabelconfiguration-verticalposition

Type:

The vertical position configuration of the label in a reference line. Choose one of the following options

ReferenceLineProperty

class CfnDashboard.ReferenceLineProperty(*, data_configuration, 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-dashboard-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 import aws_quicksight as quicksight

reference_line_property = quicksight.CfnDashboard.ReferenceLineProperty(
    data_configuration=quicksight.CfnDashboard.ReferenceLineDataConfigurationProperty(
        axis_binding="axisBinding",
        dynamic_configuration=quicksight.CfnDashboard.ReferenceLineDynamicDataConfigurationProperty(
            calculation=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            measure_aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        series_type="seriesType",
        static_configuration=quicksight.CfnDashboard.ReferenceLineStaticDataConfigurationProperty(
            value=123
        )
    ),

    # the properties below are optional
    label_configuration=quicksight.CfnDashboard.ReferenceLineLabelConfigurationProperty(
        custom_label_configuration=quicksight.CfnDashboard.ReferenceLineCustomLabelConfigurationProperty(
            custom_label="customLabel"
        ),
        font_color="fontColor",
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                name="name"
            )
        ),
        horizontal_position="horizontalPosition",
        value_label_configuration=quicksight.CfnDashboard.ReferenceLineValueLabelConfigurationProperty(
            format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            ),
            relative_position="relativePosition"
        ),
        vertical_position="verticalPosition"
    ),
    status="status",
    style_configuration=quicksight.CfnDashboard.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-dashboard-referenceline.html#cfn-quicksight-dashboard-referenceline-dataconfiguration

label_configuration

The label configuration of the reference line.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referenceline.html#cfn-quicksight-dashboard-referenceline-labelconfiguration

status

.

  • ENABLE

  • DISABLE

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referenceline.html#cfn-quicksight-dashboard-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-dashboard-referenceline.html#cfn-quicksight-dashboard-referenceline-styleconfiguration

ReferenceLineStaticDataConfigurationProperty

class CfnDashboard.ReferenceLineStaticDataConfigurationProperty(*, value)

Bases: object

The static data configuration of the reference line data configuration.

Parameters:

value (Union[int, float]) – The double input of the static data. Default: - 0

See:

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

reference_line_static_data_configuration_property = quicksight.CfnDashboard.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-dashboard-referencelinestaticdataconfiguration.html#cfn-quicksight-dashboard-referencelinestaticdataconfiguration-value

ReferenceLineStyleConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

reference_line_style_configuration_property = quicksight.CfnDashboard.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-dashboard-referencelinestyleconfiguration.html#cfn-quicksight-dashboard-referencelinestyleconfiguration-color

pattern

.

  • SOLID

  • DASHED

  • DOTTED

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinestyleconfiguration.html#cfn-quicksight-dashboard-referencelinestyleconfiguration-pattern

Type:

The pattern type of the line style. Choose one of the following options

ReferenceLineValueLabelConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

reference_line_value_label_configuration_property = quicksight.CfnDashboard.ReferenceLineValueLabelConfigurationProperty(
    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix",
            symbol="symbol"
        ),
        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    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-dashboard-referencelinevaluelabelconfiguration.html#cfn-quicksight-dashboard-referencelinevaluelabelconfiguration-formatconfiguration

relative_position

.

  • BEFORE_CUSTOM_LABEL

  • AFTER_CUSTOM_LABEL

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-referencelinevaluelabelconfiguration.html#cfn-quicksight-dashboard-referencelinevaluelabelconfiguration-relativeposition

Type:

The relative position of the value label. Choose one of the following options

RelativeDateTimeControlDisplayOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

relative_date_time_control_display_options_property = quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
    date_time_format="dateTimeFormat",
    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-relativedatetimecontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-relativedatetimecontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-relativedatetimecontroldisplayoptions.html#cfn-quicksight-dashboard-relativedatetimecontroldisplayoptions-titleoptions

RelativeDatesFilterProperty

class CfnDashboard.RelativeDatesFilterProperty(*, anchor_date_configuration, column, filter_id, null_option, relative_date_type, time_granularity, default_filter_control_configuration=None, exclude_period_configuration=None, minimum_granularity=None, parameter_name=None, relative_date_value=None)

Bases: object

A RelativeDatesFilter filters relative dates values.

Parameters:

  • anchor_date_configuration (Union[IResolvable, AnchorDateConfigurationProperty, Dict[str, Any]]) – The date configuration of the filter.

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

  • filter_id (str) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • null_option (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.

  • relative_date_type (str) – The range date type of the filter. Choose one of the options below:. - PREVIOUS - THIS - LAST - NOW - NEXT

  • time_granularity (str) – The level of time precision that is used to aggregate DateTime values.

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

  • minimum_granularity (Optional[str]) – The minimum granularity (period granularity) of the relative dates filter.

  • parameter_name (Optional[str]) – The parameter whose value should be used for the filter value.

  • relative_date_value (Union[int, float, None]) – The date value of the filter.

See:

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

relative_dates_filter_property = quicksight.CfnDashboard.RelativeDatesFilterProperty(
    anchor_date_configuration=quicksight.CfnDashboard.AnchorDateConfigurationProperty(
        anchor_option="anchorOption",
        parameter_name="parameterName"
    ),
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    filter_id="filterId",
    null_option="nullOption",
    relative_date_type="relativeDateType",
    time_granularity="timeGranularity",

    # the properties below are optional
    default_filter_control_configuration=quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
        control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
                display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
                maximum_value=123,
                minimum_value=123,
                step_size=123,

                # the properties below are optional
                display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    exclude_period_configuration=quicksight.CfnDashboard.ExcludePeriodConfigurationProperty(
        amount=123,
        granularity="granularity",

        # the properties below are optional
        status="status"
    ),
    minimum_granularity="minimumGranularity",
    parameter_name="parameterName",
    relative_date_value=123
)

Attributes

anchor_date_configuration

The date configuration of the filter.

See:

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

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-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-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-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-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-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-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-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-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-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-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-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-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-parametername

relative_date_type

.

  • PREVIOUS

  • THIS

  • LAST

  • NOW

  • NEXT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-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-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-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-dashboard-relativedatesfilter.html#cfn-quicksight-dashboard-relativedatesfilter-timegranularity

ResourcePermissionProperty

class CfnDashboard.ResourcePermissionProperty(*, actions, principal, resource=None)

Bases: object

Permission for the resource.

Parameters:

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

  • principal (str) – The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

  • resource (Optional[str]) –

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

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

    # the properties below are optional
    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-dashboard-resourcepermission.html#cfn-quicksight-dashboard-resourcepermission-actions

principal

.

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

  • The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

  • The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-resourcepermission.html#cfn-quicksight-dashboard-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-dashboard-resourcepermission.html#cfn-quicksight-dashboard-resourcepermission-resource

Type:

see

RollingDateConfigurationProperty

class CfnDashboard.RollingDateConfigurationProperty(*, expression, data_set_identifier=None)

Bases: object

The rolling date configuration of a date time filter.

Parameters:

  • expression (str) – The expression of the rolling date configuration.

  • data_set_identifier (Optional[str]) – The data set that is used in the rolling date configuration.

See:

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

rolling_date_configuration_property = quicksight.CfnDashboard.RollingDateConfigurationProperty(
    expression="expression",

    # the properties below are optional
    data_set_identifier="dataSetIdentifier"
)

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-dashboard-rollingdateconfiguration.html#cfn-quicksight-dashboard-rollingdateconfiguration-datasetidentifier

expression

The expression of the rolling date configuration.

See:

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

RowAlternateColorOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

row_alternate_color_options_property = quicksight.CfnDashboard.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-dashboard-rowalternatecoloroptions.html#cfn-quicksight-dashboard-rowalternatecoloroptions-rowalternatecolors

status

Determines the widget status.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-rowalternatecoloroptions.html#cfn-quicksight-dashboard-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-dashboard-rowalternatecoloroptions.html#cfn-quicksight-dashboard-rowalternatecoloroptions-useprimarybackgroundcolor

SameSheetTargetVisualConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

same_sheet_target_visual_configuration_property = quicksight.CfnDashboard.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-dashboard-samesheettargetvisualconfiguration.html#cfn-quicksight-dashboard-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-dashboard-samesheettargetvisualconfiguration.html#cfn-quicksight-dashboard-samesheettargetvisualconfiguration-targetvisuals

SankeyDiagramAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-dashboard-sankeydiagramaggregatedfieldwells-destination

source

The source field wells of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-dashboard-sankeydiagramaggregatedfieldwells-source

weight

The weight field wells of a sankey diagram.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramaggregatedfieldwells.html#cfn-quicksight-dashboard-sankeydiagramaggregatedfieldwells-weight

SankeyDiagramChartConfigurationProperty

class CfnDashboard.SankeyDiagramChartConfigurationProperty(*, data_labels=None, field_wells=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-dashboard-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-dashboard-sankeydiagramchartconfiguration.html#cfn-quicksight-dashboard-sankeydiagramchartconfiguration-datalabels

field_wells

The field well configuration of a sankey diagram.

See:

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

sort_configuration

The sort configuration of a sankey diagram.

See:

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

SankeyDiagramFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-sankeydiagramfieldwells.html#cfn-quicksight-dashboard-sankeydiagramfieldwells-sankeydiagramaggregatedfieldwells

SankeyDiagramSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

sankey_diagram_sort_configuration_property = quicksight.CfnDashboard.SankeyDiagramSortConfigurationProperty(
    destination_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    source_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    weight_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-sankeydiagramsortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-sankeydiagramsortconfiguration.html#cfn-quicksight-dashboard-sankeydiagramsortconfiguration-sourceitemslimit

weight_sort

The sort configuration of the weight fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sankeydiagramsortconfiguration.html#cfn-quicksight-dashboard-sankeydiagramsortconfiguration-weightsort

SankeyDiagramVisualProperty

class CfnDashboard.SankeyDiagramVisualProperty(*, visual_id, actions=None, chart_configuration=None, subtitle=None, title=None)

Bases: object

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-sankeydiagramvisual.html#cfn-quicksight-dashboard-sankeydiagramvisual-actions

chart_configuration

The configuration of a sankey diagram.

See:

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

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-sankeydiagramvisual.html#cfn-quicksight-dashboard-sankeydiagramvisual-visualid

ScatterPlotCategoricallyAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells-category

label

The label field well of a scatter plot.

See:

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

size

The size field well of a scatter plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-scatterplotcategoricallyaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotcategoricallyaggregatedfieldwells-yaxis

ScatterPlotConfigurationProperty

class CfnDashboard.ScatterPlotConfigurationProperty(*, data_labels=None, field_wells=None, legend=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-dashboard-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-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-datalabels

field_wells

The field wells of the visual.

See:

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

legend

The legend display setup of the visual.

See:

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

tooltip

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-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-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-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-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-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-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-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-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-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-dashboard-scatterplotconfiguration.html#cfn-quicksight-dashboard-scatterplotconfiguration-yaxislabeloptions

ScatterPlotFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-scatterplotfieldwells.html#cfn-quicksight-dashboard-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-dashboard-scatterplotfieldwells.html#cfn-quicksight-dashboard-scatterplotfieldwells-scatterplotunaggregatedfieldwells

ScatterPlotUnaggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-scatterplotunaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotunaggregatedfieldwells-category

label

The label field well of a scatter plot.

See:

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

size

The size field well of a scatter plot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotunaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-scatterplotunaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-scatterplotunaggregatedfieldwells.html#cfn-quicksight-dashboard-scatterplotunaggregatedfieldwells-yaxis

ScatterPlotVisualProperty

class CfnDashboard.ScatterPlotVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None)

Bases: object

A scatter plot.

For more information, see Using scatter plots in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-scatterplotvisual-actions

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-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-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-scatterplotvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-scatterplotvisual.html#cfn-quicksight-dashboard-scatterplotvisual-visualid

ScrollBarOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

scroll_bar_options_property = quicksight.CfnDashboard.ScrollBarOptionsProperty(
    visibility="visibility",
    visible_range=quicksight.CfnDashboard.VisibleRangeOptionsProperty(
        percent_range=quicksight.CfnDashboard.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-dashboard-scrollbaroptions.html#cfn-quicksight-dashboard-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-dashboard-scrollbaroptions.html#cfn-quicksight-dashboard-scrollbaroptions-visiblerange

SecondaryValueOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

secondary_value_options_property = quicksight.CfnDashboard.SecondaryValueOptionsProperty(
    visibility="visibility"
)

Attributes

visibility

Determines the visibility of the secondary value.

See:

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

SectionAfterPageBreakProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

section_after_page_break_property = quicksight.CfnDashboard.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-dashboard-sectionafterpagebreak.html#cfn-quicksight-dashboard-sectionafterpagebreak-status

SectionBasedLayoutCanvasSizeOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

section_based_layout_canvas_size_options_property = quicksight.CfnDashboard.SectionBasedLayoutCanvasSizeOptionsProperty(
    paper_canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
        paper_margin=quicksight.CfnDashboard.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-dashboard-sectionbasedlayoutcanvassizeoptions.html#cfn-quicksight-dashboard-sectionbasedlayoutcanvassizeoptions-papercanvassizeoptions

SectionBasedLayoutConfigurationProperty

class CfnDashboard.SectionBasedLayoutConfigurationProperty(*, body_sections, canvas_size_options, footer_sections, header_sections)

Bases: object

The configuration for a section-based layout.

Parameters:
See:

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

section_based_layout_configuration_property = quicksight.CfnDashboard.SectionBasedLayoutConfigurationProperty(
    body_sections=[quicksight.CfnDashboard.BodySectionConfigurationProperty(
        content=quicksight.CfnDashboard.BodySectionContentProperty(
            layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
                free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
                    elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                        element_id="elementId",
                        element_type="elementType",
                        height="height",
                        width="width",
                        x_axis_location="xAxisLocation",
                        y_axis_location="yAxisLocation",

                        # the properties below are optional
                        background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                            visibility="visibility"
                        ),
                        rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                            configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                                visibility="visibility"
                            ),
                            expression="expression"
                        )],
                        selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                            color="color",
                            visibility="visibility"
                        ),
                        visibility="visibility"
                    )]
                )
            )
        ),
        section_id="sectionId",

        # the properties below are optional
        page_break_configuration=quicksight.CfnDashboard.SectionPageBreakConfigurationProperty(
            after=quicksight.CfnDashboard.SectionAfterPageBreakProperty(
                status="status"
            )
        ),
        style=quicksight.CfnDashboard.SectionStyleProperty(
            height="height",
            padding=quicksight.CfnDashboard.SpacingProperty(
                bottom="bottom",
                left="left",
                right="right",
                top="top"
            )
        )
    )],
    canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutCanvasSizeOptionsProperty(
        paper_canvas_size_options=quicksight.CfnDashboard.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
            paper_margin=quicksight.CfnDashboard.SpacingProperty(
                bottom="bottom",
                left="left",
                right="right",
                top="top"
            ),
            paper_orientation="paperOrientation",
            paper_size="paperSize"
        )
    ),
    footer_sections=[quicksight.CfnDashboard.HeaderFooterSectionConfigurationProperty(
        layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
            free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
                elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                    element_id="elementId",
                    element_type="elementType",
                    height="height",
                    width="width",
                    x_axis_location="xAxisLocation",
                    y_axis_location="yAxisLocation",

                    # the properties below are optional
                    background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                        visibility="visibility"
                    ),
                    rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                        configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                            visibility="visibility"
                        ),
                        expression="expression"
                    )],
                    selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    visibility="visibility"
                )]
            )
        ),
        section_id="sectionId",

        # the properties below are optional
        style=quicksight.CfnDashboard.SectionStyleProperty(
            height="height",
            padding=quicksight.CfnDashboard.SpacingProperty(
                bottom="bottom",
                left="left",
                right="right",
                top="top"
            )
        )
    )],
    header_sections=[quicksight.CfnDashboard.HeaderFooterSectionConfigurationProperty(
        layout=quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
            free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
                elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
                    element_id="elementId",
                    element_type="elementType",
                    height="height",
                    width="width",
                    x_axis_location="xAxisLocation",
                    y_axis_location="yAxisLocation",

                    # the properties below are optional
                    background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                        visibility="visibility"
                    ),
                    rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                        configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                            visibility="visibility"
                        ),
                        expression="expression"
                    )],
                    selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                        color="color",
                        visibility="visibility"
                    ),
                    visibility="visibility"
                )]
            )
        ),
        section_id="sectionId",

        # the properties below are optional
        style=quicksight.CfnDashboard.SectionStyleProperty(
            height="height",
            padding=quicksight.CfnDashboard.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-dashboard-sectionbasedlayoutconfiguration.html#cfn-quicksight-dashboard-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-dashboard-sectionbasedlayoutconfiguration.html#cfn-quicksight-dashboard-sectionbasedlayoutconfiguration-canvassizeoptions

footer_sections

A list of footer section configurations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutconfiguration.html#cfn-quicksight-dashboard-sectionbasedlayoutconfiguration-footersections

header_sections

A list of header section configurations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutconfiguration.html#cfn-quicksight-dashboard-sectionbasedlayoutconfiguration-headersections

SectionBasedLayoutPaperCanvasSizeOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

section_based_layout_paper_canvas_size_options_property = quicksight.CfnDashboard.SectionBasedLayoutPaperCanvasSizeOptionsProperty(
    paper_margin=quicksight.CfnDashboard.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-dashboard-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions-papermargin

paper_orientation

.

  • PORTRAIT

  • LANDSCAPE

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-dashboard-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-dashboard-sectionbasedlayoutpapercanvassizeoptions.html#cfn-quicksight-dashboard-sectionbasedlayoutpapercanvassizeoptions-papersize

SectionLayoutConfigurationProperty

class CfnDashboard.SectionLayoutConfigurationProperty(*, free_form_layout)

Bases: object

The layout configuration of a section.

Parameters:

free_form_layout (Union[IResolvable, FreeFormSectionLayoutConfigurationProperty, Dict[str, Any]]) – The free-form layout configuration of a section.

See:

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

section_layout_configuration_property = quicksight.CfnDashboard.SectionLayoutConfigurationProperty(
    free_form_layout=quicksight.CfnDashboard.FreeFormSectionLayoutConfigurationProperty(
        elements=[quicksight.CfnDashboard.FreeFormLayoutElementProperty(
            element_id="elementId",
            element_type="elementType",
            height="height",
            width="width",
            x_axis_location="xAxisLocation",
            y_axis_location="yAxisLocation",

            # the properties below are optional
            background_style=quicksight.CfnDashboard.FreeFormLayoutElementBackgroundStyleProperty(
                color="color",
                visibility="visibility"
            ),
            border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                color="color",
                visibility="visibility"
            ),
            loading_animation=quicksight.CfnDashboard.LoadingAnimationProperty(
                visibility="visibility"
            ),
            rendering_rules=[quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
                configuration_overrides=quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
                    visibility="visibility"
                ),
                expression="expression"
            )],
            selected_border_style=quicksight.CfnDashboard.FreeFormLayoutElementBorderStyleProperty(
                color="color",
                visibility="visibility"
            ),
            visibility="visibility"
        )]
    )
)

Attributes

free_form_layout

The free-form layout configuration of a section.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sectionlayoutconfiguration.html#cfn-quicksight-dashboard-sectionlayoutconfiguration-freeformlayout

SectionPageBreakConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

section_page_break_configuration_property = quicksight.CfnDashboard.SectionPageBreakConfigurationProperty(
    after=quicksight.CfnDashboard.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-dashboard-sectionpagebreakconfiguration.html#cfn-quicksight-dashboard-sectionpagebreakconfiguration-after

SectionStyleProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

section_style_property = quicksight.CfnDashboard.SectionStyleProperty(
    height="height",
    padding=quicksight.CfnDashboard.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-dashboard-sectionstyle.html#cfn-quicksight-dashboard-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-dashboard-sectionstyle.html#cfn-quicksight-dashboard-sectionstyle-padding

SelectedSheetsFilterScopeConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

selected_sheets_filter_scope_configuration_property = quicksight.CfnDashboard.SelectedSheetsFilterScopeConfigurationProperty(
    sheet_visual_scoping_configurations=[quicksight.CfnDashboard.SheetVisualScopingConfigurationProperty(
        scope="scope",
        sheet_id="sheetId",

        # the properties below are optional
        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-dashboard-selectedsheetsfilterscopeconfiguration.html#cfn-quicksight-dashboard-selectedsheetsfilterscopeconfiguration-sheetvisualscopingconfigurations

SeriesItemProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

series_item_property = quicksight.CfnDashboard.SeriesItemProperty(
    data_field_series_item=quicksight.CfnDashboard.DataFieldSeriesItemProperty(
        axis_binding="axisBinding",
        field_id="fieldId",

        # the properties below are optional
        field_value="fieldValue",
        settings=quicksight.CfnDashboard.LineChartSeriesSettingsProperty(
            line_style_settings=quicksight.CfnDashboard.LineChartLineStyleSettingsProperty(
                line_interpolation="lineInterpolation",
                line_style="lineStyle",
                line_visibility="lineVisibility",
                line_width="lineWidth"
            ),
            marker_style_settings=quicksight.CfnDashboard.LineChartMarkerStyleSettingsProperty(
                marker_color="markerColor",
                marker_shape="markerShape",
                marker_size="markerSize",
                marker_visibility="markerVisibility"
            )
        )
    ),
    field_series_item=quicksight.CfnDashboard.FieldSeriesItemProperty(
        axis_binding="axisBinding",
        field_id="fieldId",

        # the properties below are optional
        settings=quicksight.CfnDashboard.LineChartSeriesSettingsProperty(
            line_style_settings=quicksight.CfnDashboard.LineChartLineStyleSettingsProperty(
                line_interpolation="lineInterpolation",
                line_style="lineStyle",
                line_visibility="lineVisibility",
                line_width="lineWidth"
            ),
            marker_style_settings=quicksight.CfnDashboard.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-dashboard-seriesitem.html#cfn-quicksight-dashboard-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-dashboard-seriesitem.html#cfn-quicksight-dashboard-seriesitem-fieldseriesitem

SetParameterValueConfigurationProperty

class CfnDashboard.SetParameterValueConfigurationProperty(*, destination_parameter_name, value)

Bases: object

The configuration of adding parameters in action.

Parameters:
See:

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

set_parameter_value_configuration_property = quicksight.CfnDashboard.SetParameterValueConfigurationProperty(
    destination_parameter_name="destinationParameterName",
    value=quicksight.CfnDashboard.DestinationParameterValueConfigurationProperty(
        custom_values_configuration=quicksight.CfnDashboard.CustomValuesConfigurationProperty(
            custom_values=quicksight.CfnDashboard.CustomParameterValuesProperty(
                date_time_values=["dateTimeValues"],
                decimal_values=[123],
                integer_values=[123],
                string_values=["stringValues"]
            ),

            # the properties below are optional
            include_null_value=False
        ),
        select_all_value_options="selectAllValueOptions",
        source_column=quicksight.CfnDashboard.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-dashboard-setparametervalueconfiguration.html#cfn-quicksight-dashboard-setparametervalueconfiguration-destinationparametername

value

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

Type:

see

ShapeConditionalFormatProperty

class CfnDashboard.ShapeConditionalFormatProperty(*, background_color)

Bases: object

The shape conditional formatting of a filled map visual.

Parameters:

background_color (Union[IResolvable, ConditionalFormattingColorProperty, Dict[str, Any]]) – 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-dashboard-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 import aws_quicksight as quicksight

shape_conditional_format_property = quicksight.CfnDashboard.ShapeConditionalFormatProperty(
    background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    )
)

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-dashboard-shapeconditionalformat.html#cfn-quicksight-dashboard-shapeconditionalformat-backgroundcolor

SheetControlInfoIconLabelOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

sheet_control_info_icon_label_options_property = quicksight.CfnDashboard.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-dashboard-sheetcontrolinfoiconlabeloptions.html#cfn-quicksight-dashboard-sheetcontrolinfoiconlabeloptions-infoicontext

visibility

The visibility configuration of info icon label options.

See:

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

SheetControlLayoutConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

sheet_control_layout_configuration_property = quicksight.CfnDashboard.SheetControlLayoutConfigurationProperty(
    grid_layout=quicksight.CfnDashboard.GridLayoutConfigurationProperty(
        elements=[quicksight.CfnDashboard.GridLayoutElementProperty(
            column_span=123,
            element_id="elementId",
            element_type="elementType",
            row_span=123,

            # the properties below are optional
            column_index=123,
            row_index=123
        )],

        # the properties below are optional
        canvas_size_options=quicksight.CfnDashboard.GridLayoutCanvasSizeOptionsProperty(
            screen_canvas_size_options=quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
                resize_option="resizeOption",

                # the properties below are optional
                optimized_view_port_width="optimizedViewPortWidth"
            )
        )
    )
)

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-dashboard-sheetcontrollayoutconfiguration.html#cfn-quicksight-dashboard-sheetcontrollayoutconfiguration-gridlayout

SheetControlLayoutProperty

class CfnDashboard.SheetControlLayoutProperty(*, configuration)

Bases: object

A grid layout to define the placement of sheet control.

Parameters:

configuration (Union[IResolvable, SheetControlLayoutConfigurationProperty, Dict[str, Any]]) – 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-dashboard-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 import aws_quicksight as quicksight

sheet_control_layout_property = quicksight.CfnDashboard.SheetControlLayoutProperty(
    configuration=quicksight.CfnDashboard.SheetControlLayoutConfigurationProperty(
        grid_layout=quicksight.CfnDashboard.GridLayoutConfigurationProperty(
            elements=[quicksight.CfnDashboard.GridLayoutElementProperty(
                column_span=123,
                element_id="elementId",
                element_type="elementType",
                row_span=123,

                # the properties below are optional
                column_index=123,
                row_index=123
            )],

            # the properties below are optional
            canvas_size_options=quicksight.CfnDashboard.GridLayoutCanvasSizeOptionsProperty(
                screen_canvas_size_options=quicksight.CfnDashboard.GridLayoutScreenCanvasSizeOptionsProperty(
                    resize_option="resizeOption",

                    # the properties below are optional
                    optimized_view_port_width="optimizedViewPortWidth"
                )
            )
        )
    )
)

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-dashboard-sheetcontrollayout.html#cfn-quicksight-dashboard-sheetcontrollayout-configuration

SheetControlsOptionProperty

class CfnDashboard.SheetControlsOptionProperty(*, visibility_state=None)

Bases: object

Sheet controls option.

Parameters:

visibility_state (Optional[str]) – Visibility state.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrolsoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

sheet_controls_option_property = quicksight.CfnDashboard.SheetControlsOptionProperty(
    visibility_state="visibilityState"
)

Attributes

visibility_state

Visibility state.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetcontrolsoption.html#cfn-quicksight-dashboard-sheetcontrolsoption-visibilitystate

SheetDefinitionProperty

class CfnDashboard.SheetDefinitionProperty(*, sheet_id, content_type=None, description=None, filter_controls=None, layouts=None, name=None, parameter_controls=None, sheet_control_layouts=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:

  • sheet_id (str) – The unique identifier of a sheet.

  • content_type (Optional[str]) – The layout content type of the sheet. Choose one of the following options:. - PAGINATED : Creates a sheet for a paginated report. - INTERACTIVE : Creates a sheet for an interactive dashboard.

  • description (Optional[str]) – A description of the sheet.

  • filter_controls (Union[IResolvable, Sequence[Union[IResolvable, FilterControlProperty, Dict[str, Any]]], None]) – The list of filter controls that are on a sheet. For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide .

  • layouts (Union[IResolvable, Sequence[Union[IResolvable, LayoutProperty, Dict[str, Any]]], None]) –

    Layouts define how the components of a sheet are arranged. For more information, see Types of layout in the Amazon QuickSight User Guide .

  • name (Optional[str]) – The name of the sheet. This name is displayed on the sheet’s tab in the Amazon QuickSight console.

  • parameter_controls (Union[IResolvable, Sequence[Union[IResolvable, ParameterControlProperty, Dict[str, Any]]], None]) – The list of parameter controls that are on a sheet. For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide .

  • sheet_control_layouts (Union[IResolvable, Sequence[Union[IResolvable, SheetControlLayoutProperty, Dict[str, Any]]], None]) – The control layouts of the sheet.

  • text_boxes (Union[IResolvable, Sequence[Union[IResolvable, SheetTextBoxProperty, Dict[str, Any]]], None]) – The text boxes that are on a sheet.

  • title (Optional[str]) – The title of the sheet.

  • visuals (Union[IResolvable, Sequence[Union[IResolvable, VisualProperty, Dict[str, Any]]], None]) – 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-dashboard-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-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-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-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-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 QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-filtercontrols

layouts

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-layouts

name

The name of the sheet.

This name is displayed on the sheet’s tab in the Amazon QuickSight console.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-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 QuickSight in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-parametercontrols

sheet_control_layouts

The control layouts of the sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-sheetcontrollayouts

sheet_id

The unique identifier of a sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-sheetid

text_boxes

The text boxes that are on a sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-textboxes

title

The title of the sheet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-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-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-visuals

SheetElementConfigurationOverridesProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

sheet_element_configuration_overrides_property = quicksight.CfnDashboard.SheetElementConfigurationOverridesProperty(
    visibility="visibility"
)

Attributes

visibility

.

  • VISIBLE

  • HIDDEN

See:

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

Type:

Determines whether or not the overrides are visible. Choose one of the following options

SheetElementRenderingRuleProperty

class CfnDashboard.SheetElementRenderingRuleProperty(*, configuration_overrides, expression)

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

sheet_element_rendering_rule_property = quicksight.CfnDashboard.SheetElementRenderingRuleProperty(
    configuration_overrides=quicksight.CfnDashboard.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-dashboard-sheetelementrenderingrule.html#cfn-quicksight-dashboard-sheetelementrenderingrule-configurationoverrides

expression

The expression of the rendering rules of a sheet.

See:

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

SheetLayoutElementMaximizationOptionProperty

class CfnDashboard.SheetLayoutElementMaximizationOptionProperty(*, availability_status=None)

Bases: object

The sheet layout maximization options of a dashbaord.

Parameters:

availability_status (Optional[str]) – The status of the sheet layout maximization options of a dashbaord.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetlayoutelementmaximizationoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

sheet_layout_element_maximization_option_property = quicksight.CfnDashboard.SheetLayoutElementMaximizationOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

The status of the sheet layout maximization options of a dashbaord.

See:

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

SheetProperty

class CfnDashboard.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 Amazon QuickSight.

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 Amazon QuickSight console.

  • sheet_id (Optional[str]) – The unique identifier associated with a sheet.

See:

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

sheet_property = quicksight.CfnDashboard.SheetProperty(
    name="name",
    sheet_id="sheetId"
)

Attributes

name

The name of a sheet.

This name is displayed on the sheet’s tab in the Amazon QuickSight console.

See:

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

sheet_id

The unique identifier associated with a sheet.

See:

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

SheetTextBoxProperty

class CfnDashboard.SheetTextBoxProperty(*, sheet_text_box_id, content=None)

Bases: object

A text box.

Parameters:

  • sheet_text_box_id (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.

  • content (Optional[str]) – The content that is displayed in the text box.

See:

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

sheet_text_box_property = quicksight.CfnDashboard.SheetTextBoxProperty(
    sheet_text_box_id="sheetTextBoxId",

    # the properties below are optional
    content="content"
)

Attributes

content

The content that is displayed in the text box.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheettextbox.html#cfn-quicksight-dashboard-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-dashboard-sheettextbox.html#cfn-quicksight-dashboard-sheettextbox-sheettextboxid

SheetVisualScopingConfigurationProperty

class CfnDashboard.SheetVisualScopingConfigurationProperty(*, scope, sheet_id, visual_ids=None)

Bases: object

The filter that is applied to the options.

Parameters:

  • scope (str) – The scope of the applied entities. Choose one of the following options:. - ALL_VISUALS - SELECTED_VISUALS

  • sheet_id (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-dashboard-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 import aws_quicksight as quicksight

sheet_visual_scoping_configuration_property = quicksight.CfnDashboard.SheetVisualScopingConfigurationProperty(
    scope="scope",
    sheet_id="sheetId",

    # the properties below are optional
    visual_ids=["visualIds"]
)

Attributes

scope

.

  • ALL_VISUALS

  • SELECTED_VISUALS

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetvisualscopingconfiguration.html#cfn-quicksight-dashboard-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-dashboard-sheetvisualscopingconfiguration.html#cfn-quicksight-dashboard-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-dashboard-sheetvisualscopingconfiguration.html#cfn-quicksight-dashboard-sheetvisualscopingconfiguration-visualids

ShortFormatTextProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

short_format_text_property = quicksight.CfnDashboard.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-dashboard-shortformattext.html#cfn-quicksight-dashboard-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-dashboard-shortformattext.html#cfn-quicksight-dashboard-shortformattext-richtext

SimpleClusterMarkerProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

simple_cluster_marker_property = quicksight.CfnDashboard.SimpleClusterMarkerProperty(
    color="color"
)

Attributes

color

The color of the simple cluster marker.

See:

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

SingleAxisOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

single_axis_options_property = quicksight.CfnDashboard.SingleAxisOptionsProperty(
    y_axis_options=quicksight.CfnDashboard.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-dashboard-singleaxisoptions.html#cfn-quicksight-dashboard-singleaxisoptions-yaxisoptions

SliderControlDisplayOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

slider_control_display_options_property = quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-slidercontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-slidercontroldisplayoptions.html#cfn-quicksight-dashboard-slidercontroldisplayoptions-titleoptions

SmallMultiplesAxisPropertiesProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

small_multiples_axis_properties_property = quicksight.CfnDashboard.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-dashboard-smallmultiplesaxisproperties.html#cfn-quicksight-dashboard-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-dashboard-smallmultiplesaxisproperties.html#cfn-quicksight-dashboard-smallmultiplesaxisproperties-scale

SmallMultiplesOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

small_multiples_options_property = quicksight.CfnDashboard.SmallMultiplesOptionsProperty(
    max_visible_columns=123,
    max_visible_rows=123,
    panel_configuration=quicksight.CfnDashboard.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.CfnDashboard.PanelTitleOptionsProperty(
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),
            horizontal_text_alignment="horizontalTextAlignment",
            visibility="visibility"
        )
    ),
    x_axis=quicksight.CfnDashboard.SmallMultiplesAxisPropertiesProperty(
        placement="placement",
        scale="scale"
    ),
    y_axis=quicksight.CfnDashboard.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-dashboard-smallmultiplesoptions.html#cfn-quicksight-dashboard-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-dashboard-smallmultiplesoptions.html#cfn-quicksight-dashboard-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-dashboard-smallmultiplesoptions.html#cfn-quicksight-dashboard-smallmultiplesoptions-panelconfiguration

x_axis

The properties of a small multiples X axis.

See:

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

y_axis

The properties of a small multiples Y axis.

See:

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

SpacingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

spacing_property = quicksight.CfnDashboard.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-dashboard-spacing.html#cfn-quicksight-dashboard-spacing-bottom

left

Define the left spacing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spacing.html#cfn-quicksight-dashboard-spacing-left

right

Define the right spacing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spacing.html#cfn-quicksight-dashboard-spacing-right

top

Define the top spacing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-spacing.html#cfn-quicksight-dashboard-spacing-top

StringDefaultValuesProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

string_default_values_property = quicksight.CfnDashboard.StringDefaultValuesProperty(
    dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
        default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),

        # the properties below are optional
        group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        user_name_column=quicksight.CfnDashboard.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-dashboard-stringdefaultvalues.html#cfn-quicksight-dashboard-stringdefaultvalues-dynamicvalue

static_values

The static values of the DecimalDefaultValues .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringdefaultvalues.html#cfn-quicksight-dashboard-stringdefaultvalues-staticvalues

StringFormatConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

string_format_configuration_property = quicksight.CfnDashboard.StringFormatConfigurationProperty(
    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix",
            symbol="symbol"
        ),
        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                    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-dashboard-stringformatconfiguration.html#cfn-quicksight-dashboard-stringformatconfiguration-nullvalueformatconfiguration

numeric_format_configuration

The formatting configuration for numeric strings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringformatconfiguration.html#cfn-quicksight-dashboard-stringformatconfiguration-numericformatconfiguration

StringParameterDeclarationProperty

class CfnDashboard.StringParameterDeclarationProperty(*, name, parameter_value_type, default_values=None, mapped_data_set_parameters=None, value_when_unset=None)

Bases: object

A parameter declaration for the String data type.

Parameters:

  • name (str) – The name of the parameter that is being declared.

  • parameter_value_type (str) – The value type determines whether the parameter is a single-value or multi-value parameter.

  • 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]) –

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

string_parameter_declaration_property = quicksight.CfnDashboard.StringParameterDeclarationProperty(
    name="name",
    parameter_value_type="parameterValueType",

    # the properties below are optional
    default_values=quicksight.CfnDashboard.StringDefaultValuesProperty(
        dynamic_value=quicksight.CfnDashboard.DynamicDefaultValueProperty(
            default_value_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            group_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            user_name_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )
        ),
        static_values=["staticValues"]
    ),
    mapped_data_set_parameters=[quicksight.CfnDashboard.MappedDataSetParameterProperty(
        data_set_identifier="dataSetIdentifier",
        data_set_parameter_name="dataSetParameterName"
    )],
    value_when_unset=quicksight.CfnDashboard.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-dashboard-stringparameterdeclaration.html#cfn-quicksight-dashboard-stringparameterdeclaration-defaultvalues

mapped_data_set_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-stringparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-stringparameterdeclaration.html#cfn-quicksight-dashboard-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-dashboard-stringparameterdeclaration.html#cfn-quicksight-dashboard-stringparameterdeclaration-valuewhenunset

StringParameterProperty

class CfnDashboard.StringParameterProperty(*, name, values)

Bases: object

A string parameter.

Parameters:

  • name (str) – A display name for a string parameter.

  • values (Sequence[str]) – The values of a string parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-stringparameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

string_parameter_property = quicksight.CfnDashboard.StringParameterProperty(
    name="name",
    values=["values"]
)

Attributes

name

A display name for a string parameter.

See:

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

values

The values of a string parameter.

See:

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

StringValueWhenUnsetConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

string_value_when_unset_configuration_property = quicksight.CfnDashboard.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-dashboard-stringvaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-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-dashboard-stringvaluewhenunsetconfiguration.html#cfn-quicksight-dashboard-stringvaluewhenunsetconfiguration-valuewhenunsetoption

Type:

The built-in options for default values. The value can be one of the following

SubtotalOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

subtotal_options_property = quicksight.CfnDashboard.SubtotalOptionsProperty(
    custom_label="customLabel",
    field_level="fieldLevel",
    field_level_options=[quicksight.CfnDashboard.PivotTableFieldSubtotalOptionsProperty(
        field_id="fieldId"
    )],
    metric_header_cell_style=quicksight.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    style_targets=[quicksight.CfnDashboard.TableStyleTargetProperty(
        cell_type="cellType"
    )],
    total_cell_style=quicksight.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-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-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-fieldlevel

field_level_options

The optional configuration of subtotal cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-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-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-metricheadercellstyle

style_targets

The style targets options for subtotals.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-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-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-totalcellstyle

totals_visibility

The visibility configuration for the subtotal cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-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-dashboard-subtotaloptions.html#cfn-quicksight-dashboard-subtotaloptions-valuecellstyle

TableAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-tableaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

table_aggregated_field_wells_property = quicksight.CfnDashboard.TableAggregatedFieldWellsProperty(
    group_by=[quicksight.CfnDashboard.DimensionFieldProperty(
        categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            date_granularity="dateGranularity",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    )],
    values=[quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        )
    )]
)

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-dashboard-tableaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-tableaggregatedfieldwells.html#cfn-quicksight-dashboard-tableaggregatedfieldwells-values

TableBorderOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_border_options_property = quicksight.CfnDashboard.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-dashboard-tableborderoptions.html#cfn-quicksight-dashboard-tableborderoptions-color

style

The style (none, solid) of a table border.

See:

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

thickness

The thickness of a table border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableborderoptions.html#cfn-quicksight-dashboard-tableborderoptions-thickness

TableCellConditionalFormattingProperty

class CfnDashboard.TableCellConditionalFormattingProperty(*, field_id, text_format=None)

Bases: object

The cell conditional formatting option for a table.

Parameters:

  • field_id (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-dashboard-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 import aws_quicksight as quicksight

table_cell_conditional_formatting_property = quicksight.CfnDashboard.TableCellConditionalFormattingProperty(
    field_id="fieldId",

    # the properties below are optional
    text_format=quicksight.CfnDashboard.TextConditionalFormatProperty(
        background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        ),
        icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
            custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                expression="expression",
                icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                    icon="icon",
                    unicode_icon="unicodeIcon"
                ),

                # the properties below are optional
                color="color",
                display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                    icon_display_option="iconDisplayOption"
                )
            ),
            icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                expression="expression",

                # the properties below are optional
                icon_set_type="iconSetType"
            )
        ),
        text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        )
    )
)

Attributes

field_id

The field ID of the cell for conditional formatting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellconditionalformatting.html#cfn-quicksight-dashboard-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-dashboard-tablecellconditionalformatting.html#cfn-quicksight-dashboard-tablecellconditionalformatting-textformat

TableCellImageSizingConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_cell_image_sizing_configuration_property = quicksight.CfnDashboard.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-dashboard-tablecellimagesizingconfiguration.html#cfn-quicksight-dashboard-tablecellimagesizingconfiguration-tablecellimagescalingconfiguration

TableCellStyleProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_cell_style_property = quicksight.CfnDashboard.TableCellStyleProperty(
    background_color="backgroundColor",
    border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
        side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
            bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            ),
            inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            ),
            inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            ),
            left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            ),
            right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            ),
            top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
            color="color",
            style="style",
            thickness=123
        )
    ),
    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.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-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-tablecellstyle-backgroundcolor

border

The borders for the table cells.

See:

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

font_configuration

The font configuration of the table cells.

See:

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

height

The height color for the table cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-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-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-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-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-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-dashboard-tablecellstyle.html#cfn-quicksight-dashboard-tablecellstyle-verticaltextalignment

visibility

The visibility of the table cells.

See:

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

TableConditionalFormattingOptionProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_conditional_formatting_option_property = quicksight.CfnDashboard.TableConditionalFormattingOptionProperty(
    cell=quicksight.CfnDashboard.TableCellConditionalFormattingProperty(
        field_id="fieldId",

        # the properties below are optional
        text_format=quicksight.CfnDashboard.TextConditionalFormatProperty(
            background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            ),
            icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
                custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                    expression="expression",
                    icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                        icon="icon",
                        unicode_icon="unicodeIcon"
                    ),

                    # the properties below are optional
                    color="color",
                    display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                        icon_display_option="iconDisplayOption"
                    )
                ),
                icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                    expression="expression",

                    # the properties below are optional
                    icon_set_type="iconSetType"
                )
            ),
            text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            )
        )
    ),
    row=quicksight.CfnDashboard.TableRowConditionalFormattingProperty(
        background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        ),
        text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
            gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                color=quicksight.CfnDashboard.GradientColorProperty(
                    stops=[quicksight.CfnDashboard.GradientStopProperty(
                        gradient_offset=123,

                        # the properties below are optional
                        color="color",
                        data_value=123
                    )]
                ),
                expression="expression"
            ),
            solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                expression="expression",

                # the properties below are optional
                color="color"
            )
        )
    )
)

Attributes

cell

The cell conditional formatting option for a table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconditionalformattingoption.html#cfn-quicksight-dashboard-tableconditionalformattingoption-cell

row

The row conditional formatting option for a table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconditionalformattingoption.html#cfn-quicksight-dashboard-tableconditionalformattingoption-row

TableConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_conditional_formatting_property = quicksight.CfnDashboard.TableConditionalFormattingProperty(
    conditional_formatting_options=[quicksight.CfnDashboard.TableConditionalFormattingOptionProperty(
        cell=quicksight.CfnDashboard.TableCellConditionalFormattingProperty(
            field_id="fieldId",

            # the properties below are optional
            text_format=quicksight.CfnDashboard.TextConditionalFormatProperty(
                background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                    gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                        color=quicksight.CfnDashboard.GradientColorProperty(
                            stops=[quicksight.CfnDashboard.GradientStopProperty(
                                gradient_offset=123,

                                # the properties below are optional
                                color="color",
                                data_value=123
                            )]
                        ),
                        expression="expression"
                    ),
                    solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                        expression="expression",

                        # the properties below are optional
                        color="color"
                    )
                ),
                icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
                    custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
                        expression="expression",
                        icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                            icon="icon",
                            unicode_icon="unicodeIcon"
                        ),

                        # the properties below are optional
                        color="color",
                        display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                            icon_display_option="iconDisplayOption"
                        )
                    ),
                    icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
                        expression="expression",

                        # the properties below are optional
                        icon_set_type="iconSetType"
                    )
                ),
                text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                    gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                        color=quicksight.CfnDashboard.GradientColorProperty(
                            stops=[quicksight.CfnDashboard.GradientStopProperty(
                                gradient_offset=123,

                                # the properties below are optional
                                color="color",
                                data_value=123
                            )]
                        ),
                        expression="expression"
                    ),
                    solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                        expression="expression",

                        # the properties below are optional
                        color="color"
                    )
                )
            )
        ),
        row=quicksight.CfnDashboard.TableRowConditionalFormattingProperty(
            background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            ),
            text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
                gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
                    color=quicksight.CfnDashboard.GradientColorProperty(
                        stops=[quicksight.CfnDashboard.GradientStopProperty(
                            gradient_offset=123,

                            # the properties below are optional
                            color="color",
                            data_value=123
                        )]
                    ),
                    expression="expression"
                ),
                solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
                    expression="expression",

                    # the properties below are optional
                    color="color"
                )
            )
        )
    )]
)

Attributes

conditional_formatting_options

Conditional formatting options for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconditionalformatting.html#cfn-quicksight-dashboard-tableconditionalformatting-conditionalformattingoptions

TableConfigurationProperty

class CfnDashboard.TableConfigurationProperty(*, field_options=None, field_wells=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-dashboard-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-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-fieldoptions

field_wells

The field wells of the visual.

See:

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

paginated_report_options

The paginated report options for a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-paginatedreportoptions

sort_configuration

The sort configuration for a TableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-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-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-tableinlinevisualizations

table_options

The table options for a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-tableoptions

total_options

The total options for a table visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableconfiguration.html#cfn-quicksight-dashboard-tableconfiguration-totaloptions

TableFieldCustomIconContentProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_field_custom_icon_content_property = quicksight.CfnDashboard.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-dashboard-tablefieldcustomiconcontent.html#cfn-quicksight-dashboard-tablefieldcustomiconcontent-icon

TableFieldCustomTextContentProperty

class CfnDashboard.TableFieldCustomTextContentProperty(*, font_configuration, 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]]) – 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-dashboard-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 import aws_quicksight as quicksight

table_field_custom_text_content_property = quicksight.CfnDashboard.TableFieldCustomTextContentProperty(
    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_size=quicksight.CfnDashboard.FontSizeProperty(
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnDashboard.FontWeightProperty(
            name="name"
        )
    ),

    # the properties below are optional
    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-dashboard-tablefieldcustomtextcontent.html#cfn-quicksight-dashboard-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-dashboard-tablefieldcustomtextcontent.html#cfn-quicksight-dashboard-tablefieldcustomtextcontent-value

TableFieldImageConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_field_image_configuration_property = quicksight.CfnDashboard.TableFieldImageConfigurationProperty(
    sizing_options=quicksight.CfnDashboard.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-dashboard-tablefieldimageconfiguration.html#cfn-quicksight-dashboard-tablefieldimageconfiguration-sizingoptions

TableFieldLinkConfigurationProperty

class CfnDashboard.TableFieldLinkConfigurationProperty(*, content, target)

Bases: object

The link configuration of a table field URL.

Parameters:
See:

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

table_field_link_configuration_property = quicksight.CfnDashboard.TableFieldLinkConfigurationProperty(
    content=quicksight.CfnDashboard.TableFieldLinkContentConfigurationProperty(
        custom_icon_content=quicksight.CfnDashboard.TableFieldCustomIconContentProperty(
            icon="icon"
        ),
        custom_text_content=quicksight.CfnDashboard.TableFieldCustomTextContentProperty(
            font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                font_color="fontColor",
                font_decoration="fontDecoration",
                font_size=quicksight.CfnDashboard.FontSizeProperty(
                    relative="relative"
                ),
                font_style="fontStyle",
                font_weight=quicksight.CfnDashboard.FontWeightProperty(
                    name="name"
                )
            ),

            # the properties below are optional
            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-dashboard-tablefieldlinkconfiguration.html#cfn-quicksight-dashboard-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-dashboard-tablefieldlinkconfiguration.html#cfn-quicksight-dashboard-tablefieldlinkconfiguration-target

TableFieldLinkContentConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_field_link_content_configuration_property = quicksight.CfnDashboard.TableFieldLinkContentConfigurationProperty(
    custom_icon_content=quicksight.CfnDashboard.TableFieldCustomIconContentProperty(
        icon="icon"
    ),
    custom_text_content=quicksight.CfnDashboard.TableFieldCustomTextContentProperty(
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                name="name"
            )
        ),

        # the properties below are optional
        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-dashboard-tablefieldlinkcontentconfiguration.html#cfn-quicksight-dashboard-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-dashboard-tablefieldlinkcontentconfiguration.html#cfn-quicksight-dashboard-tablefieldlinkcontentconfiguration-customtextcontent

TableFieldOptionProperty

class CfnDashboard.TableFieldOptionProperty(*, field_id, custom_label=None, url_styling=None, visibility=None, width=None)

Bases: object

The options for a table field.

Parameters:

  • field_id (str) – The field ID for a table field.

  • custom_label (Optional[str]) – The custom label 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-dashboard-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 import aws_quicksight as quicksight

table_field_option_property = quicksight.CfnDashboard.TableFieldOptionProperty(
    field_id="fieldId",

    # the properties below are optional
    custom_label="customLabel",
    url_styling=quicksight.CfnDashboard.TableFieldURLConfigurationProperty(
        image_configuration=quicksight.CfnDashboard.TableFieldImageConfigurationProperty(
            sizing_options=quicksight.CfnDashboard.TableCellImageSizingConfigurationProperty(
                table_cell_image_scaling_configuration="tableCellImageScalingConfiguration"
            )
        ),
        link_configuration=quicksight.CfnDashboard.TableFieldLinkConfigurationProperty(
            content=quicksight.CfnDashboard.TableFieldLinkContentConfigurationProperty(
                custom_icon_content=quicksight.CfnDashboard.TableFieldCustomIconContentProperty(
                    icon="icon"
                ),
                custom_text_content=quicksight.CfnDashboard.TableFieldCustomTextContentProperty(
                    font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                        font_color="fontColor",
                        font_decoration="fontDecoration",
                        font_size=quicksight.CfnDashboard.FontSizeProperty(
                            relative="relative"
                        ),
                        font_style="fontStyle",
                        font_weight=quicksight.CfnDashboard.FontWeightProperty(
                            name="name"
                        )
                    ),

                    # the properties below are optional
                    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-dashboard-tablefieldoption.html#cfn-quicksight-dashboard-tablefieldoption-customlabel

field_id

The field ID for a table field.

See:

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

url_styling

The URL configuration for a table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoption.html#cfn-quicksight-dashboard-tablefieldoption-urlstyling

visibility

The visibility of a table field.

See:

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

width

The width for a table field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldoption.html#cfn-quicksight-dashboard-tablefieldoption-width

TableFieldOptionsProperty

class CfnDashboard.TableFieldOptionsProperty(*, order=None, pinned_field_options=None, selected_field_options=None)

Bases: object

The field options of a table visual.

Parameters:

  • order (Optional[Sequence[str]]) – The order of the field IDs that are configured as field options for a table visual.

  • pinned_field_options (Union[IResolvable, TablePinnedFieldOptionsProperty, Dict[str, Any], None]) – The settings for the pinned columns of a table visual.

  • selected_field_options (Union[IResolvable, Sequence[Union[IResolvable, TableFieldOptionProperty, Dict[str, Any]]], None]) – The field options to be configured to a table.

See:

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

table_field_options_property = quicksight.CfnDashboard.TableFieldOptionsProperty(
    order=["order"],
    pinned_field_options=quicksight.CfnDashboard.TablePinnedFieldOptionsProperty(
        pinned_left_fields=["pinnedLeftFields"]
    ),
    selected_field_options=[quicksight.CfnDashboard.TableFieldOptionProperty(
        field_id="fieldId",

        # the properties below are optional
        custom_label="customLabel",
        url_styling=quicksight.CfnDashboard.TableFieldURLConfigurationProperty(
            image_configuration=quicksight.CfnDashboard.TableFieldImageConfigurationProperty(
                sizing_options=quicksight.CfnDashboard.TableCellImageSizingConfigurationProperty(
                    table_cell_image_scaling_configuration="tableCellImageScalingConfiguration"
                )
            ),
            link_configuration=quicksight.CfnDashboard.TableFieldLinkConfigurationProperty(
                content=quicksight.CfnDashboard.TableFieldLinkContentConfigurationProperty(
                    custom_icon_content=quicksight.CfnDashboard.TableFieldCustomIconContentProperty(
                        icon="icon"
                    ),
                    custom_text_content=quicksight.CfnDashboard.TableFieldCustomTextContentProperty(
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),

                        # the properties below are optional
                        value="value"
                    )
                ),
                target="target"
            )
        ),
        visibility="visibility",
        width="width"
    )]
)

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-dashboard-tablefieldoptions.html#cfn-quicksight-dashboard-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-dashboard-tablefieldoptions.html#cfn-quicksight-dashboard-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-dashboard-tablefieldoptions.html#cfn-quicksight-dashboard-tablefieldoptions-selectedfieldoptions

TableFieldURLConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_field_uRLConfiguration_property = quicksight.CfnDashboard.TableFieldURLConfigurationProperty(
    image_configuration=quicksight.CfnDashboard.TableFieldImageConfigurationProperty(
        sizing_options=quicksight.CfnDashboard.TableCellImageSizingConfigurationProperty(
            table_cell_image_scaling_configuration="tableCellImageScalingConfiguration"
        )
    ),
    link_configuration=quicksight.CfnDashboard.TableFieldLinkConfigurationProperty(
        content=quicksight.CfnDashboard.TableFieldLinkContentConfigurationProperty(
            custom_icon_content=quicksight.CfnDashboard.TableFieldCustomIconContentProperty(
                icon="icon"
            ),
            custom_text_content=quicksight.CfnDashboard.TableFieldCustomTextContentProperty(
                font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                    font_color="fontColor",
                    font_decoration="fontDecoration",
                    font_size=quicksight.CfnDashboard.FontSizeProperty(
                        relative="relative"
                    ),
                    font_style="fontStyle",
                    font_weight=quicksight.CfnDashboard.FontWeightProperty(
                        name="name"
                    )
                ),

                # the properties below are optional
                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-dashboard-tablefieldurlconfiguration.html#cfn-quicksight-dashboard-tablefieldurlconfiguration-imageconfiguration

The link configuration of a table field URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablefieldurlconfiguration.html#cfn-quicksight-dashboard-tablefieldurlconfiguration-linkconfiguration

TableFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-tablefieldwells.html#cfn-quicksight-dashboard-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-dashboard-tablefieldwells.html#cfn-quicksight-dashboard-tablefieldwells-tableunaggregatedfieldwells

TableInlineVisualizationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_inline_visualization_property = quicksight.CfnDashboard.TableInlineVisualizationProperty(
    data_bars=quicksight.CfnDashboard.DataBarsOptionsProperty(
        field_id="fieldId",

        # the properties below are optional
        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-dashboard-tableinlinevisualization.html#cfn-quicksight-dashboard-tableinlinevisualization-databars

TableOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_options_property = quicksight.CfnDashboard.TableOptionsProperty(
    cell_style=quicksight.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                name="name"
            )
        ),
        height=123,
        horizontal_text_alignment="horizontalTextAlignment",
        text_wrap="textWrap",
        vertical_text_alignment="verticalTextAlignment",
        visibility="visibility"
    ),
    header_style=quicksight.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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.CfnDashboard.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-dashboard-tableoptions.html#cfn-quicksight-dashboard-tableoptions-cellstyle

header_style

The table cell style of a table header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableoptions.html#cfn-quicksight-dashboard-tableoptions-headerstyle

orientation

The orientation (vertical, horizontal) for a table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tableoptions.html#cfn-quicksight-dashboard-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-dashboard-tableoptions.html#cfn-quicksight-dashboard-tableoptions-rowalternatecoloroptions

TablePaginatedReportOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_paginated_report_options_property = quicksight.CfnDashboard.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-dashboard-tablepaginatedreportoptions.html#cfn-quicksight-dashboard-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-dashboard-tablepaginatedreportoptions.html#cfn-quicksight-dashboard-tablepaginatedreportoptions-verticaloverflowvisibility

TablePinnedFieldOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_pinned_field_options_property = quicksight.CfnDashboard.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-dashboard-tablepinnedfieldoptions.html#cfn-quicksight-dashboard-tablepinnedfieldoptions-pinnedleftfields

TableRowConditionalFormattingProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_row_conditional_formatting_property = quicksight.CfnDashboard.TableRowConditionalFormattingProperty(
    background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    ),
    text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    )
)

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-dashboard-tablerowconditionalformatting.html#cfn-quicksight-dashboard-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-dashboard-tablerowconditionalformatting.html#cfn-quicksight-dashboard-tablerowconditionalformatting-textcolor

TableSideBorderOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_side_border_options_property = quicksight.CfnDashboard.TableSideBorderOptionsProperty(
    bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    ),
    inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    ),
    inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    ),
    left=quicksight.CfnDashboard.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    ),
    right=quicksight.CfnDashboard.TableBorderOptionsProperty(
        color="color",
        style="style",
        thickness=123
    ),
    top=quicksight.CfnDashboard.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-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-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-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-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-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-tablesideborderoptions-innervertical

left

The table border options of the left border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-tablesideborderoptions-left

right

The table border options of the right border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-tablesideborderoptions-right

top

The table border options of the top border.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablesideborderoptions.html#cfn-quicksight-dashboard-tablesideborderoptions-top

TableSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_sort_configuration_property = quicksight.CfnDashboard.TableSortConfigurationProperty(
    pagination_configuration=quicksight.CfnDashboard.PaginationConfigurationProperty(
        page_number=123,
        page_size=123
    ),
    row_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-tablesortconfiguration.html#cfn-quicksight-dashboard-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-dashboard-tablesortconfiguration.html#cfn-quicksight-dashboard-tablesortconfiguration-rowsort

TableStyleTargetProperty

class CfnDashboard.TableStyleTargetProperty(*, cell_type)

Bases: object

The table style target.

Parameters:

cell_type (str) – The cell type of the table style target.

See:

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

table_style_target_property = quicksight.CfnDashboard.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-dashboard-tablestyletarget.html#cfn-quicksight-dashboard-tablestyletarget-celltype

TableUnaggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

table_unaggregated_field_wells_property = quicksight.CfnDashboard.TableUnaggregatedFieldWellsProperty(
    values=[quicksight.CfnDashboard.UnaggregatedFieldProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        field_id="fieldId",

        # the properties below are optional
        format_configuration=quicksight.CfnDashboard.FormatConfigurationProperty(
            date_time_format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            number_format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            string_format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                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-dashboard-tableunaggregatedfieldwells.html#cfn-quicksight-dashboard-tableunaggregatedfieldwells-values

TableVisualProperty

class CfnDashboard.TableVisualProperty(*, visual_id, actions=None, chart_configuration=None, conditional_formatting=None, subtitle=None, title=None)

Bases: object

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-tablevisual.html#cfn-quicksight-dashboard-tablevisual-actions

chart_configuration

The configuration settings of the visual.

See:

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

conditional_formatting

The conditional formatting for a PivotTableVisual .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tablevisual.html#cfn-quicksight-dashboard-tablevisual-conditionalformatting

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-tablevisual.html#cfn-quicksight-dashboard-tablevisual-visualid

TextAreaControlDisplayOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

text_area_control_display_options_property = quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
        visibility="visibility"
    ),
    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-textareacontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-textareacontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-textareacontroldisplayoptions.html#cfn-quicksight-dashboard-textareacontroldisplayoptions-titleoptions

TextConditionalFormatProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

text_conditional_format_property = quicksight.CfnDashboard.TextConditionalFormatProperty(
    background_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    ),
    icon=quicksight.CfnDashboard.ConditionalFormattingIconProperty(
        custom_condition=quicksight.CfnDashboard.ConditionalFormattingCustomIconConditionProperty(
            expression="expression",
            icon_options=quicksight.CfnDashboard.ConditionalFormattingCustomIconOptionsProperty(
                icon="icon",
                unicode_icon="unicodeIcon"
            ),

            # the properties below are optional
            color="color",
            display_configuration=quicksight.CfnDashboard.ConditionalFormattingIconDisplayConfigurationProperty(
                icon_display_option="iconDisplayOption"
            )
        ),
        icon_set=quicksight.CfnDashboard.ConditionalFormattingIconSetProperty(
            expression="expression",

            # the properties below are optional
            icon_set_type="iconSetType"
        )
    ),
    text_color=quicksight.CfnDashboard.ConditionalFormattingColorProperty(
        gradient=quicksight.CfnDashboard.ConditionalFormattingGradientColorProperty(
            color=quicksight.CfnDashboard.GradientColorProperty(
                stops=[quicksight.CfnDashboard.GradientStopProperty(
                    gradient_offset=123,

                    # the properties below are optional
                    color="color",
                    data_value=123
                )]
            ),
            expression="expression"
        ),
        solid=quicksight.CfnDashboard.ConditionalFormattingSolidColorProperty(
            expression="expression",

            # the properties below are optional
            color="color"
        )
    )
)

Attributes

background_color

The conditional formatting for the text background color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textconditionalformat.html#cfn-quicksight-dashboard-textconditionalformat-backgroundcolor

icon

The conditional formatting for the icon.

See:

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

text_color

The conditional formatting for the text color.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-textconditionalformat.html#cfn-quicksight-dashboard-textconditionalformat-textcolor

TextControlPlaceholderOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

text_control_placeholder_options_property = quicksight.CfnDashboard.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-dashboard-textcontrolplaceholderoptions.html#cfn-quicksight-dashboard-textcontrolplaceholderoptions-visibility

TextFieldControlDisplayOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

text_field_control_display_options_property = quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
        info_icon_text="infoIconText",
        visibility="visibility"
    ),
    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
        visibility="visibility"
    ),
    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
        custom_label="customLabel",
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-textfieldcontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-textfieldcontroldisplayoptions.html#cfn-quicksight-dashboard-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-dashboard-textfieldcontroldisplayoptions.html#cfn-quicksight-dashboard-textfieldcontroldisplayoptions-titleoptions

ThousandSeparatorOptionsProperty

class CfnDashboard.ThousandSeparatorOptionsProperty(*, symbol=None, visibility=None)

Bases: object

The options that determine the thousands separator configuration.

Parameters:

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

thousand_separator_options_property = quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
    symbol="symbol",
    visibility="visibility"
)

Attributes

symbol

Determines the thousands separator symbol.

See:

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

visibility

Determines the visibility of the thousands separator.

See:

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

TimeBasedForecastPropertiesProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

time_based_forecast_properties_property = quicksight.CfnDashboard.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-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-timebasedforecastproperties-lowerboundary

periods_backward

The periods backward setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-timebasedforecastproperties-periodsbackward

periods_forward

The periods forward setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-timebasedforecastproperties-periodsforward

prediction_interval

The prediction interval setup of a forecast computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-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-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-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-dashboard-timebasedforecastproperties.html#cfn-quicksight-dashboard-timebasedforecastproperties-upperboundary

TimeEqualityFilterProperty

class CfnDashboard.TimeEqualityFilterProperty(*, column, filter_id, default_filter_control_configuration=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]]) – The column that the filter is applied to.

  • filter_id (str) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

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

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

time_equality_filter_property = quicksight.CfnDashboard.TimeEqualityFilterProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    filter_id="filterId",

    # the properties below are optional
    default_filter_control_configuration=quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
        control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
                display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
                maximum_value=123,
                minimum_value=123,
                step_size=123,

                # the properties below are optional
                display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    parameter_name="parameterName",
    rolling_date=quicksight.CfnDashboard.RollingDateConfigurationProperty(
        expression="expression",

        # the properties below are optional
        data_set_identifier="dataSetIdentifier"
    ),
    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-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-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-dashboard-timeequalityfilter.html#cfn-quicksight-dashboard-timeequalityfilter-value

TimeRangeDrillDownFilterProperty

class CfnDashboard.TimeRangeDrillDownFilterProperty(*, column, range_maximum, range_minimum, time_granularity)

Bases: object

The time range drill down filter.

Parameters:

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

  • range_maximum (str) – The maximum value for the filter value range.

  • range_minimum (str) – The minimum value for the filter value range.

  • time_granularity (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-dashboard-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 import aws_quicksight as quicksight

time_range_drill_down_filter_property = quicksight.CfnDashboard.TimeRangeDrillDownFilterProperty(
    column=quicksight.CfnDashboard.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-dashboard-timerangedrilldownfilter.html#cfn-quicksight-dashboard-timerangedrilldownfilter-column

range_maximum

The maximum value for the filter value range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangedrilldownfilter.html#cfn-quicksight-dashboard-timerangedrilldownfilter-rangemaximum

range_minimum

The minimum value for the filter value range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangedrilldownfilter.html#cfn-quicksight-dashboard-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-dashboard-timerangedrilldownfilter.html#cfn-quicksight-dashboard-timerangedrilldownfilter-timegranularity

TimeRangeFilterProperty

class CfnDashboard.TimeRangeFilterProperty(*, column, filter_id, null_option, default_filter_control_configuration=None, exclude_period_configuration=None, include_maximum=None, include_minimum=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]]) – The column that the filter is applied to.

  • filter_id (str) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

  • null_option (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.

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

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

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

time_range_filter_property = quicksight.CfnDashboard.TimeRangeFilterProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    filter_id="filterId",
    null_option="nullOption",

    # the properties below are optional
    default_filter_control_configuration=quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
        control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
                display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
                maximum_value=123,
                minimum_value=123,
                step_size=123,

                # the properties below are optional
                display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    exclude_period_configuration=quicksight.CfnDashboard.ExcludePeriodConfigurationProperty(
        amount=123,
        granularity="granularity",

        # the properties below are optional
        status="status"
    ),
    include_maximum=False,
    include_minimum=False,
    range_maximum_value=quicksight.CfnDashboard.TimeRangeFilterValueProperty(
        parameter="parameter",
        rolling_date=quicksight.CfnDashboard.RollingDateConfigurationProperty(
            expression="expression",

            # the properties below are optional
            data_set_identifier="dataSetIdentifier"
        ),
        static_value="staticValue"
    ),
    range_minimum_value=quicksight.CfnDashboard.TimeRangeFilterValueProperty(
        parameter="parameter",
        rolling_date=quicksight.CfnDashboard.RollingDateConfigurationProperty(
            expression="expression",

            # the properties below are optional
            data_set_identifier="dataSetIdentifier"
        ),
        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-dashboard-timerangefilter.html#cfn-quicksight-dashboard-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-dashboard-timerangefilter.html#cfn-quicksight-dashboard-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-dashboard-timerangefilter.html#cfn-quicksight-dashboard-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-dashboard-timerangefilter.html#cfn-quicksight-dashboard-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-dashboard-timerangefilter.html#cfn-quicksight-dashboard-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-dashboard-timerangefilter.html#cfn-quicksight-dashboard-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-dashboard-timerangefilter.html#cfn-quicksight-dashboard-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-dashboard-timerangefilter.html#cfn-quicksight-dashboard-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-dashboard-timerangefilter.html#cfn-quicksight-dashboard-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-dashboard-timerangefilter.html#cfn-quicksight-dashboard-timerangefilter-timegranularity

TimeRangeFilterValueProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

time_range_filter_value_property = quicksight.CfnDashboard.TimeRangeFilterValueProperty(
    parameter="parameter",
    rolling_date=quicksight.CfnDashboard.RollingDateConfigurationProperty(
        expression="expression",

        # the properties below are optional
        data_set_identifier="dataSetIdentifier"
    ),
    static_value="staticValue"
)

Attributes

parameter

The parameter type input value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefiltervalue.html#cfn-quicksight-dashboard-timerangefiltervalue-parameter

rolling_date

The rolling date input value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefiltervalue.html#cfn-quicksight-dashboard-timerangefiltervalue-rollingdate

static_value

The static input value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-timerangefiltervalue.html#cfn-quicksight-dashboard-timerangefiltervalue-staticvalue

TooltipItemProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

tooltip_item_property = quicksight.CfnDashboard.TooltipItemProperty(
    column_tooltip_item=quicksight.CfnDashboard.ColumnTooltipItemProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),

        # the properties below are optional
        aggregation=quicksight.CfnDashboard.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        ),
        label="label",
        tooltip_target="tooltipTarget",
        visibility="visibility"
    ),
    field_tooltip_item=quicksight.CfnDashboard.FieldTooltipItemProperty(
        field_id="fieldId",

        # the properties below are optional
        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-dashboard-tooltipitem.html#cfn-quicksight-dashboard-tooltipitem-columntooltipitem

field_tooltip_item

The tooltip item for the fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-tooltipitem.html#cfn-quicksight-dashboard-tooltipitem-fieldtooltipitem

TooltipOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

tooltip_options_property = quicksight.CfnDashboard.TooltipOptionsProperty(
    field_based_tooltip=quicksight.CfnDashboard.FieldBasedTooltipProperty(
        aggregation_visibility="aggregationVisibility",
        tooltip_fields=[quicksight.CfnDashboard.TooltipItemProperty(
            column_tooltip_item=quicksight.CfnDashboard.ColumnTooltipItemProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),

                # the properties below are optional
                aggregation=quicksight.CfnDashboard.AggregationFunctionProperty(
                    attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                        simple_attribute_aggregation="simpleAttributeAggregation",
                        value_for_multiple_values="valueForMultipleValues"
                    ),
                    categorical_aggregation_function="categoricalAggregationFunction",
                    date_aggregation_function="dateAggregationFunction",
                    numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                        percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                            percentile_value=123
                        ),
                        simple_numerical_aggregation="simpleNumericalAggregation"
                    )
                ),
                label="label",
                tooltip_target="tooltipTarget",
                visibility="visibility"
            ),
            field_tooltip_item=quicksight.CfnDashboard.FieldTooltipItemProperty(
                field_id="fieldId",

                # the properties below are optional
                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-dashboard-tooltipoptions.html#cfn-quicksight-dashboard-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-dashboard-tooltipoptions.html#cfn-quicksight-dashboard-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-dashboard-tooltipoptions.html#cfn-quicksight-dashboard-tooltipoptions-tooltipvisibility

TopBottomFilterProperty

class CfnDashboard.TopBottomFilterProperty(*, aggregation_sort_configurations, column, filter_id, default_filter_control_configuration=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]]]]) – The aggregation and sort configuration of the top bottom filter.

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

  • filter_id (str) – An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

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

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

top_bottom_filter_property = quicksight.CfnDashboard.TopBottomFilterProperty(
    aggregation_sort_configurations=[quicksight.CfnDashboard.AggregationSortConfigurationProperty(
        column=quicksight.CfnDashboard.ColumnIdentifierProperty(
            column_name="columnName",
            data_set_identifier="dataSetIdentifier"
        ),
        sort_direction="sortDirection",

        # the properties below are optional
        aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        )
    )],
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    filter_id="filterId",

    # the properties below are optional
    default_filter_control_configuration=quicksight.CfnDashboard.DefaultFilterControlConfigurationProperty(
        control_options=quicksight.CfnDashboard.DefaultFilterControlOptionsProperty(
            default_date_time_picker_options=quicksight.CfnDashboard.DefaultDateTimePickerControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DateTimePickerControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_dropdown_options=quicksight.CfnDashboard.DefaultFilterDropDownControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.DropDownControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_list_options=quicksight.CfnDashboard.DefaultFilterListControlOptionsProperty(
                display_options=quicksight.CfnDashboard.ListControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    search_options=quicksight.CfnDashboard.ListControlSearchOptionsProperty(
                        visibility="visibility"
                    ),
                    select_all_options=quicksight.CfnDashboard.ListControlSelectAllOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                selectable_values=quicksight.CfnDashboard.FilterSelectableValuesProperty(
                    values=["values"]
                ),
                type="type"
            ),
            default_relative_date_time_options=quicksight.CfnDashboard.DefaultRelativeDateTimeControlOptionsProperty(
                commit_mode="commitMode",
                display_options=quicksight.CfnDashboard.RelativeDateTimeControlDisplayOptionsProperty(
                    date_time_format="dateTimeFormat",
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_slider_options=quicksight.CfnDashboard.DefaultSliderControlOptionsProperty(
                maximum_value=123,
                minimum_value=123,
                step_size=123,

                # the properties below are optional
                display_options=quicksight.CfnDashboard.SliderControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                ),
                type="type"
            ),
            default_text_area_options=quicksight.CfnDashboard.DefaultTextAreaControlOptionsProperty(
                delimiter="delimiter",
                display_options=quicksight.CfnDashboard.TextAreaControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            ),
            default_text_field_options=quicksight.CfnDashboard.DefaultTextFieldControlOptionsProperty(
                display_options=quicksight.CfnDashboard.TextFieldControlDisplayOptionsProperty(
                    info_icon_label_options=quicksight.CfnDashboard.SheetControlInfoIconLabelOptionsProperty(
                        info_icon_text="infoIconText",
                        visibility="visibility"
                    ),
                    placeholder_options=quicksight.CfnDashboard.TextControlPlaceholderOptionsProperty(
                        visibility="visibility"
                    ),
                    title_options=quicksight.CfnDashboard.LabelOptionsProperty(
                        custom_label="customLabel",
                        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
                            font_color="fontColor",
                            font_decoration="fontDecoration",
                            font_size=quicksight.CfnDashboard.FontSizeProperty(
                                relative="relative"
                            ),
                            font_style="fontStyle",
                            font_weight=quicksight.CfnDashboard.FontWeightProperty(
                                name="name"
                            )
                        ),
                        visibility="visibility"
                    )
                )
            )
        ),
        title="title"
    ),
    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-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-topbottomfilter-aggregationsortconfigurations

column

The column that the filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-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-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-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-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-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-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-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-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-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-dashboard-topbottomfilter.html#cfn-quicksight-dashboard-topbottomfilter-timegranularity

TopBottomMoversComputationProperty

class CfnDashboard.TopBottomMoversComputationProperty(*, computation_id, type, category=None, mover_size=None, name=None, sort_order=None, time=None, value=None)

Bases: object

The top movers and bottom movers computation setup.

Parameters:

  • computation_id (str) – The ID for a computation.

  • type (str) – The computation type. Choose from the following options:. - TOP: Top movers computation. - BOTTOM: Bottom movers computation.

  • category (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The category field that is used in 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.

  • 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-dashboard-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-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-category

computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-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-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-moversize

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-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-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-sortorder

time

The time field that is used in a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-time

type

.

  • TOP: Top movers computation.

  • BOTTOM: Bottom movers computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-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-dashboard-topbottommoverscomputation.html#cfn-quicksight-dashboard-topbottommoverscomputation-value

TopBottomRankedComputationProperty

class CfnDashboard.TopBottomRankedComputationProperty(*, computation_id, type, category=None, name=None, result_size=None, value=None)

Bases: object

The top ranked and bottom ranked computation configuration.

Parameters:

  • computation_id (str) – The ID for a computation.

  • type (str) – The computation type. Choose one of the following options:. - TOP: A top ranked computation. - BOTTOM: A bottom ranked computation.

  • category (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The category field that is used in 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

  • 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-dashboard-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-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-topbottomrankedcomputation-category

computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-topbottomrankedcomputation-computationid

name

The name of a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-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-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-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-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-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-dashboard-topbottomrankedcomputation.html#cfn-quicksight-dashboard-topbottomrankedcomputation-value

TotalAggregationComputationProperty

class CfnDashboard.TotalAggregationComputationProperty(*, computation_id, name=None, value=None)

Bases: object

The total aggregation computation configuration.

Parameters:

  • computation_id (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-dashboard-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 import aws_quicksight as quicksight

total_aggregation_computation_property = quicksight.CfnDashboard.TotalAggregationComputationProperty(
    computation_id="computationId",

    # the properties below are optional
    name="name",
    value=quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                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-dashboard-totalaggregationcomputation.html#cfn-quicksight-dashboard-totalaggregationcomputation-computationid

name

The name of a computation.

See:

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

value

The value field that is used in a computation.

See:

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

TotalAggregationFunctionProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

total_aggregation_function_property = quicksight.CfnDashboard.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-dashboard-totalaggregationfunction.html#cfn-quicksight-dashboard-totalaggregationfunction-simpletotalaggregationfunction

TotalAggregationOptionProperty

class CfnDashboard.TotalAggregationOptionProperty(*, field_id, total_aggregation_function)

Bases: object

The total aggregation settings map of a field id.

Parameters:

  • field_id (str) – The field id that’s associated with the total aggregation option.

  • total_aggregation_function (Union[IResolvable, TotalAggregationFunctionProperty, Dict[str, Any]]) – 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-dashboard-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 import aws_quicksight as quicksight

total_aggregation_option_property = quicksight.CfnDashboard.TotalAggregationOptionProperty(
    field_id="fieldId",
    total_aggregation_function=quicksight.CfnDashboard.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-dashboard-totalaggregationoption.html#cfn-quicksight-dashboard-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-dashboard-totalaggregationoption.html#cfn-quicksight-dashboard-totalaggregationoption-totalaggregationfunction

TotalOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

total_options_property = quicksight.CfnDashboard.TotalOptionsProperty(
    custom_label="customLabel",
    placement="placement",
    scroll_status="scrollStatus",
    total_aggregation_options=[quicksight.CfnDashboard.TotalAggregationOptionProperty(
        field_id="fieldId",
        total_aggregation_function=quicksight.CfnDashboard.TotalAggregationFunctionProperty(
            simple_total_aggregation_function="simpleTotalAggregationFunction"
        )
    )],
    total_cell_style=quicksight.CfnDashboard.TableCellStyleProperty(
        background_color="backgroundColor",
        border=quicksight.CfnDashboard.GlobalTableBorderOptionsProperty(
            side_specific_border=quicksight.CfnDashboard.TableSideBorderOptionsProperty(
                bottom=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_horizontal=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                inner_vertical=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                left=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                right=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                ),
                top=quicksight.CfnDashboard.TableBorderOptionsProperty(
                    color="color",
                    style="style",
                    thickness=123
                )
            ),
            uniform_border=quicksight.CfnDashboard.TableBorderOptionsProperty(
                color="color",
                style="style",
                thickness=123
            )
        ),
        font_configuration=quicksight.CfnDashboard.FontConfigurationProperty(
            font_color="fontColor",
            font_decoration="fontDecoration",
            font_size=quicksight.CfnDashboard.FontSizeProperty(
                relative="relative"
            ),
            font_style="fontStyle",
            font_weight=quicksight.CfnDashboard.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-dashboard-totaloptions.html#cfn-quicksight-dashboard-totaloptions-customlabel

placement

The placement (start, end) for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totaloptions.html#cfn-quicksight-dashboard-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-dashboard-totaloptions.html#cfn-quicksight-dashboard-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-dashboard-totaloptions.html#cfn-quicksight-dashboard-totaloptions-totalaggregationoptions

total_cell_style

Cell styling options for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totaloptions.html#cfn-quicksight-dashboard-totaloptions-totalcellstyle

totals_visibility

The visibility configuration for the total cells.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-totaloptions.html#cfn-quicksight-dashboard-totaloptions-totalsvisibility

TreeMapAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-treemapaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-treemapaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-treemapaggregatedfieldwells.html#cfn-quicksight-dashboard-treemapaggregatedfieldwells-sizes

TreeMapConfigurationProperty

class CfnDashboard.TreeMapConfigurationProperty(*, color_label_options=None, color_scale=None, data_labels=None, field_wells=None, group_label_options=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-dashboard-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-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-datalabels

field_wells

The field wells of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-grouplabeloptions

legend

The legend display setup of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-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-dashboard-treemapconfiguration.html#cfn-quicksight-dashboard-treemapconfiguration-sizelabeloptions

sort_configuration

The sort configuration of a tree map.

See:

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

tooltip

The tooltip display setup of the visual.

See:

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

TreeMapFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-treemapfieldwells.html#cfn-quicksight-dashboard-treemapfieldwells-treemapaggregatedfieldwells

TreeMapSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

tree_map_sort_configuration_property = quicksight.CfnDashboard.TreeMapSortConfigurationProperty(
    tree_map_group_items_limit_configuration=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    tree_map_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-treemapsortconfiguration.html#cfn-quicksight-dashboard-treemapsortconfiguration-treemapgroupitemslimitconfiguration

tree_map_sort

The sort configuration of group by fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapsortconfiguration.html#cfn-quicksight-dashboard-treemapsortconfiguration-treemapsort

TreeMapVisualProperty

class CfnDashboard.TreeMapVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None)

Bases: object

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-treemapvisual.html#cfn-quicksight-dashboard-treemapvisual-actions

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-treemapvisual.html#cfn-quicksight-dashboard-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-dashboard-treemapvisual.html#cfn-quicksight-dashboard-treemapvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-treemapvisual.html#cfn-quicksight-dashboard-treemapvisual-visualid

TrendArrowOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

trend_arrow_options_property = quicksight.CfnDashboard.TrendArrowOptionsProperty(
    visibility="visibility"
)

Attributes

visibility

The visibility of the trend arrows.

See:

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

UnaggregatedFieldProperty

class CfnDashboard.UnaggregatedFieldProperty(*, column, field_id, format_configuration=None)

Bases: object

The unaggregated field for a table.

Parameters:
See:

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

unaggregated_field_property = quicksight.CfnDashboard.UnaggregatedFieldProperty(
    column=quicksight.CfnDashboard.ColumnIdentifierProperty(
        column_name="columnName",
        data_set_identifier="dataSetIdentifier"
    ),
    field_id="fieldId",

    # the properties below are optional
    format_configuration=quicksight.CfnDashboard.FormatConfigurationProperty(
        date_time_format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
            date_time_format="dateTimeFormat",
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        number_format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
            format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                )
            )
        ),
        string_format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix",
                    symbol="symbol"
                ),
                number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    number_scale="numberScale",
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            symbol="symbol",
                            visibility="visibility"
                        )
                    ),
                    suffix="suffix"
                ),
                percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                    decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                        decimal_places=123
                    ),
                    negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                        display_mode="displayMode"
                    ),
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    prefix="prefix",
                    separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                        decimal_separator="decimalSeparator",
                        thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                            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-dashboard-unaggregatedfield.html#cfn-quicksight-dashboard-unaggregatedfield-column

field_id

The custom field ID.

See:

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

format_configuration

The format configuration of the field.

See:

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

UniqueValuesComputationProperty

class CfnDashboard.UniqueValuesComputationProperty(*, computation_id, category=None, name=None)

Bases: object

The unique values computation configuration.

Parameters:

  • computation_id (str) – The ID for a computation.

  • category (Union[IResolvable, DimensionFieldProperty, Dict[str, Any], None]) – The category field that is used in a computation.

  • name (Optional[str]) – The name of a computation.

See:

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

unique_values_computation_property = quicksight.CfnDashboard.UniqueValuesComputationProperty(
    computation_id="computationId",

    # the properties below are optional
    category=quicksight.CfnDashboard.DimensionFieldProperty(
        categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            date_granularity="dateGranularity",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    ),
    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-dashboard-uniquevaluescomputation.html#cfn-quicksight-dashboard-uniquevaluescomputation-category

computation_id

The ID for a computation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-uniquevaluescomputation.html#cfn-quicksight-dashboard-uniquevaluescomputation-computationid

name

The name of a computation.

See:

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

ValidationStrategyProperty

class CfnDashboard.ValidationStrategyProperty(*, mode)

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

validation_strategy_property = quicksight.CfnDashboard.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-dashboard-validationstrategy.html#cfn-quicksight-dashboard-validationstrategy-mode

VisibleRangeOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

visible_range_options_property = quicksight.CfnDashboard.VisibleRangeOptionsProperty(
    percent_range=quicksight.CfnDashboard.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-dashboard-visiblerangeoptions.html#cfn-quicksight-dashboard-visiblerangeoptions-percentrange

VisualAxisSortOptionProperty

class CfnDashboard.VisualAxisSortOptionProperty(*, availability_status=None)

Bases: object

The axis sort options for a visual.

Parameters:

availability_status (Optional[str]) – The availaiblity status of a visual’s axis sort options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualaxissortoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

visual_axis_sort_option_property = quicksight.CfnDashboard.VisualAxisSortOptionProperty(
    availability_status="availabilityStatus"
)

Attributes

availability_status

The availaiblity status of a visual’s axis sort options.

See:

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

VisualCustomActionOperationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

visual_custom_action_operation_property = quicksight.CfnDashboard.VisualCustomActionOperationProperty(
    filter_operation=quicksight.CfnDashboard.CustomActionFilterOperationProperty(
        selected_fields_configuration=quicksight.CfnDashboard.FilterOperationSelectedFieldsConfigurationProperty(
            selected_columns=[quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            )],
            selected_field_options="selectedFieldOptions",
            selected_fields=["selectedFields"]
        ),
        target_visuals_configuration=quicksight.CfnDashboard.FilterOperationTargetVisualsConfigurationProperty(
            same_sheet_target_visual_configuration=quicksight.CfnDashboard.SameSheetTargetVisualConfigurationProperty(
                target_visual_options="targetVisualOptions",
                target_visuals=["targetVisuals"]
            )
        )
    ),
    navigation_operation=quicksight.CfnDashboard.CustomActionNavigationOperationProperty(
        local_navigation_configuration=quicksight.CfnDashboard.LocalNavigationConfigurationProperty(
            target_sheet_id="targetSheetId"
        )
    ),
    set_parameters_operation=quicksight.CfnDashboard.CustomActionSetParametersOperationProperty(
        parameter_value_configurations=[quicksight.CfnDashboard.SetParameterValueConfigurationProperty(
            destination_parameter_name="destinationParameterName",
            value=quicksight.CfnDashboard.DestinationParameterValueConfigurationProperty(
                custom_values_configuration=quicksight.CfnDashboard.CustomValuesConfigurationProperty(
                    custom_values=quicksight.CfnDashboard.CustomParameterValuesProperty(
                        date_time_values=["dateTimeValues"],
                        decimal_values=[123],
                        integer_values=[123],
                        string_values=["stringValues"]
                    ),

                    # the properties below are optional
                    include_null_value=False
                ),
                select_all_value_options="selectAllValueOptions",
                source_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                source_field="sourceField",
                source_parameter_name="sourceParameterName"
            )
        )]
    ),
    url_operation=quicksight.CfnDashboard.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-dashboard-visualcustomactionoperation.html#cfn-quicksight-dashboard-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-dashboard-visualcustomactionoperation.html#cfn-quicksight-dashboard-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-dashboard-visualcustomactionoperation.html#cfn-quicksight-dashboard-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-dashboard-visualcustomactionoperation.html#cfn-quicksight-dashboard-visualcustomactionoperation-urloperation

VisualCustomActionProperty

class CfnDashboard.VisualCustomActionProperty(*, action_operations, custom_action_id, name, trigger, status=None)

Bases: object

A custom action defined on a visual.

Parameters:

  • action_operations (Union[IResolvable, Sequence[Union[IResolvable, VisualCustomActionOperationProperty, Dict[str, Any]]]]) – 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 (str) – The ID of the VisualCustomAction .

  • name (str) – The name of the VisualCustomAction .

  • trigger (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.

  • status (Optional[str]) – The status of the VisualCustomAction .

See:

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

visual_custom_action_property = quicksight.CfnDashboard.VisualCustomActionProperty(
    action_operations=[quicksight.CfnDashboard.VisualCustomActionOperationProperty(
        filter_operation=quicksight.CfnDashboard.CustomActionFilterOperationProperty(
            selected_fields_configuration=quicksight.CfnDashboard.FilterOperationSelectedFieldsConfigurationProperty(
                selected_columns=[quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                )],
                selected_field_options="selectedFieldOptions",
                selected_fields=["selectedFields"]
            ),
            target_visuals_configuration=quicksight.CfnDashboard.FilterOperationTargetVisualsConfigurationProperty(
                same_sheet_target_visual_configuration=quicksight.CfnDashboard.SameSheetTargetVisualConfigurationProperty(
                    target_visual_options="targetVisualOptions",
                    target_visuals=["targetVisuals"]
                )
            )
        ),
        navigation_operation=quicksight.CfnDashboard.CustomActionNavigationOperationProperty(
            local_navigation_configuration=quicksight.CfnDashboard.LocalNavigationConfigurationProperty(
                target_sheet_id="targetSheetId"
            )
        ),
        set_parameters_operation=quicksight.CfnDashboard.CustomActionSetParametersOperationProperty(
            parameter_value_configurations=[quicksight.CfnDashboard.SetParameterValueConfigurationProperty(
                destination_parameter_name="destinationParameterName",
                value=quicksight.CfnDashboard.DestinationParameterValueConfigurationProperty(
                    custom_values_configuration=quicksight.CfnDashboard.CustomValuesConfigurationProperty(
                        custom_values=quicksight.CfnDashboard.CustomParameterValuesProperty(
                            date_time_values=["dateTimeValues"],
                            decimal_values=[123],
                            integer_values=[123],
                            string_values=["stringValues"]
                        ),

                        # the properties below are optional
                        include_null_value=False
                    ),
                    select_all_value_options="selectAllValueOptions",
                    source_column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                        column_name="columnName",
                        data_set_identifier="dataSetIdentifier"
                    ),
                    source_field="sourceField",
                    source_parameter_name="sourceParameterName"
                )
            )]
        ),
        url_operation=quicksight.CfnDashboard.CustomActionURLOperationProperty(
            url_target="urlTarget",
            url_template="urlTemplate"
        )
    )],
    custom_action_id="customActionId",
    name="name",
    trigger="trigger",

    # the properties below are optional
    status="status"
)

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-dashboard-visualcustomaction.html#cfn-quicksight-dashboard-visualcustomaction-actionoperations

custom_action_id

The ID of the VisualCustomAction .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomaction.html#cfn-quicksight-dashboard-visualcustomaction-customactionid

name

The name of the VisualCustomAction .

See:

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

status

The status of the VisualCustomAction .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visualcustomaction.html#cfn-quicksight-dashboard-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-dashboard-visualcustomaction.html#cfn-quicksight-dashboard-visualcustomaction-trigger

VisualMenuOptionProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

visual_menu_option_property = quicksight.CfnDashboard.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-dashboard-visualmenuoption.html#cfn-quicksight-dashboard-visualmenuoption-availabilitystatus

VisualPaletteProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

visual_palette_property = quicksight.CfnDashboard.VisualPaletteProperty(
    chart_color="chartColor",
    color_map=[quicksight.CfnDashboard.DataPathColorProperty(
        color="color",
        element=quicksight.CfnDashboard.DataPathValueProperty(
            data_path_type=quicksight.CfnDashboard.DataPathTypeProperty(
                pivot_table_data_path_type="pivotTableDataPathType"
            ),
            field_id="fieldId",
            field_value="fieldValue"
        ),

        # the properties below are optional
        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-dashboard-visualpalette.html#cfn-quicksight-dashboard-visualpalette-chartcolor

color_map

The color map options for the visual palette.

See:

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

VisualProperty

class CfnDashboard.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, 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-dashboard-visual.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
bar_chart_visual

A bar chart.

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

See:

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

box_plot_visual

A box plot.

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

See:

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

combo_chart_visual

A combo chart.

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

See:

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

custom_content_visual

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-customcontentvisual

empty_visual

An empty visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-emptyvisual

filled_map_visual

A filled map.

For more information, see Creating filled maps in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-filledmapvisual

funnel_chart_visual

A funnel chart.

For more information, see Using funnel charts in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-funnelchartvisual

gauge_chart_visual

A gauge chart.

For more information, see Using gauge charts in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-gaugechartvisual

geospatial_map_visual

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-geospatialmapvisual

heat_map_visual

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-heatmapvisual

histogram_visual

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-histogramvisual

insight_visual

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-insightvisual

kpi_visual

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-kpivisual

line_chart_visual

A line chart.

For more information, see Using line charts in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-linechartvisual

pie_chart_visual

A pie or donut chart.

For more information, see Using pie charts in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-piechartvisual

pivot_table_visual

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-pivottablevisual

radar_chart_visual

A radar chart visual.

For more information, see Using radar charts in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-radarchartvisual

sankey_diagram_visual

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-sankeydiagramvisual

scatter_plot_visual

A scatter plot.

For more information, see Using scatter plots in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-scatterplotvisual

table_visual

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-tablevisual

tree_map_visual

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-treemapvisual

waterfall_visual

A waterfall chart.

For more information, see Using waterfall charts in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-waterfallvisual

word_cloud_visual

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-wordcloudvisual

VisualSubtitleLabelOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

visual_subtitle_label_options_property = quicksight.CfnDashboard.VisualSubtitleLabelOptionsProperty(
    format_text=quicksight.CfnDashboard.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-dashboard-visualsubtitlelabeloptions.html#cfn-quicksight-dashboard-visualsubtitlelabeloptions-formattext

visibility

The visibility of the subtitle label.

See:

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

VisualTitleLabelOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

visual_title_label_options_property = quicksight.CfnDashboard.VisualTitleLabelOptionsProperty(
    format_text=quicksight.CfnDashboard.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-dashboard-visualtitlelabeloptions.html#cfn-quicksight-dashboard-visualtitlelabeloptions-formattext

visibility

The visibility of the title label.

See:

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

WaterfallChartAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-waterfallchartaggregatedfieldwells.html#cfn-quicksight-dashboard-waterfallchartaggregatedfieldwells-breakdowns

categories

The category field wells of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartaggregatedfieldwells.html#cfn-quicksight-dashboard-waterfallchartaggregatedfieldwells-categories

values

The value field wells of a waterfall visual.

See:

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

WaterfallChartColorConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

waterfall_chart_color_configuration_property = quicksight.CfnDashboard.WaterfallChartColorConfigurationProperty(
    group_color_configuration=quicksight.CfnDashboard.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-dashboard-waterfallchartcolorconfiguration.html#cfn-quicksight-dashboard-waterfallchartcolorconfiguration-groupcolorconfiguration

WaterfallChartConfigurationProperty

class CfnDashboard.WaterfallChartConfigurationProperty(*, category_axis_display_options=None, category_axis_label_options=None, color_configuration=None, data_labels=None, field_wells=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-dashboard-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-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-categoryaxislabeloptions

color_configuration

The color configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-colorconfiguration

data_labels

The data label configuration of a waterfall visual.

See:

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

field_wells

The field well configuration of a waterfall visual.

See:

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

legend

The legend configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-primaryyaxislabeloptions

sort_configuration

The sort configuration of a waterfall visual.

See:

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

visual_palette

The visual palette configuration of a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-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-dashboard-waterfallchartconfiguration.html#cfn-quicksight-dashboard-waterfallchartconfiguration-waterfallchartoptions

WaterfallChartFieldWellsProperty

class CfnDashboard.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-dashboard-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-dashboard-waterfallchartfieldwells.html#cfn-quicksight-dashboard-waterfallchartfieldwells-waterfallchartaggregatedfieldwells

WaterfallChartGroupColorConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

waterfall_chart_group_color_configuration_property = quicksight.CfnDashboard.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-dashboard-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-dashboard-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-dashboard-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-dashboard-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-dashboard-waterfallchartgroupcolorconfiguration.html#cfn-quicksight-dashboard-waterfallchartgroupcolorconfiguration-totalbarcolor

WaterfallChartOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

waterfall_chart_options_property = quicksight.CfnDashboard.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-dashboard-waterfallchartoptions.html#cfn-quicksight-dashboard-waterfallchartoptions-totalbarlabel

WaterfallChartSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

waterfall_chart_sort_configuration_property = quicksight.CfnDashboard.WaterfallChartSortConfigurationProperty(
    breakdown_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-waterfallchartsortconfiguration.html#cfn-quicksight-dashboard-waterfallchartsortconfiguration-breakdownitemslimit

category_sort

The sort configuration of the category fields.

See:

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

WaterfallVisualProperty

class CfnDashboard.WaterfallVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None)

Bases: object

A waterfall chart.

For more information, see Using waterfall charts in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-waterfallvisual-actions

chart_configuration

The configuration for a waterfall visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-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-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-waterfallvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-waterfallvisual.html#cfn-quicksight-dashboard-waterfallvisual-visualid

WhatIfPointScenarioProperty

class CfnDashboard.WhatIfPointScenarioProperty(*, date, value)

Bases: object

Provides the forecast to meet the target for a particular date.

Parameters:

  • date (str) – The date that you need the forecast results for.

  • value (Union[int, float]) – 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-dashboard-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 import aws_quicksight as quicksight

what_if_point_scenario_property = quicksight.CfnDashboard.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-dashboard-whatifpointscenario.html#cfn-quicksight-dashboard-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-dashboard-whatifpointscenario.html#cfn-quicksight-dashboard-whatifpointscenario-value

WhatIfRangeScenarioProperty

class CfnDashboard.WhatIfRangeScenarioProperty(*, end_date, start_date, value)

Bases: object

Provides the forecast to meet the target for a particular date range.

Parameters:

  • end_date (str) – The end date in the date range that you need the forecast results for.

  • start_date (str) – The start date in the date range that you need the forecast results for.

  • value (Union[int, float]) – 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-dashboard-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 import aws_quicksight as quicksight

what_if_range_scenario_property = quicksight.CfnDashboard.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-dashboard-whatifrangescenario.html#cfn-quicksight-dashboard-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-dashboard-whatifrangescenario.html#cfn-quicksight-dashboard-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-dashboard-whatifrangescenario.html#cfn-quicksight-dashboard-whatifrangescenario-value

WordCloudAggregatedFieldWellsProperty

class CfnDashboard.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-dashboard-wordcloudaggregatedfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

word_cloud_aggregated_field_wells_property = quicksight.CfnDashboard.WordCloudAggregatedFieldWellsProperty(
    group_by=[quicksight.CfnDashboard.DimensionFieldProperty(
        categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            date_granularity="dateGranularity",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        ),
        numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            ),
            hierarchy_id="hierarchyId"
        )
    )],
    size=[quicksight.CfnDashboard.MeasureFieldProperty(
        calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
            expression="expression",
            field_id="fieldId"
        ),
        categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function="aggregationFunction",
            format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                date_time_format="dateTimeFormat",
                null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                    null_string="nullString"
                ),
                numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        ),
        numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
            column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),
            field_id="fieldId",

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            ),
            format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                    currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix",
                        symbol="symbol"
                    ),
                    number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        number_scale="numberScale",
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    ),
                    percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                        decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                            decimal_places=123
                        ),
                        negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                            display_mode="displayMode"
                        ),
                        null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                            null_string="nullString"
                        ),
                        prefix="prefix",
                        separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                            decimal_separator="decimalSeparator",
                            thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                symbol="symbol",
                                visibility="visibility"
                            )
                        ),
                        suffix="suffix"
                    )
                )
            )
        )
    )]
)

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-dashboard-wordcloudaggregatedfieldwells.html#cfn-quicksight-dashboard-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-dashboard-wordcloudaggregatedfieldwells.html#cfn-quicksight-dashboard-wordcloudaggregatedfieldwells-size

WordCloudChartConfigurationProperty

class CfnDashboard.WordCloudChartConfigurationProperty(*, category_label_options=None, field_wells=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-dashboard-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-dashboard-wordcloudchartconfiguration.html#cfn-quicksight-dashboard-wordcloudchartconfiguration-categorylabeloptions

field_wells

The field wells of the visual.

See:

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

sort_configuration

The sort configuration of a word cloud visual.

See:

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

word_cloud_options

The options for a word cloud visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudchartconfiguration.html#cfn-quicksight-dashboard-wordcloudchartconfiguration-wordcloudoptions

WordCloudFieldWellsProperty

class CfnDashboard.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-dashboard-wordcloudfieldwells.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

word_cloud_field_wells_property = quicksight.CfnDashboard.WordCloudFieldWellsProperty(
    word_cloud_aggregated_field_wells=quicksight.CfnDashboard.WordCloudAggregatedFieldWellsProperty(
        group_by=[quicksight.CfnDashboard.DimensionFieldProperty(
            categorical_dimension_field=quicksight.CfnDashboard.CategoricalDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            ),
            date_dimension_field=quicksight.CfnDashboard.DateDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                date_granularity="dateGranularity",
                format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                    date_time_format="dateTimeFormat",
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            ),
            numerical_dimension_field=quicksight.CfnDashboard.NumericalDimensionFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                ),
                hierarchy_id="hierarchyId"
            )
        )],
        size=[quicksight.CfnDashboard.MeasureFieldProperty(
            calculated_measure_field=quicksight.CfnDashboard.CalculatedMeasureFieldProperty(
                expression="expression",
                field_id="fieldId"
            ),
            categorical_measure_field=quicksight.CfnDashboard.CategoricalMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function="aggregationFunction",
                format_configuration=quicksight.CfnDashboard.StringFormatConfigurationProperty(
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            date_measure_field=quicksight.CfnDashboard.DateMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function="aggregationFunction",
                format_configuration=quicksight.CfnDashboard.DateTimeFormatConfigurationProperty(
                    date_time_format="dateTimeFormat",
                    null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                        null_string="nullString"
                    ),
                    numeric_format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            ),
            numerical_measure_field=quicksight.CfnDashboard.NumericalMeasureFieldProperty(
                column=quicksight.CfnDashboard.ColumnIdentifierProperty(
                    column_name="columnName",
                    data_set_identifier="dataSetIdentifier"
                ),
                field_id="fieldId",

                # the properties below are optional
                aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                ),
                format_configuration=quicksight.CfnDashboard.NumberFormatConfigurationProperty(
                    format_configuration=quicksight.CfnDashboard.NumericFormatConfigurationProperty(
                        currency_display_format_configuration=quicksight.CfnDashboard.CurrencyDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix",
                            symbol="symbol"
                        ),
                        number_display_format_configuration=quicksight.CfnDashboard.NumberDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            number_scale="numberScale",
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        ),
                        percentage_display_format_configuration=quicksight.CfnDashboard.PercentageDisplayFormatConfigurationProperty(
                            decimal_places_configuration=quicksight.CfnDashboard.DecimalPlacesConfigurationProperty(
                                decimal_places=123
                            ),
                            negative_value_configuration=quicksight.CfnDashboard.NegativeValueConfigurationProperty(
                                display_mode="displayMode"
                            ),
                            null_value_format_configuration=quicksight.CfnDashboard.NullValueFormatConfigurationProperty(
                                null_string="nullString"
                            ),
                            prefix="prefix",
                            separator_configuration=quicksight.CfnDashboard.NumericSeparatorConfigurationProperty(
                                decimal_separator="decimalSeparator",
                                thousands_separator=quicksight.CfnDashboard.ThousandSeparatorOptionsProperty(
                                    symbol="symbol",
                                    visibility="visibility"
                                )
                            ),
                            suffix="suffix"
                        )
                    )
                )
            )
        )]
    )
)

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-dashboard-wordcloudfieldwells.html#cfn-quicksight-dashboard-wordcloudfieldwells-wordcloudaggregatedfieldwells

WordCloudOptionsProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

word_cloud_options_property = quicksight.CfnDashboard.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-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-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-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-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-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-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-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-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-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-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-dashboard-wordcloudoptions.html#cfn-quicksight-dashboard-wordcloudoptions-wordscaling

WordCloudSortConfigurationProperty

class CfnDashboard.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-dashboard-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 import aws_quicksight as quicksight

word_cloud_sort_configuration_property = quicksight.CfnDashboard.WordCloudSortConfigurationProperty(
    category_items_limit=quicksight.CfnDashboard.ItemsLimitConfigurationProperty(
        items_limit=123,
        other_categories="otherCategories"
    ),
    category_sort=[quicksight.CfnDashboard.FieldSortOptionsProperty(
        column_sort=quicksight.CfnDashboard.ColumnSortProperty(
            direction="direction",
            sort_by=quicksight.CfnDashboard.ColumnIdentifierProperty(
                column_name="columnName",
                data_set_identifier="dataSetIdentifier"
            ),

            # the properties below are optional
            aggregation_function=quicksight.CfnDashboard.AggregationFunctionProperty(
                attribute_aggregation_function=quicksight.CfnDashboard.AttributeAggregationFunctionProperty(
                    simple_attribute_aggregation="simpleAttributeAggregation",
                    value_for_multiple_values="valueForMultipleValues"
                ),
                categorical_aggregation_function="categoricalAggregationFunction",
                date_aggregation_function="dateAggregationFunction",
                numerical_aggregation_function=quicksight.CfnDashboard.NumericalAggregationFunctionProperty(
                    percentile_aggregation=quicksight.CfnDashboard.PercentileAggregationProperty(
                        percentile_value=123
                    ),
                    simple_numerical_aggregation="simpleNumericalAggregation"
                )
            )
        ),
        field_sort=quicksight.CfnDashboard.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-dashboard-wordcloudsortconfiguration.html#cfn-quicksight-dashboard-wordcloudsortconfiguration-categoryitemslimit

category_sort

The sort configuration of group by fields.

See:

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

WordCloudVisualProperty

class CfnDashboard.WordCloudVisualProperty(*, visual_id, actions=None, chart_configuration=None, column_hierarchies=None, subtitle=None, title=None)

Bases: object

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-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-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-wordcloudvisual-actions

chart_configuration

The configuration settings of the visual.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-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-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-wordcloudvisual-columnhierarchies

subtitle

The subtitle that is displayed on the visual.

See:

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

title

The title that is displayed on the visual.

See:

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

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-dashboard-wordcloudvisual.html#cfn-quicksight-dashboard-wordcloudvisual-visualid

YAxisOptionsProperty

class CfnDashboard.YAxisOptionsProperty(*, y_axis)

Bases: object

The options that are available for a single Y axis in a chart.

Parameters:

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

y_axis_options_property = quicksight.CfnDashboard.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-dashboard-yaxisoptions.html#cfn-quicksight-dashboard-yaxisoptions-yaxis