CfnDashboard

class aws_cdk.aws_quicksight.CfnDashboard(scope, id, *, aws_account_id, dashboard_id, name, dashboard_publish_options=None, definition=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 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

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