CfnDataSet

class aws_cdk.aws_quicksight.CfnDataSet(scope, id, *, aws_account_id=None, column_groups=None, column_level_permission_rules=None, data_prep_configuration=None, data_set_id=None, dataset_parameters=None, data_set_refresh_properties=None, data_set_usage_configuration=None, field_folders=None, folder_arns=None, import_mode=None, ingestion_wait_policy=None, logical_table_map=None, name=None, performance_configuration=None, permissions=None, physical_table_map=None, row_level_permission_data_set=None, row_level_permission_tag_configuration=None, semantic_model_configuration=None, tags=None, use_as=None)

Bases: CfnResource

Creates a dataset.

This operation doesn’t support datasets that include uploaded files as a source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html
CloudformationResource:: AWS::QuickSight::DataSet
ExampleMetadata:: fixture=_generated

Example:

Create a new AWS::QuickSight::DataSet.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
aws_account_id (Optional[str]) – The AWS account ID.
column_groups (Union[IResolvable, Sequence[Union[IResolvable, ColumnGroupProperty, Dict[str, Any]]], None]) – Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.
column_level_permission_rules (Union[IResolvable, Sequence[Union[IResolvable, ColumnLevelPermissionRuleProperty, Dict[str, Any]]], None]) – A set of one or more definitions of a ColumnLevelPermissionRule .
data_prep_configuration (Union[IResolvable, DataPrepConfigurationProperty, Dict[str, Any], None]) – The data preparation configuration associated with this dataset.
data_set_id (Optional[str]) – An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
dataset_parameters (Union[IResolvable, Sequence[Union[IResolvable, DatasetParameterProperty, Dict[str, Any]]], None]) – The parameters that are declared in a dataset.
data_set_refresh_properties (Union[IResolvable, DataSetRefreshPropertiesProperty, Dict[str, Any], None]) – The refresh properties of a dataset.
data_set_usage_configuration (Union[IResolvable, DataSetUsageConfigurationProperty, Dict[str, Any], None]) – The usage configuration to apply to child datasets that reference this dataset as a source.
field_folders (Union[IResolvable, Mapping[str, Union[IResolvable, FieldFolderProperty, Dict[str, Any]]], None]) – The folder that contains fields and nested subfolders for your dataset.
folder_arns (Optional[Sequence[str]])
import_mode (Optional[str]) – Indicates whether you want to import the data into SPICE.
ingestion_wait_policy (Union[IResolvable, IngestionWaitPolicyProperty, Dict[str, Any], None]) – The wait policy to use when creating or updating a Dataset. The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
logical_table_map (Union[IResolvable, Mapping[str, Union[IResolvable, LogicalTableProperty, Dict[str, Any]]], None])
name (Optional[str]) – The display name for the dataset.
performance_configuration (Union[IResolvable, PerformanceConfigurationProperty, Dict[str, Any], None]) – The performance optimization configuration of a dataset.
permissions (Union[IResolvable, Sequence[Union[IResolvable, ResourcePermissionProperty, Dict[str, Any]]], None]) – A list of resource permissions on the dataset.
physical_table_map (Union[IResolvable, Mapping[str, Union[IResolvable, PhysicalTableProperty, Dict[str, Any]]], None]) – Declares the physical tables that are available in the underlying data sources.
row_level_permission_data_set (Union[IResolvable, RowLevelPermissionDataSetProperty, Dict[str, Any], None]) – (deprecated) Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide. The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
row_level_permission_tag_configuration (Union[IResolvable, RowLevelPermissionTagConfigurationProperty, Dict[str, Any], None]) – (deprecated) The configuration of tags on a dataset to set row-level security.
semantic_model_configuration (Union[IResolvable, SemanticModelConfigurationProperty, Dict[str, Any], None]) – The semantic model configuration associated with this dataset.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
use_as (Optional[str]) – The usage of the dataset.

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:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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::DataSet'

attr_arn

The Amazon Resource Name (ARN) of the dataset.

CloudformationAttribute:: Arn

attr_consumed_spice_capacity_in_bytes

This is 0 if the dataset isn’t imported into SPICE.

CloudformationAttribute:: ConsumedSpiceCapacityInBytes

attr_created_time

The time this dataset version was created.

CloudformationAttribute:: CreatedTime

attr_last_updated_time

The time this dataset version was last updated.

CloudformationAttribute:: LastUpdatedTime

attr_output_columns

These columns are available in templates, analyses, and dashboards.

CloudformationAttribute:: OutputColumns

aws_account_id: The AWS account ID.

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

cfn_resource_type: AWS resource type.

column_groups: Groupings of columns that work together in certain Amazon Quick Sight features.

column_level_permission_rules: A set of one or more definitions of a ColumnLevelPermissionRule .

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.

data_prep_configuration: The data preparation configuration associated with this dataset.

data_set_id: An ID for the dataset that you want to create.

data_set_ref: A reference to a DataSet resource.

data_set_refresh_properties: The refresh properties of a dataset.

data_set_usage_configuration: The usage configuration to apply to child datasets that reference this dataset as a source.

dataset_parameters: The parameters that are declared in a dataset.

env

field_folders: The folder that contains fields and nested subfolders for your dataset.

folder_arns

import_mode: Indicates whether you want to import the data into SPICE.

ingestion_wait_policy: The wait policy to use when creating or updating a Dataset.

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.

logical_table_map

this property has been deprecated

Stability:: deprecated
Type:: deprecated

name: The display name for the dataset.

node: The tree node.

performance_configuration: The performance optimization configuration of a dataset.

permissions: A list of resource permissions on the dataset.

physical_table_map: Declares the physical tables that are available in the underlying data sources.

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 }).

row_level_permission_data_set

(deprecated) Information about a dataset that contains permissions for row-level security (RLS).

Deprecated:: this property has been deprecated
Stability:: deprecated

row_level_permission_tag_configuration

(deprecated) The configuration of tags on a dataset to set row-level security.

Deprecated:: this property has been deprecated
Stability:: deprecated

semantic_model_configuration: The semantic model configuration associated with this dataset.

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

use_as: The usage of the dataset.

Static Methods

classmethod arn_for_data_set(resource)

Parameters:: resource (IDataSetRef)
Return type:: str

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.

AggregateOperationProperty

class CfnDataSet.AggregateOperationProperty(*, aggregations, alias, source, group_by_column_names=None)

Bases: object

A transform operation that groups rows by specified columns and applies aggregation functions to calculate summary values.

Parameters:

aggregations (Union[IResolvable, Sequence[Union[IResolvable, AggregationProperty, Dict[str, Any]]]]) – The list of aggregation functions to apply to the grouped data, such as SUM , COUNT , or AVERAGE .
alias (str) – Alias for this operation.
source (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any]]) – The source transform operation that provides input data for the aggregation.
group_by_column_names (Optional[Sequence[str]]) – The list of column names to group by when performing the aggregation. Rows with the same values in these columns will be grouped together.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

aggregate_operation_property = quicksight.CfnDataSet.AggregateOperationProperty(
    aggregations=[quicksight.CfnDataSet.AggregationProperty(
        aggregation_function=quicksight.CfnDataSet.DataPrepAggregationFunctionProperty(
            list_aggregation=quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
                distinct=False,
                separator="separator",

                # the properties below are optional
                input_column_name="inputColumnName"
            ),
            percentile_aggregation=quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
                percentile_value=123,

                # the properties below are optional
                input_column_name="inputColumnName"
            ),
            simple_aggregation=quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
                function_type="functionType",

                # the properties below are optional
                input_column_name="inputColumnName"
            )
        ),
        new_column_id="newColumnId",
        new_column_name="newColumnName"
    )],
    alias="alias",
    source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    ),

    # the properties below are optional
    group_by_column_names=["groupByColumnNames"]
)

Attributes

aggregations

The list of aggregation functions to apply to the grouped data, such as SUM , COUNT , or AVERAGE .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-aggregations

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-alias

group_by_column_names

The list of column names to group by when performing the aggregation.

Rows with the same values in these columns will be grouped together.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-groupbycolumnnames

source

The source transform operation that provides input data for the aggregation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-source

AggregationProperty

class CfnDataSet.AggregationProperty(*, aggregation_function, new_column_id, new_column_name)

Bases: object

Defines an aggregation function to be applied to grouped data, creating a new column with the calculated result.

Parameters:

aggregation_function (Union[IResolvable, DataPrepAggregationFunctionProperty, Dict[str, Any]]) – The aggregation function to apply, such as SUM , COUNT , AVERAGE , MIN , MAX.
new_column_id (str) – A unique identifier for the new column that will contain the aggregated values.
new_column_name (str) – The name for the new column that will contain the aggregated values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below 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_property = quicksight.CfnDataSet.AggregationProperty(
    aggregation_function=quicksight.CfnDataSet.DataPrepAggregationFunctionProperty(
        list_aggregation=quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
            distinct=False,
            separator="separator",

            # the properties below are optional
            input_column_name="inputColumnName"
        ),
        percentile_aggregation=quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
            percentile_value=123,

            # the properties below are optional
            input_column_name="inputColumnName"
        ),
        simple_aggregation=quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
            function_type="functionType",

            # the properties below are optional
            input_column_name="inputColumnName"
        )
    ),
    new_column_id="newColumnId",
    new_column_name="newColumnName"
)

Attributes

aggregation_function

The aggregation function to apply, such as SUM , COUNT , AVERAGE , MIN , MAX.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html#cfn-quicksight-dataset-aggregation-aggregationfunction

new_column_id

A unique identifier for the new column that will contain the aggregated values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html#cfn-quicksight-dataset-aggregation-newcolumnid

new_column_name

The name for the new column that will contain the aggregated values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html#cfn-quicksight-dataset-aggregation-newcolumnname

AppendOperationProperty

class CfnDataSet.AppendOperationProperty(*, alias, appended_columns, first_source=None, second_source=None)

Bases: object

A transform operation that combines rows from two data sources by stacking them vertically (union operation).

Parameters:

alias (str) – Alias for this operation.
appended_columns (Union[IResolvable, Sequence[Union[IResolvable, AppendedColumnProperty, Dict[str, Any]]]]) – The list of columns to include in the appended result, mapping columns from both sources.
first_source (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any], None]) – The first data source to be included in the append operation.
second_source (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any], None]) – The second data source to be appended to the first source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

append_operation_property = quicksight.CfnDataSet.AppendOperationProperty(
    alias="alias",
    appended_columns=[quicksight.CfnDataSet.AppendedColumnProperty(
        column_name="columnName",
        new_column_id="newColumnId"
    )],

    # the properties below are optional
    first_source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    ),
    second_source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    )
)

Attributes

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendoperation.html#cfn-quicksight-dataset-appendoperation-alias

appended_columns

The list of columns to include in the appended result, mapping columns from both sources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendoperation.html#cfn-quicksight-dataset-appendoperation-appendedcolumns

first_source

The first data source to be included in the append operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendoperation.html#cfn-quicksight-dataset-appendoperation-firstsource

second_source

The second data source to be appended to the first source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendoperation.html#cfn-quicksight-dataset-appendoperation-secondsource

AppendedColumnProperty

class CfnDataSet.AppendedColumnProperty(*, column_name, new_column_id)

Bases: object

Represents a column that will be included in the result of an append operation, combining data from multiple sources.

Parameters:

column_name (str) – The name of the column to include in the appended result.
new_column_id (str) – A unique identifier for the column in the appended result.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendedcolumn.html

ExampleMetadata:

fixture=_generated

Example:

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

appended_column_property = quicksight.CfnDataSet.AppendedColumnProperty(
    column_name="columnName",
    new_column_id="newColumnId"
)

Attributes

column_name

The name of the column to include in the appended result.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendedcolumn.html#cfn-quicksight-dataset-appendedcolumn-columnname

new_column_id

A unique identifier for the column in the appended result.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-appendedcolumn.html#cfn-quicksight-dataset-appendedcolumn-newcolumnid

CalculatedColumnProperty

class CfnDataSet.CalculatedColumnProperty(*, column_id, column_name, expression)

Bases: object

A calculated column for a dataset.

Parameters:

column_id (str) – A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.
column_name (str) – Column name.
expression (str) – An expression that defines the calculated column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-calculatedcolumn.html

ExampleMetadata:

fixture=_generated

Example:

# The code below 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_column_property = quicksight.CfnDataSet.CalculatedColumnProperty(
    column_id="columnId",
    column_name="columnName",
    expression="expression"
)

Attributes

column_id

A unique ID to identify a calculated column.

During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-calculatedcolumn.html#cfn-quicksight-dataset-calculatedcolumn-columnid

column_name

Column name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-calculatedcolumn.html#cfn-quicksight-dataset-calculatedcolumn-columnname

expression

An expression that defines the calculated column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-calculatedcolumn.html#cfn-quicksight-dataset-calculatedcolumn-expression

CastColumnTypeOperationProperty

class CfnDataSet.CastColumnTypeOperationProperty(*, column_name, new_column_type, format=None, sub_type=None)

Bases: object

A transform operation that casts a column to a different type.

Parameters:

column_name (str) – Column name.
new_column_type (str) – New column data type.
format (Optional[str]) – When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.
sub_type (Optional[str]) – The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

cast_column_type_operation_property = quicksight.CfnDataSet.CastColumnTypeOperationProperty(
    column_name="columnName",
    new_column_type="newColumnType",

    # the properties below are optional
    format="format",
    sub_type="subType"
)

Attributes

column_name

Column name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html#cfn-quicksight-dataset-castcolumntypeoperation-columnname

format

When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html#cfn-quicksight-dataset-castcolumntypeoperation-format

new_column_type

New column data type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html#cfn-quicksight-dataset-castcolumntypeoperation-newcolumntype

sub_type

The sub data type of the new column.

Sub types are only available for decimal columns that are part of a SPICE dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html#cfn-quicksight-dataset-castcolumntypeoperation-subtype

CastColumnTypesOperationProperty

class CfnDataSet.CastColumnTypesOperationProperty(*, alias, cast_column_type_operations, source)

Bases: object

A transform operation that changes the data types of one or more columns in the dataset.

Parameters:

alias (str) – Alias for this operation.
cast_column_type_operations (Union[IResolvable, Sequence[Union[IResolvable, CastColumnTypeOperationProperty, Dict[str, Any]]]]) – The list of column type casting operations to perform.
source (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any]]) – The source transform operation that provides input data for the type casting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypesoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

cast_column_types_operation_property = quicksight.CfnDataSet.CastColumnTypesOperationProperty(
    alias="alias",
    cast_column_type_operations=[quicksight.CfnDataSet.CastColumnTypeOperationProperty(
        column_name="columnName",
        new_column_type="newColumnType",

        # the properties below are optional
        format="format",
        sub_type="subType"
    )],
    source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    )
)

Attributes

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypesoperation.html#cfn-quicksight-dataset-castcolumntypesoperation-alias

cast_column_type_operations

The list of column type casting operations to perform.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypesoperation.html#cfn-quicksight-dataset-castcolumntypesoperation-castcolumntypeoperations

source

The source transform operation that provides input data for the type casting.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypesoperation.html#cfn-quicksight-dataset-castcolumntypesoperation-source

ColumnDescriptionProperty

class CfnDataSet.ColumnDescriptionProperty(*, text=None)

Bases: object

Metadata that contains a description for a column.

Parameters:: text (Optional[str]) – The text of a description for a column.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columndescription.html
ExampleMetadata:: fixture=_generated

Example:

# The code below 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_description_property = quicksight.CfnDataSet.ColumnDescriptionProperty(
    text="text"
)

Attributes

text

The text of a description for a column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columndescription.html#cfn-quicksight-dataset-columndescription-text

ColumnGroupProperty

class CfnDataSet.ColumnGroupProperty(*, geo_spatial_column_group=None)

Bases: object

Groupings of columns that work together in certain Quick Sight features.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Parameters:: geo_spatial_column_group (Union[IResolvable, GeoSpatialColumnGroupProperty, Dict[str, Any], None]) – Geospatial column group that denotes a hierarchy.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columngroup.html
ExampleMetadata:: fixture=_generated

Example:

# The code below 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_group_property = quicksight.CfnDataSet.ColumnGroupProperty(
    geo_spatial_column_group=quicksight.CfnDataSet.GeoSpatialColumnGroupProperty(
        columns=["columns"],
        name="name",

        # the properties below are optional
        country_code="countryCode"
    )
)

Attributes

geo_spatial_column_group

Geospatial column group that denotes a hierarchy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columngroup.html#cfn-quicksight-dataset-columngroup-geospatialcolumngroup

ColumnLevelPermissionRuleProperty

class CfnDataSet.ColumnLevelPermissionRuleProperty(*, column_names=None, principals=None)

Bases: object

A rule defined to grant access on one or more restricted columns.

Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.

Parameters:

column_names (Optional[Sequence[str]]) – An array of column names.
principals (Optional[Sequence[str]]) – An array of Amazon Resource Names (ARNs) for Quick Suite users or groups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html

ExampleMetadata:

fixture=_generated

Example:

# The code below 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_level_permission_rule_property = quicksight.CfnDataSet.ColumnLevelPermissionRuleProperty(
    column_names=["columnNames"],
    principals=["principals"]
)

Attributes

column_names

An array of column names.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html#cfn-quicksight-dataset-columnlevelpermissionrule-columnnames

principals

An array of Amazon Resource Names (ARNs) for Quick Suite users or groups.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html#cfn-quicksight-dataset-columnlevelpermissionrule-principals

ColumnTagProperty

class CfnDataSet.ColumnTagProperty(*, column_description=None, column_geographic_role=None)

Bases: object

A tag for a column in a [TagColumnOperation](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html) structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Parameters:

column_description (Union[IResolvable, ColumnDescriptionProperty, Dict[str, Any], None]) – A description for a column.
column_geographic_role (Optional[str]) – A geospatial role for a column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntag.html

ExampleMetadata:

fixture=_generated

Example:

# The code below 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_tag_property = quicksight.CfnDataSet.ColumnTagProperty(
    column_description=quicksight.CfnDataSet.ColumnDescriptionProperty(
        text="text"
    ),
    column_geographic_role="columnGeographicRole"
)

Attributes

column_description

A description for a column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntag.html#cfn-quicksight-dataset-columntag-columndescription

column_geographic_role

A geospatial role for a column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntag.html#cfn-quicksight-dataset-columntag-columngeographicrole

ColumnToUnpivotProperty

class CfnDataSet.ColumnToUnpivotProperty(*, column_name=None, new_value=None)

Bases: object

Specifies a column to be unpivoted, transforming it from a column into rows with associated values.

Parameters:

column_name (Optional[str]) – The name of the column to unpivot from the source data.
new_value (Optional[str]) – The value to assign to this column in the unpivoted result, typically the column name or a descriptive label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntounpivot.html

ExampleMetadata:

fixture=_generated

Example:

# The code below 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_to_unpivot_property = quicksight.CfnDataSet.ColumnToUnpivotProperty(
    column_name="columnName",
    new_value="newValue"
)

Attributes

column_name

The name of the column to unpivot from the source data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntounpivot.html#cfn-quicksight-dataset-columntounpivot-columnname

new_value

The value to assign to this column in the unpivoted result, typically the column name or a descriptive label.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntounpivot.html#cfn-quicksight-dataset-columntounpivot-newvalue

CreateColumnsOperationProperty

class CfnDataSet.CreateColumnsOperationProperty(*, columns, alias=None, source=None)

Bases: object

A transform operation that creates calculated columns.

Columns created in one such operation form a lexical closure.

Parameters:

columns (Union[IResolvable, Sequence[Union[IResolvable, CalculatedColumnProperty, Dict[str, Any]]]]) – Calculated columns to create.
alias (Optional[str]) – Alias for this operation.
source (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any], None]) – The source transform operation that provides input data for creating new calculated columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-createcolumnsoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

create_columns_operation_property = quicksight.CfnDataSet.CreateColumnsOperationProperty(
    columns=[quicksight.CfnDataSet.CalculatedColumnProperty(
        column_id="columnId",
        column_name="columnName",
        expression="expression"
    )],

    # the properties below are optional
    alias="alias",
    source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    )
)

Attributes

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-createcolumnsoperation.html#cfn-quicksight-dataset-createcolumnsoperation-alias

columns

Calculated columns to create.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-createcolumnsoperation.html#cfn-quicksight-dataset-createcolumnsoperation-columns

source

The source transform operation that provides input data for creating new calculated columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-createcolumnsoperation.html#cfn-quicksight-dataset-createcolumnsoperation-source

CustomSqlProperty

class CfnDataSet.CustomSqlProperty(*, columns, data_source_arn, name, sql_query)

Bases: object

A physical table type built from the results of the custom SQL query.

Parameters:

columns (Union[IResolvable, Sequence[Union[IResolvable, InputColumnProperty, Dict[str, Any]]]]) – The column schema from the SQL query result set.
data_source_arn (str) – The Amazon Resource Name (ARN) of the data source.
name (str) – A display name for the SQL query result.
sql_query (str) – The SQL query.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html

ExampleMetadata:

fixture=_generated

Example:

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

custom_sql_property = quicksight.CfnDataSet.CustomSqlProperty(
    columns=[quicksight.CfnDataSet.InputColumnProperty(
        name="name",
        type="type",

        # the properties below are optional
        id="id",
        sub_type="subType"
    )],
    data_source_arn="dataSourceArn",
    name="name",
    sql_query="sqlQuery"
)

Attributes

columns

The column schema from the SQL query result set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-columns

data_source_arn

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-datasourcearn

name

A display name for the SQL query result.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-name

sql_query

The SQL query.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-sqlquery

DataPrepAggregationFunctionProperty

class CfnDataSet.DataPrepAggregationFunctionProperty(*, list_aggregation=None, percentile_aggregation=None, simple_aggregation=None)

Bases: object

Defines the type of aggregation function to apply to data during data preparation, supporting simple and list aggregations.

Parameters:

list_aggregation (Union[IResolvable, DataPrepListAggregationFunctionProperty, Dict[str, Any], None]) – A list aggregation function that concatenates values from multiple rows into a single delimited string.
percentile_aggregation (Union[IResolvable, DataPrepPercentileAggregationFunctionProperty, Dict[str, Any], None])
simple_aggregation (Union[IResolvable, DataPrepSimpleAggregationFunctionProperty, Dict[str, Any], None]) – A simple aggregation function such as SUM , COUNT , AVERAGE , MIN , MAX , MEDIAN , VARIANCE , or STANDARD_DEVIATION .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepaggregationfunction.html

ExampleMetadata:

fixture=_generated

Example:

# The code below 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_prep_aggregation_function_property = quicksight.CfnDataSet.DataPrepAggregationFunctionProperty(
    list_aggregation=quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
        distinct=False,
        separator="separator",

        # the properties below are optional
        input_column_name="inputColumnName"
    ),
    percentile_aggregation=quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
        percentile_value=123,

        # the properties below are optional
        input_column_name="inputColumnName"
    ),
    simple_aggregation=quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
        function_type="functionType",

        # the properties below are optional
        input_column_name="inputColumnName"
    )
)

Attributes

list_aggregation

A list aggregation function that concatenates values from multiple rows into a single delimited string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepaggregationfunction.html#cfn-quicksight-dataset-dataprepaggregationfunction-listaggregation

percentile_aggregation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepaggregationfunction.html#cfn-quicksight-dataset-dataprepaggregationfunction-percentileaggregation

Type:: see

simple_aggregation

A simple aggregation function such as SUM , COUNT , AVERAGE , MIN , MAX , MEDIAN , VARIANCE , or STANDARD_DEVIATION .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepaggregationfunction.html#cfn-quicksight-dataset-dataprepaggregationfunction-simpleaggregation

DataPrepConfigurationProperty

class CfnDataSet.DataPrepConfigurationProperty(*, destination_table_map, source_table_map, transform_step_map)

Bases: object

Configuration for data preparation operations, defining the complete pipeline from source tables through transformations to destination tables.

Parameters:

destination_table_map (Union[IResolvable, Mapping[str, Union[IResolvable, DestinationTableProperty, Dict[str, Any]]]]) – A map of destination tables that receive the final prepared data.
source_table_map (Union[IResolvable, Mapping[str, Union[IResolvable, SourceTableProperty, Dict[str, Any]]]]) – A map of source tables that provide information about underlying sources.
transform_step_map (Union[IResolvable, Mapping[str, Union[IResolvable, TransformStepProperty, Dict[str, Any]]]]) – A map of transformation steps that process the data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below 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_prep_configuration_property = quicksight.CfnDataSet.DataPrepConfigurationProperty(
    destination_table_map={
        "destination_table_map_key": quicksight.CfnDataSet.DestinationTableProperty(
            alias="alias",
            source=quicksight.CfnDataSet.DestinationTableSourceProperty(
                transform_operation_id="transformOperationId"
            )
        )
    },
    source_table_map={
        "source_table_map_key": quicksight.CfnDataSet.SourceTableProperty(
            data_set=quicksight.CfnDataSet.ParentDataSetProperty(
                data_set_arn="dataSetArn",
                input_columns=[quicksight.CfnDataSet.InputColumnProperty(
                    name="name",
                    type="type",

                    # the properties below are optional
                    id="id",
                    sub_type="subType"
                )]
            ),
            physical_table_id="physicalTableId"
        )
    },
    transform_step_map={
        "transform_step_map_key": quicksight.CfnDataSet.TransformStepProperty(
            aggregate_step=quicksight.CfnDataSet.AggregateOperationProperty(
                aggregations=[quicksight.CfnDataSet.AggregationProperty(
                    aggregation_function=quicksight.CfnDataSet.DataPrepAggregationFunctionProperty(
                        list_aggregation=quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
                            distinct=False,
                            separator="separator",

                            # the properties below are optional
                            input_column_name="inputColumnName"
                        ),
                        percentile_aggregation=quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
                            percentile_value=123,

                            # the properties below are optional
                            input_column_name="inputColumnName"
                        ),
                        simple_aggregation=quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
                            function_type="functionType",

                            # the properties below are optional
                            input_column_name="inputColumnName"
                        )
                    ),
                    new_column_id="newColumnId",
                    new_column_name="newColumnName"
                )],
                alias="alias",
                source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                ),

                # the properties below are optional
                group_by_column_names=["groupByColumnNames"]
            ),
            append_step=quicksight.CfnDataSet.AppendOperationProperty(
                alias="alias",
                appended_columns=[quicksight.CfnDataSet.AppendedColumnProperty(
                    column_name="columnName",
                    new_column_id="newColumnId"
                )],

                # the properties below are optional
                first_source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                ),
                second_source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                )
            ),
            cast_column_types_step=quicksight.CfnDataSet.CastColumnTypesOperationProperty(
                alias="alias",
                cast_column_type_operations=[quicksight.CfnDataSet.CastColumnTypeOperationProperty(
                    column_name="columnName",
                    new_column_type="newColumnType",

                    # the properties below are optional
                    format="format",
                    sub_type="subType"
                )],
                source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                )
            ),
            create_columns_step=quicksight.CfnDataSet.CreateColumnsOperationProperty(
                columns=[quicksight.CfnDataSet.CalculatedColumnProperty(
                    column_id="columnId",
                    column_name="columnName",
                    expression="expression"
                )],

                # the properties below are optional
                alias="alias",
                source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                )
            ),
            filters_step=quicksight.CfnDataSet.FiltersOperationProperty(
                alias="alias",
                filter_operations=[quicksight.CfnDataSet.FilterOperationProperty(
                    condition_expression="conditionExpression",
                    date_filter_condition=quicksight.CfnDataSet.DataSetDateFilterConditionProperty(
                        column_name="columnName",
                        comparison_filter_condition=quicksight.CfnDataSet.DataSetDateComparisonFilterConditionProperty(
                            operator="operator",

                            # the properties below are optional
                            value=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                                static_value="staticValue"
                            )
                        ),
                        range_filter_condition=quicksight.CfnDataSet.DataSetDateRangeFilterConditionProperty(
                            include_maximum=False,
                            include_minimum=False,
                            range_maximum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                                static_value="staticValue"
                            ),
                            range_minimum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                                static_value="staticValue"
                            )
                        )
                    ),
                    numeric_filter_condition=quicksight.CfnDataSet.DataSetNumericFilterConditionProperty(
                        column_name="columnName",
                        comparison_filter_condition=quicksight.CfnDataSet.DataSetNumericComparisonFilterConditionProperty(
                            operator="operator",

                            # the properties below are optional
                            value=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                                static_value=123
                            )
                        ),
                        range_filter_condition=quicksight.CfnDataSet.DataSetNumericRangeFilterConditionProperty(
                            include_maximum=False,
                            include_minimum=False,
                            range_maximum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                                static_value=123
                            ),
                            range_minimum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                                static_value=123
                            )
                        )
                    ),
                    string_filter_condition=quicksight.CfnDataSet.DataSetStringFilterConditionProperty(
                        column_name="columnName",
                        comparison_filter_condition=quicksight.CfnDataSet.DataSetStringComparisonFilterConditionProperty(
                            operator="operator",

                            # the properties below are optional
                            value=quicksight.CfnDataSet.DataSetStringFilterValueProperty(
                                static_value="staticValue"
                            )
                        ),
                        list_filter_condition=quicksight.CfnDataSet.DataSetStringListFilterConditionProperty(
                            operator="operator",

                            # the properties below are optional
                            values=quicksight.CfnDataSet.DataSetStringListFilterValueProperty(
                                static_values=["staticValues"]
                            )
                        )
                    )
                )],
                source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                )
            ),
            import_table_step=quicksight.CfnDataSet.ImportTableOperationProperty(
                alias="alias",
                source=quicksight.CfnDataSet.ImportTableOperationSourceProperty(
                    source_table_id="sourceTableId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                )
            ),
            join_step=quicksight.CfnDataSet.JoinOperationProperty(
                alias="alias",
                left_operand=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                ),
                on_clause="onClause",
                right_operand=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                ),
                type="type",

                # the properties below are optional
                left_operand_properties=quicksight.CfnDataSet.JoinOperandPropertiesProperty(
                    output_column_name_overrides=[quicksight.CfnDataSet.OutputColumnNameOverrideProperty(
                        output_column_name="outputColumnName",

                        # the properties below are optional
                        source_column_name="sourceColumnName"
                    )]
                ),
                right_operand_properties=quicksight.CfnDataSet.JoinOperandPropertiesProperty(
                    output_column_name_overrides=[quicksight.CfnDataSet.OutputColumnNameOverrideProperty(
                        output_column_name="outputColumnName",

                        # the properties below are optional
                        source_column_name="sourceColumnName"
                    )]
                )
            ),
            pivot_step=quicksight.CfnDataSet.PivotOperationProperty(
                alias="alias",
                pivot_configuration=quicksight.CfnDataSet.PivotConfigurationProperty(
                    pivoted_labels=[quicksight.CfnDataSet.PivotedLabelProperty(
                        label_name="labelName",
                        new_column_id="newColumnId",
                        new_column_name="newColumnName"
                    )],

                    # the properties below are optional
                    label_column_name="labelColumnName"
                ),
                source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                ),
                value_column_configuration=quicksight.CfnDataSet.ValueColumnConfigurationProperty(
                    aggregation_function=quicksight.CfnDataSet.DataPrepAggregationFunctionProperty(
                        list_aggregation=quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
                            distinct=False,
                            separator="separator",

                            # the properties below are optional
                            input_column_name="inputColumnName"
                        ),
                        percentile_aggregation=quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
                            percentile_value=123,

                            # the properties below are optional
                            input_column_name="inputColumnName"
                        ),
                        simple_aggregation=quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
                            function_type="functionType",

                            # the properties below are optional
                            input_column_name="inputColumnName"
                        )
                    )
                ),

                # the properties below are optional
                group_by_column_names=["groupByColumnNames"]
            ),
            project_step=quicksight.CfnDataSet.ProjectOperationProperty(
                alias="alias",
                projected_columns=["projectedColumns"],
                source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                )
            ),
            rename_columns_step=quicksight.CfnDataSet.RenameColumnsOperationProperty(
                alias="alias",
                rename_column_operations=[quicksight.CfnDataSet.RenameColumnOperationProperty(
                    column_name="columnName",
                    new_column_name="newColumnName"
                )],
                source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                )
            ),
            unpivot_step=quicksight.CfnDataSet.UnpivotOperationProperty(
                alias="alias",
                columns_to_unpivot=[quicksight.CfnDataSet.ColumnToUnpivotProperty(
                    column_name="columnName",
                    new_value="newValue"
                )],
                source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                    transform_operation_id="transformOperationId",

                    # the properties below are optional
                    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                        source_column_id="sourceColumnId",
                        target_column_id="targetColumnId"
                    )]
                ),
                unpivoted_label_column_id="unpivotedLabelColumnId",
                unpivoted_label_column_name="unpivotedLabelColumnName",
                unpivoted_value_column_id="unpivotedValueColumnId",
                unpivoted_value_column_name="unpivotedValueColumnName"
            )
        )
    }
)

Attributes

destination_table_map

A map of destination tables that receive the final prepared data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepconfiguration.html#cfn-quicksight-dataset-dataprepconfiguration-destinationtablemap

source_table_map

A map of source tables that provide information about underlying sources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepconfiguration.html#cfn-quicksight-dataset-dataprepconfiguration-sourcetablemap

transform_step_map

A map of transformation steps that process the data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepconfiguration.html#cfn-quicksight-dataset-dataprepconfiguration-transformstepmap

DataPrepListAggregationFunctionProperty

class CfnDataSet.DataPrepListAggregationFunctionProperty(*, distinct, separator, input_column_name=None)

Bases: object

An aggregation function that concatenates values from multiple rows into a single string with a specified separator.

Parameters:

distinct (Union[bool, IResolvable]) – Whether to include only distinct values in the concatenated result, removing duplicates. Default: - false
separator (str) – The string used to separate values in the concatenated result.
input_column_name (Optional[str]) – The name of the column containing values to be concatenated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreplistaggregationfunction.html

ExampleMetadata:

fixture=_generated

Example:

# The code below 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_prep_list_aggregation_function_property = quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
    distinct=False,
    separator="separator",

    # the properties below are optional
    input_column_name="inputColumnName"
)

Attributes

distinct

Whether to include only distinct values in the concatenated result, removing duplicates.

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreplistaggregationfunction.html#cfn-quicksight-dataset-datapreplistaggregationfunction-distinct

input_column_name

The name of the column containing values to be concatenated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreplistaggregationfunction.html#cfn-quicksight-dataset-datapreplistaggregationfunction-inputcolumnname

separator

The string used to separate values in the concatenated result.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreplistaggregationfunction.html#cfn-quicksight-dataset-datapreplistaggregationfunction-separator

DataPrepPercentileAggregationFunctionProperty

class CfnDataSet.DataPrepPercentileAggregationFunctionProperty(*, percentile_value, input_column_name=None)

Bases: object

Parameters:

percentile_value (Union[int, float]) – Default: - 0
input_column_name (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreppercentileaggregationfunction.html

ExampleMetadata:

fixture=_generated

Example:

# The code below 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_prep_percentile_aggregation_function_property = quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
    percentile_value=123,

    # the properties below are optional
    input_column_name="inputColumnName"
)

Attributes

input_column_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreppercentileaggregationfunction.html#cfn-quicksight-dataset-datapreppercentileaggregationfunction-inputcolumnname

Type:: see

percentile_value

0

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datapreppercentileaggregationfunction.html#cfn-quicksight-dataset-datapreppercentileaggregationfunction-percentilevalue
Type:: default

DataPrepSimpleAggregationFunctionProperty

class CfnDataSet.DataPrepSimpleAggregationFunctionProperty(*, function_type, input_column_name=None)

Bases: object

A simple aggregation function that performs standard statistical operations on a column.

Parameters:

function_type (str) – The type of aggregation function to perform, such as COUNT , SUM , AVERAGE , MIN , MAX , MEDIAN , VARIANCE , or STANDARD_DEVIATION .
input_column_name (Optional[str]) – The name of the column on which to perform the aggregation function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepsimpleaggregationfunction.html

ExampleMetadata:

fixture=_generated

Example:

# The code below 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_prep_simple_aggregation_function_property = quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
    function_type="functionType",

    # the properties below are optional
    input_column_name="inputColumnName"
)

Attributes

function_type

The type of aggregation function to perform, such as COUNT , SUM , AVERAGE , MIN , MAX , MEDIAN , VARIANCE , or STANDARD_DEVIATION .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepsimpleaggregationfunction.html#cfn-quicksight-dataset-dataprepsimpleaggregationfunction-functiontype

input_column_name

The name of the column on which to perform the aggregation function.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-dataprepsimpleaggregationfunction.html#cfn-quicksight-dataset-dataprepsimpleaggregationfunction-inputcolumnname

DataSetColumnIdMappingProperty

class CfnDataSet.DataSetColumnIdMappingProperty(*, source_column_id, target_column_id)

Bases: object

Parameters:

source_column_id (str)
target_column_id (str)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetcolumnidmapping.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_column_id_mapping_property = quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
    source_column_id="sourceColumnId",
    target_column_id="targetColumnId"
)

Attributes

source_column_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetcolumnidmapping.html#cfn-quicksight-dataset-datasetcolumnidmapping-sourcecolumnid

Type:: see

target_column_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetcolumnidmapping.html#cfn-quicksight-dataset-datasetcolumnidmapping-targetcolumnid

Type:: see

DataSetDateComparisonFilterConditionProperty

class CfnDataSet.DataSetDateComparisonFilterConditionProperty(*, operator, value=None)

Bases: object

A filter condition that compares date values using operators like BEFORE , AFTER , or their inclusive variants.

Parameters:

operator (str) – The comparison operator to use, such as BEFORE , BEFORE_OR_EQUALS_TO , AFTER , or AFTER_OR_EQUALS_TO .
value (Union[IResolvable, DataSetDateFilterValueProperty, Dict[str, Any], None]) – The date value to compare against.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatecomparisonfiltercondition.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_date_comparison_filter_condition_property = quicksight.CfnDataSet.DataSetDateComparisonFilterConditionProperty(
    operator="operator",

    # the properties below are optional
    value=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
        static_value="staticValue"
    )
)

Attributes

operator

The comparison operator to use, such as BEFORE , BEFORE_OR_EQUALS_TO , AFTER , or AFTER_OR_EQUALS_TO .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatecomparisonfiltercondition.html#cfn-quicksight-dataset-datasetdatecomparisonfiltercondition-operator

value

The date value to compare against.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatecomparisonfiltercondition.html#cfn-quicksight-dataset-datasetdatecomparisonfiltercondition-value

DataSetDateFilterConditionProperty

class CfnDataSet.DataSetDateFilterConditionProperty(*, column_name=None, comparison_filter_condition=None, range_filter_condition=None)

Bases: object

A filter condition for date columns, supporting both comparison and range-based filtering.

Parameters:

column_name (Optional[str]) – The name of the date column to filter.
comparison_filter_condition (Union[IResolvable, DataSetDateComparisonFilterConditionProperty, Dict[str, Any], None]) – A comparison-based filter condition for the date column.
range_filter_condition (Union[IResolvable, DataSetDateRangeFilterConditionProperty, Dict[str, Any], None]) – A range-based filter condition for the date column, filtering values between minimum and maximum dates.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltercondition.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_date_filter_condition_property = quicksight.CfnDataSet.DataSetDateFilterConditionProperty(
    column_name="columnName",
    comparison_filter_condition=quicksight.CfnDataSet.DataSetDateComparisonFilterConditionProperty(
        operator="operator",

        # the properties below are optional
        value=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
            static_value="staticValue"
        )
    ),
    range_filter_condition=quicksight.CfnDataSet.DataSetDateRangeFilterConditionProperty(
        include_maximum=False,
        include_minimum=False,
        range_maximum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
            static_value="staticValue"
        ),
        range_minimum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
            static_value="staticValue"
        )
    )
)

Attributes

column_name

The name of the date column to filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltercondition.html#cfn-quicksight-dataset-datasetdatefiltercondition-columnname

comparison_filter_condition

A comparison-based filter condition for the date column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltercondition.html#cfn-quicksight-dataset-datasetdatefiltercondition-comparisonfiltercondition

range_filter_condition

A range-based filter condition for the date column, filtering values between minimum and maximum dates.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltercondition.html#cfn-quicksight-dataset-datasetdatefiltercondition-rangefiltercondition

DataSetDateFilterValueProperty

class CfnDataSet.DataSetDateFilterValueProperty(*, static_value=None)

Bases: object

Represents a date value used in filter conditions.

Parameters:: static_value (Optional[str]) – A static date value used for filtering.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltervalue.html
ExampleMetadata:: fixture=_generated

Example:

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

data_set_date_filter_value_property = quicksight.CfnDataSet.DataSetDateFilterValueProperty(
    static_value="staticValue"
)

Attributes

static_value

A static date value used for filtering.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdatefiltervalue.html#cfn-quicksight-dataset-datasetdatefiltervalue-staticvalue

DataSetDateRangeFilterConditionProperty

class CfnDataSet.DataSetDateRangeFilterConditionProperty(*, include_maximum=None, include_minimum=None, range_maximum=None, range_minimum=None)

Bases: object

A filter condition that filters date values within a specified range.

Parameters:

include_maximum (Union[bool, IResolvable, None]) – Whether to include the maximum value in the filter range.
include_minimum (Union[bool, IResolvable, None]) – Whether to include the minimum value in the filter range.
range_maximum (Union[IResolvable, DataSetDateFilterValueProperty, Dict[str, Any], None]) – The maximum date value for the range filter.
range_minimum (Union[IResolvable, DataSetDateFilterValueProperty, Dict[str, Any], None]) – The minimum date value for the range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_date_range_filter_condition_property = quicksight.CfnDataSet.DataSetDateRangeFilterConditionProperty(
    include_maximum=False,
    include_minimum=False,
    range_maximum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
        static_value="staticValue"
    ),
    range_minimum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
        static_value="staticValue"
    )
)

Attributes

include_maximum

Whether to include the maximum value in the filter range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html#cfn-quicksight-dataset-datasetdaterangefiltercondition-includemaximum

include_minimum

Whether to include the minimum value in the filter range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html#cfn-quicksight-dataset-datasetdaterangefiltercondition-includeminimum

range_maximum

The maximum date value for the range filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html#cfn-quicksight-dataset-datasetdaterangefiltercondition-rangemaximum

range_minimum

The minimum date value for the range filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetdaterangefiltercondition.html#cfn-quicksight-dataset-datasetdaterangefiltercondition-rangeminimum

DataSetNumericComparisonFilterConditionProperty

class CfnDataSet.DataSetNumericComparisonFilterConditionProperty(*, operator, value=None)

Bases: object

A filter condition that compares numeric values using operators like EQUALS , GREATER_THAN , or LESS_THAN .

Parameters:

operator (str) – The comparison operator to use, such as EQUALS , GREATER_THAN , LESS_THAN , or their variants.
value (Union[IResolvable, DataSetNumericFilterValueProperty, Dict[str, Any], None]) – The numeric value to compare against.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericcomparisonfiltercondition.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_numeric_comparison_filter_condition_property = quicksight.CfnDataSet.DataSetNumericComparisonFilterConditionProperty(
    operator="operator",

    # the properties below are optional
    value=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
        static_value=123
    )
)

Attributes

operator

The comparison operator to use, such as EQUALS , GREATER_THAN , LESS_THAN , or their variants.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericcomparisonfiltercondition.html#cfn-quicksight-dataset-datasetnumericcomparisonfiltercondition-operator

value

The numeric value to compare against.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericcomparisonfiltercondition.html#cfn-quicksight-dataset-datasetnumericcomparisonfiltercondition-value

DataSetNumericFilterConditionProperty

class CfnDataSet.DataSetNumericFilterConditionProperty(*, column_name=None, comparison_filter_condition=None, range_filter_condition=None)

Bases: object

A filter condition for numeric columns, supporting both comparison and range-based filtering.

Parameters:

column_name (Optional[str]) – The name of the numeric column to filter.
comparison_filter_condition (Union[IResolvable, DataSetNumericComparisonFilterConditionProperty, Dict[str, Any], None]) – A comparison-based filter condition for the numeric column.
range_filter_condition (Union[IResolvable, DataSetNumericRangeFilterConditionProperty, Dict[str, Any], None]) – A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltercondition.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_numeric_filter_condition_property = quicksight.CfnDataSet.DataSetNumericFilterConditionProperty(
    column_name="columnName",
    comparison_filter_condition=quicksight.CfnDataSet.DataSetNumericComparisonFilterConditionProperty(
        operator="operator",

        # the properties below are optional
        value=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
            static_value=123
        )
    ),
    range_filter_condition=quicksight.CfnDataSet.DataSetNumericRangeFilterConditionProperty(
        include_maximum=False,
        include_minimum=False,
        range_maximum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
            static_value=123
        ),
        range_minimum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
            static_value=123
        )
    )
)

Attributes

column_name

The name of the numeric column to filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltercondition.html#cfn-quicksight-dataset-datasetnumericfiltercondition-columnname

comparison_filter_condition

A comparison-based filter condition for the numeric column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltercondition.html#cfn-quicksight-dataset-datasetnumericfiltercondition-comparisonfiltercondition

range_filter_condition

A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltercondition.html#cfn-quicksight-dataset-datasetnumericfiltercondition-rangefiltercondition

DataSetNumericFilterValueProperty

class CfnDataSet.DataSetNumericFilterValueProperty(*, static_value=None)

Bases: object

Represents a numeric value used in filter conditions.

Parameters:: static_value (Union[int, float, None]) – A static numeric value used for filtering.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltervalue.html
ExampleMetadata:: fixture=_generated

Example:

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

data_set_numeric_filter_value_property = quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
    static_value=123
)

Attributes

static_value

A static numeric value used for filtering.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericfiltervalue.html#cfn-quicksight-dataset-datasetnumericfiltervalue-staticvalue

DataSetNumericRangeFilterConditionProperty

class CfnDataSet.DataSetNumericRangeFilterConditionProperty(*, include_maximum=None, include_minimum=None, range_maximum=None, range_minimum=None)

Bases: object

A filter condition that filters numeric values within a specified range.

Parameters:

include_maximum (Union[bool, IResolvable, None]) – Whether to include the maximum value in the filter range.
include_minimum (Union[bool, IResolvable, None]) – Whether to include the minimum value in the filter range.
range_maximum (Union[IResolvable, DataSetNumericFilterValueProperty, Dict[str, Any], None]) – The maximum numeric value for the range filter.
range_minimum (Union[IResolvable, DataSetNumericFilterValueProperty, Dict[str, Any], None]) – The minimum numeric value for the range filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_numeric_range_filter_condition_property = quicksight.CfnDataSet.DataSetNumericRangeFilterConditionProperty(
    include_maximum=False,
    include_minimum=False,
    range_maximum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
        static_value=123
    ),
    range_minimum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
        static_value=123
    )
)

Attributes

include_maximum

Whether to include the maximum value in the filter range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html#cfn-quicksight-dataset-datasetnumericrangefiltercondition-includemaximum

include_minimum

Whether to include the minimum value in the filter range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html#cfn-quicksight-dataset-datasetnumericrangefiltercondition-includeminimum

range_maximum

The maximum numeric value for the range filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html#cfn-quicksight-dataset-datasetnumericrangefiltercondition-rangemaximum

range_minimum

The minimum numeric value for the range filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.html#cfn-quicksight-dataset-datasetnumericrangefiltercondition-rangeminimum

DataSetRefreshPropertiesProperty

class CfnDataSet.DataSetRefreshPropertiesProperty(*, failure_configuration=None, refresh_configuration=None)

Bases: object

The refresh properties of a dataset.

Parameters:

failure_configuration (Union[IResolvable, RefreshFailureConfigurationProperty, Dict[str, Any], None]) – The failure configuration for a dataset.
refresh_configuration (Union[IResolvable, RefreshConfigurationProperty, Dict[str, Any], None]) – The refresh configuration for a dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetrefreshproperties.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_refresh_properties_property = quicksight.CfnDataSet.DataSetRefreshPropertiesProperty(
    failure_configuration=quicksight.CfnDataSet.RefreshFailureConfigurationProperty(
        email_alert=quicksight.CfnDataSet.RefreshFailureEmailAlertProperty(
            alert_status="alertStatus"
        )
    ),
    refresh_configuration=quicksight.CfnDataSet.RefreshConfigurationProperty(
        incremental_refresh=quicksight.CfnDataSet.IncrementalRefreshProperty(
            lookback_window=quicksight.CfnDataSet.LookbackWindowProperty(
                column_name="columnName",
                size=123,
                size_unit="sizeUnit"
            )
        )
    )
)

Attributes

failure_configuration

The failure configuration for a dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetrefreshproperties.html#cfn-quicksight-dataset-datasetrefreshproperties-failureconfiguration

refresh_configuration

The refresh configuration for a dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetrefreshproperties.html#cfn-quicksight-dataset-datasetrefreshproperties-refreshconfiguration

DataSetStringComparisonFilterConditionProperty

class CfnDataSet.DataSetStringComparisonFilterConditionProperty(*, operator, value=None)

Bases: object

A filter condition that compares string values using operators like EQUALS , CONTAINS , or STARTS_WITH .

Parameters:

operator (str) – The comparison operator to use, such as EQUALS , CONTAINS , STARTS_WITH , ENDS_WITH , or their negations.
value (Union[IResolvable, DataSetStringFilterValueProperty, Dict[str, Any], None]) – The string value to compare against.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringcomparisonfiltercondition.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_string_comparison_filter_condition_property = quicksight.CfnDataSet.DataSetStringComparisonFilterConditionProperty(
    operator="operator",

    # the properties below are optional
    value=quicksight.CfnDataSet.DataSetStringFilterValueProperty(
        static_value="staticValue"
    )
)

Attributes

operator

The comparison operator to use, such as EQUALS , CONTAINS , STARTS_WITH , ENDS_WITH , or their negations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringcomparisonfiltercondition.html#cfn-quicksight-dataset-datasetstringcomparisonfiltercondition-operator

value

The string value to compare against.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringcomparisonfiltercondition.html#cfn-quicksight-dataset-datasetstringcomparisonfiltercondition-value

DataSetStringFilterConditionProperty

class CfnDataSet.DataSetStringFilterConditionProperty(*, column_name=None, comparison_filter_condition=None, list_filter_condition=None)

Bases: object

A filter condition for string columns, supporting both comparison and list-based filtering.

Parameters:

column_name (Optional[str]) – The name of the string column to filter.
comparison_filter_condition (Union[IResolvable, DataSetStringComparisonFilterConditionProperty, Dict[str, Any], None]) – A comparison-based filter condition for the string column.
list_filter_condition (Union[IResolvable, DataSetStringListFilterConditionProperty, Dict[str, Any], None]) – A list-based filter condition that includes or excludes values from a specified list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltercondition.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_string_filter_condition_property = quicksight.CfnDataSet.DataSetStringFilterConditionProperty(
    column_name="columnName",
    comparison_filter_condition=quicksight.CfnDataSet.DataSetStringComparisonFilterConditionProperty(
        operator="operator",

        # the properties below are optional
        value=quicksight.CfnDataSet.DataSetStringFilterValueProperty(
            static_value="staticValue"
        )
    ),
    list_filter_condition=quicksight.CfnDataSet.DataSetStringListFilterConditionProperty(
        operator="operator",

        # the properties below are optional
        values=quicksight.CfnDataSet.DataSetStringListFilterValueProperty(
            static_values=["staticValues"]
        )
    )
)

Attributes

column_name

The name of the string column to filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltercondition.html#cfn-quicksight-dataset-datasetstringfiltercondition-columnname

comparison_filter_condition

A comparison-based filter condition for the string column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltercondition.html#cfn-quicksight-dataset-datasetstringfiltercondition-comparisonfiltercondition

list_filter_condition

A list-based filter condition that includes or excludes values from a specified list.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltercondition.html#cfn-quicksight-dataset-datasetstringfiltercondition-listfiltercondition

DataSetStringFilterValueProperty

class CfnDataSet.DataSetStringFilterValueProperty(*, static_value=None)

Bases: object

Represents a string value used in filter conditions.

Parameters:: static_value (Optional[str]) – A static string value used for filtering.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltervalue.html
ExampleMetadata:: fixture=_generated

Example:

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

data_set_string_filter_value_property = quicksight.CfnDataSet.DataSetStringFilterValueProperty(
    static_value="staticValue"
)

Attributes

static_value

A static string value used for filtering.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringfiltervalue.html#cfn-quicksight-dataset-datasetstringfiltervalue-staticvalue

DataSetStringListFilterConditionProperty

class CfnDataSet.DataSetStringListFilterConditionProperty(*, operator, values=None)

Bases: object

A filter condition that includes or excludes string values from a specified list.

Parameters:

operator (str) – The list operator to use, either INCLUDE to match values in the list or EXCLUDE to filter out values in the list.
values (Union[IResolvable, DataSetStringListFilterValueProperty, Dict[str, Any], None]) – The list of string values to include or exclude in the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringlistfiltercondition.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_string_list_filter_condition_property = quicksight.CfnDataSet.DataSetStringListFilterConditionProperty(
    operator="operator",

    # the properties below are optional
    values=quicksight.CfnDataSet.DataSetStringListFilterValueProperty(
        static_values=["staticValues"]
    )
)

Attributes

operator

The list operator to use, either INCLUDE to match values in the list or EXCLUDE to filter out values in the list.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringlistfiltercondition.html#cfn-quicksight-dataset-datasetstringlistfiltercondition-operator

values

The list of string values to include or exclude in the filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringlistfiltercondition.html#cfn-quicksight-dataset-datasetstringlistfiltercondition-values

DataSetStringListFilterValueProperty

class CfnDataSet.DataSetStringListFilterValueProperty(*, static_values=None)

Bases: object

Represents a list of string values used in filter conditions.

Parameters:: static_values (Optional[Sequence[str]]) – A list of static string values used for filtering.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringlistfiltervalue.html
ExampleMetadata:: fixture=_generated

Example:

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

data_set_string_list_filter_value_property = quicksight.CfnDataSet.DataSetStringListFilterValueProperty(
    static_values=["staticValues"]
)

Attributes

static_values

A list of static string values used for filtering.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetstringlistfiltervalue.html#cfn-quicksight-dataset-datasetstringlistfiltervalue-staticvalues

DataSetUsageConfigurationProperty

class CfnDataSet.DataSetUsageConfigurationProperty(*, disable_use_as_direct_query_source=None, disable_use_as_imported_source=None)

Bases: object

The usage configuration to apply to child datasets that reference this dataset as a source.

Parameters:

disable_use_as_direct_query_source (Union[bool, IResolvable, None]) – An option that controls whether a child dataset of a direct query can use this dataset as a source. Default: - false
disable_use_as_imported_source (Union[bool, IResolvable, None]) – An option that controls whether a child dataset that’s stored in Quick Sight can use this dataset as a source. Default: - false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

data_set_usage_configuration_property = quicksight.CfnDataSet.DataSetUsageConfigurationProperty(
    disable_use_as_direct_query_source=False,
    disable_use_as_imported_source=False
)

Attributes

disable_use_as_direct_query_source

An option that controls whether a child dataset of a direct query can use this dataset as a source.

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html#cfn-quicksight-dataset-datasetusageconfiguration-disableuseasdirectquerysource

disable_use_as_imported_source

An option that controls whether a child dataset that’s stored in Quick Sight can use this dataset as a source.

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html#cfn-quicksight-dataset-datasetusageconfiguration-disableuseasimportedsource

DatasetParameterProperty

class CfnDataSet.DatasetParameterProperty(*, date_time_dataset_parameter=None, decimal_dataset_parameter=None, integer_dataset_parameter=None, string_dataset_parameter=None)

Bases: object

The parameter declarations of the dataset.

Parameters:

date_time_dataset_parameter (Union[IResolvable, DateTimeDatasetParameterProperty, Dict[str, Any], None]) – A date time parameter that is created in the dataset.
decimal_dataset_parameter (Union[IResolvable, DecimalDatasetParameterProperty, Dict[str, Any], None]) – A decimal parameter that is created in the dataset.
integer_dataset_parameter (Union[IResolvable, IntegerDatasetParameterProperty, Dict[str, Any], None]) – An integer parameter that is created in the dataset.
string_dataset_parameter (Union[IResolvable, StringDatasetParameterProperty, Dict[str, Any], None]) – A string parameter that is created in the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html

ExampleMetadata:

fixture=_generated

Example:

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

dataset_parameter_property = quicksight.CfnDataSet.DatasetParameterProperty(
    date_time_dataset_parameter=quicksight.CfnDataSet.DateTimeDatasetParameterProperty(
        id="id",
        name="name",
        value_type="valueType",

        # the properties below are optional
        default_values=quicksight.CfnDataSet.DateTimeDatasetParameterDefaultValuesProperty(
            static_values=["staticValues"]
        ),
        time_granularity="timeGranularity"
    ),
    decimal_dataset_parameter=quicksight.CfnDataSet.DecimalDatasetParameterProperty(
        id="id",
        name="name",
        value_type="valueType",

        # the properties below are optional
        default_values=quicksight.CfnDataSet.DecimalDatasetParameterDefaultValuesProperty(
            static_values=[123]
        )
    ),
    integer_dataset_parameter=quicksight.CfnDataSet.IntegerDatasetParameterProperty(
        id="id",
        name="name",
        value_type="valueType",

        # the properties below are optional
        default_values=quicksight.CfnDataSet.IntegerDatasetParameterDefaultValuesProperty(
            static_values=[123]
        )
    ),
    string_dataset_parameter=quicksight.CfnDataSet.StringDatasetParameterProperty(
        id="id",
        name="name",
        value_type="valueType",

        # the properties below are optional
        default_values=quicksight.CfnDataSet.StringDatasetParameterDefaultValuesProperty(
            static_values=["staticValues"]
        )
    )
)

Attributes

date_time_dataset_parameter

A date time parameter that is created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html#cfn-quicksight-dataset-datasetparameter-datetimedatasetparameter

decimal_dataset_parameter

A decimal parameter that is created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html#cfn-quicksight-dataset-datasetparameter-decimaldatasetparameter

integer_dataset_parameter

An integer parameter that is created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html#cfn-quicksight-dataset-datasetparameter-integerdatasetparameter

string_dataset_parameter

A string parameter that is created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html#cfn-quicksight-dataset-datasetparameter-stringdatasetparameter

DateTimeDatasetParameterDefaultValuesProperty

class CfnDataSet.DateTimeDatasetParameterDefaultValuesProperty(*, static_values=None)

Bases: object

Parameters:: static_values (Optional[Sequence[str]]) – A list of static default values for a given date time parameter. The valid format for this property is yyyy-MM-dd’T’HH:mm:ss’Z’ .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameterdefaultvalues.html
ExampleMetadata:: fixture=_generated

Example:

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

date_time_dataset_parameter_default_values_property = quicksight.CfnDataSet.DateTimeDatasetParameterDefaultValuesProperty(
    static_values=["staticValues"]
)

Attributes

static_values

A list of static default values for a given date time parameter.

The valid format for this property is yyyy-MM-dd’T’HH:mm:ss’Z’ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameterdefaultvalues.html#cfn-quicksight-dataset-datetimedatasetparameterdefaultvalues-staticvalues

DateTimeDatasetParameterProperty

class CfnDataSet.DateTimeDatasetParameterProperty(*, id, name, value_type, default_values=None, time_granularity=None)

Bases: object

A date time parameter that is created in the dataset.

Parameters:

id (str) – An identifier for the parameter that is created in the dataset.
name (str) – The name of the date time parameter that is created in the dataset.
value_type (str) – The value type of the dataset parameter. Valid values are single value or multi value .
default_values (Union[IResolvable, DateTimeDatasetParameterDefaultValuesProperty, Dict[str, Any], None]) – A list of default values for a given date time parameter. This structure only accepts static values.
time_granularity (Optional[str]) – The time granularity of the date time parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html

ExampleMetadata:

fixture=_generated

Example:

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

date_time_dataset_parameter_property = quicksight.CfnDataSet.DateTimeDatasetParameterProperty(
    id="id",
    name="name",
    value_type="valueType",

    # the properties below are optional
    default_values=quicksight.CfnDataSet.DateTimeDatasetParameterDefaultValuesProperty(
        static_values=["staticValues"]
    ),
    time_granularity="timeGranularity"
)

Attributes

default_values

A list of default values for a given date time parameter.

This structure only accepts static values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html#cfn-quicksight-dataset-datetimedatasetparameter-defaultvalues

id

An identifier for the parameter that is created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html#cfn-quicksight-dataset-datetimedatasetparameter-id

name

The name of the date time parameter that is created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html#cfn-quicksight-dataset-datetimedatasetparameter-name

time_granularity

The time granularity of the date time parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html#cfn-quicksight-dataset-datetimedatasetparameter-timegranularity

value_type

The value type of the dataset parameter.

Valid values are single value or multi value .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html#cfn-quicksight-dataset-datetimedatasetparameter-valuetype

DecimalDatasetParameterDefaultValuesProperty

class CfnDataSet.DecimalDatasetParameterDefaultValuesProperty(*, static_values=None)

Bases: object

A list of default values for a given decimal parameter.

This structure only accepts static values.

Parameters:: static_values (Union[Sequence[Union[int, float]], IResolvable, None]) – A list of static default values for a given decimal parameter.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameterdefaultvalues.html
ExampleMetadata:: fixture=_generated

Example:

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

decimal_dataset_parameter_default_values_property = quicksight.CfnDataSet.DecimalDatasetParameterDefaultValuesProperty(
    static_values=[123]
)

Attributes

static_values

A list of static default values for a given decimal parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameterdefaultvalues.html#cfn-quicksight-dataset-decimaldatasetparameterdefaultvalues-staticvalues

DecimalDatasetParameterProperty

class CfnDataSet.DecimalDatasetParameterProperty(*, id, name, value_type, default_values=None)

Bases: object

A decimal parameter that is created in the dataset.

Parameters:

id (str) – An identifier for the decimal parameter created in the dataset.
name (str) – The name of the decimal parameter that is created in the dataset.
value_type (str) – The value type of the dataset parameter. Valid values are single value or multi value .
default_values (Union[IResolvable, DecimalDatasetParameterDefaultValuesProperty, Dict[str, Any], None]) – A list of default values for a given decimal parameter. This structure only accepts static values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html

ExampleMetadata:

fixture=_generated

Example:

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

decimal_dataset_parameter_property = quicksight.CfnDataSet.DecimalDatasetParameterProperty(
    id="id",
    name="name",
    value_type="valueType",

    # the properties below are optional
    default_values=quicksight.CfnDataSet.DecimalDatasetParameterDefaultValuesProperty(
        static_values=[123]
    )
)

Attributes

default_values

A list of default values for a given decimal parameter.

This structure only accepts static values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html#cfn-quicksight-dataset-decimaldatasetparameter-defaultvalues

id

An identifier for the decimal parameter created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html#cfn-quicksight-dataset-decimaldatasetparameter-id

name

The name of the decimal parameter that is created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html#cfn-quicksight-dataset-decimaldatasetparameter-name

value_type

The value type of the dataset parameter.

Valid values are single value or multi value .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html#cfn-quicksight-dataset-decimaldatasetparameter-valuetype

DestinationTableProperty

class CfnDataSet.DestinationTableProperty(*, alias, source)

Bases: object

Defines a destination table in data preparation that receives the final transformed data.

Parameters:

alias (str) – Alias for the destination table.
source (Union[IResolvable, DestinationTableSourceProperty, Dict[str, Any]]) – The source configuration that specifies which transform operation provides data to this destination table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-destinationtable.html

ExampleMetadata:

fixture=_generated

Example:

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

destination_table_property = quicksight.CfnDataSet.DestinationTableProperty(
    alias="alias",
    source=quicksight.CfnDataSet.DestinationTableSourceProperty(
        transform_operation_id="transformOperationId"
    )
)

Attributes

alias

Alias for the destination table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-destinationtable.html#cfn-quicksight-dataset-destinationtable-alias

source

The source configuration that specifies which transform operation provides data to this destination table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-destinationtable.html#cfn-quicksight-dataset-destinationtable-source

DestinationTableSourceProperty

class CfnDataSet.DestinationTableSourceProperty(*, transform_operation_id)

Bases: object

Specifies the source of data for a destination table, including the transform operation and column mappings.

Parameters:: transform_operation_id (str) – The identifier of the transform operation that provides data to the destination table.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-destinationtablesource.html
ExampleMetadata:: fixture=_generated

Example:

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

destination_table_source_property = quicksight.CfnDataSet.DestinationTableSourceProperty(
    transform_operation_id="transformOperationId"
)

Attributes

transform_operation_id

The identifier of the transform operation that provides data to the destination table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-destinationtablesource.html#cfn-quicksight-dataset-destinationtablesource-transformoperationid

FieldFolderProperty

class CfnDataSet.FieldFolderProperty(*, columns=None, description=None)

Bases: object

A FieldFolder element is a folder that contains fields and nested subfolders.

Parameters:

columns (Optional[Sequence[str]]) – A folder has a list of columns. A column can only be in one folder.
description (Optional[str]) – The description for a field folder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-fieldfolder.html

ExampleMetadata:

fixture=_generated

Example:

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

field_folder_property = quicksight.CfnDataSet.FieldFolderProperty(
    columns=["columns"],
    description="description"
)

Attributes

columns

A folder has a list of columns.

A column can only be in one folder.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-fieldfolder.html#cfn-quicksight-dataset-fieldfolder-columns

description

The description for a field folder.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-fieldfolder.html#cfn-quicksight-dataset-fieldfolder-description

FilterOperationProperty

class CfnDataSet.FilterOperationProperty(*, condition_expression=None, date_filter_condition=None, numeric_filter_condition=None, string_filter_condition=None)

Bases: object

A transform operation that filters rows based on a condition.

Parameters:

condition_expression (Optional[str]) – An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
date_filter_condition (Union[IResolvable, DataSetDateFilterConditionProperty, Dict[str, Any], None]) – A date-based filter condition within a filter operation.
numeric_filter_condition (Union[IResolvable, DataSetNumericFilterConditionProperty, Dict[str, Any], None]) – A numeric-based filter condition within a filter operation.
string_filter_condition (Union[IResolvable, DataSetStringFilterConditionProperty, Dict[str, Any], None]) – A string-based filter condition within a filter operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filteroperation.html

ExampleMetadata:

fixture=_generated

Example:

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

filter_operation_property = quicksight.CfnDataSet.FilterOperationProperty(
    condition_expression="conditionExpression",
    date_filter_condition=quicksight.CfnDataSet.DataSetDateFilterConditionProperty(
        column_name="columnName",
        comparison_filter_condition=quicksight.CfnDataSet.DataSetDateComparisonFilterConditionProperty(
            operator="operator",

            # the properties below are optional
            value=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                static_value="staticValue"
            )
        ),
        range_filter_condition=quicksight.CfnDataSet.DataSetDateRangeFilterConditionProperty(
            include_maximum=False,
            include_minimum=False,
            range_maximum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                static_value="staticValue"
            ),
            range_minimum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                static_value="staticValue"
            )
        )
    ),
    numeric_filter_condition=quicksight.CfnDataSet.DataSetNumericFilterConditionProperty(
        column_name="columnName",
        comparison_filter_condition=quicksight.CfnDataSet.DataSetNumericComparisonFilterConditionProperty(
            operator="operator",

            # the properties below are optional
            value=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                static_value=123
            )
        ),
        range_filter_condition=quicksight.CfnDataSet.DataSetNumericRangeFilterConditionProperty(
            include_maximum=False,
            include_minimum=False,
            range_maximum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                static_value=123
            ),
            range_minimum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                static_value=123
            )
        )
    ),
    string_filter_condition=quicksight.CfnDataSet.DataSetStringFilterConditionProperty(
        column_name="columnName",
        comparison_filter_condition=quicksight.CfnDataSet.DataSetStringComparisonFilterConditionProperty(
            operator="operator",

            # the properties below are optional
            value=quicksight.CfnDataSet.DataSetStringFilterValueProperty(
                static_value="staticValue"
            )
        ),
        list_filter_condition=quicksight.CfnDataSet.DataSetStringListFilterConditionProperty(
            operator="operator",

            # the properties below are optional
            values=quicksight.CfnDataSet.DataSetStringListFilterValueProperty(
                static_values=["staticValues"]
            )
        )
    )
)

Attributes

condition_expression

An expression that must evaluate to a Boolean value.

Rows for which the expression evaluates to true are kept in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filteroperation.html#cfn-quicksight-dataset-filteroperation-conditionexpression

date_filter_condition

A date-based filter condition within a filter operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filteroperation.html#cfn-quicksight-dataset-filteroperation-datefiltercondition

numeric_filter_condition

A numeric-based filter condition within a filter operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filteroperation.html#cfn-quicksight-dataset-filteroperation-numericfiltercondition

string_filter_condition

A string-based filter condition within a filter operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filteroperation.html#cfn-quicksight-dataset-filteroperation-stringfiltercondition

FiltersOperationProperty

class CfnDataSet.FiltersOperationProperty(*, alias, filter_operations, source)

Bases: object

A transform operation that applies one or more filter conditions.

Parameters:

alias (str) – Alias for this operation.
filter_operations (Union[IResolvable, Sequence[Union[IResolvable, FilterOperationProperty, Dict[str, Any]]]]) – The list of filter operations to apply.
source (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any]]) – The source transform operation that provides input data for filtering.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filtersoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

filters_operation_property = quicksight.CfnDataSet.FiltersOperationProperty(
    alias="alias",
    filter_operations=[quicksight.CfnDataSet.FilterOperationProperty(
        condition_expression="conditionExpression",
        date_filter_condition=quicksight.CfnDataSet.DataSetDateFilterConditionProperty(
            column_name="columnName",
            comparison_filter_condition=quicksight.CfnDataSet.DataSetDateComparisonFilterConditionProperty(
                operator="operator",

                # the properties below are optional
                value=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                    static_value="staticValue"
                )
            ),
            range_filter_condition=quicksight.CfnDataSet.DataSetDateRangeFilterConditionProperty(
                include_maximum=False,
                include_minimum=False,
                range_maximum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                    static_value="staticValue"
                ),
                range_minimum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                    static_value="staticValue"
                )
            )
        ),
        numeric_filter_condition=quicksight.CfnDataSet.DataSetNumericFilterConditionProperty(
            column_name="columnName",
            comparison_filter_condition=quicksight.CfnDataSet.DataSetNumericComparisonFilterConditionProperty(
                operator="operator",

                # the properties below are optional
                value=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                    static_value=123
                )
            ),
            range_filter_condition=quicksight.CfnDataSet.DataSetNumericRangeFilterConditionProperty(
                include_maximum=False,
                include_minimum=False,
                range_maximum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                    static_value=123
                ),
                range_minimum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                    static_value=123
                )
            )
        ),
        string_filter_condition=quicksight.CfnDataSet.DataSetStringFilterConditionProperty(
            column_name="columnName",
            comparison_filter_condition=quicksight.CfnDataSet.DataSetStringComparisonFilterConditionProperty(
                operator="operator",

                # the properties below are optional
                value=quicksight.CfnDataSet.DataSetStringFilterValueProperty(
                    static_value="staticValue"
                )
            ),
            list_filter_condition=quicksight.CfnDataSet.DataSetStringListFilterConditionProperty(
                operator="operator",

                # the properties below are optional
                values=quicksight.CfnDataSet.DataSetStringListFilterValueProperty(
                    static_values=["staticValues"]
                )
            )
        )
    )],
    source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    )
)

Attributes

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filtersoperation.html#cfn-quicksight-dataset-filtersoperation-alias

filter_operations

The list of filter operations to apply.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filtersoperation.html#cfn-quicksight-dataset-filtersoperation-filteroperations

source

The source transform operation that provides input data for filtering.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-filtersoperation.html#cfn-quicksight-dataset-filtersoperation-source

GeoSpatialColumnGroupProperty

class CfnDataSet.GeoSpatialColumnGroupProperty(*, columns, name, country_code=None)

Bases: object

Geospatial column group that denotes a hierarchy.

Parameters:

columns (Sequence[str]) – Columns in this hierarchy.
name (str) – A display name for the hierarchy.
country_code (Optional[str]) – Country code.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-geospatialcolumngroup.html

ExampleMetadata:

fixture=_generated

Example:

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

geo_spatial_column_group_property = quicksight.CfnDataSet.GeoSpatialColumnGroupProperty(
    columns=["columns"],
    name="name",

    # the properties below are optional
    country_code="countryCode"
)

Attributes

columns

Columns in this hierarchy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-geospatialcolumngroup.html#cfn-quicksight-dataset-geospatialcolumngroup-columns

country_code

Country code.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-geospatialcolumngroup.html#cfn-quicksight-dataset-geospatialcolumngroup-countrycode

name

A display name for the hierarchy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-geospatialcolumngroup.html#cfn-quicksight-dataset-geospatialcolumngroup-name

ImportTableOperationProperty

class CfnDataSet.ImportTableOperationProperty(*, alias, source)

Bases: object

A transform operation that imports data from a source table.

Parameters:

alias (str) – Alias for this operation.
source (Union[IResolvable, ImportTableOperationSourceProperty, Dict[str, Any]]) – The source configuration that specifies which source table to import and any column mappings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

import_table_operation_property = quicksight.CfnDataSet.ImportTableOperationProperty(
    alias="alias",
    source=quicksight.CfnDataSet.ImportTableOperationSourceProperty(
        source_table_id="sourceTableId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    )
)

Attributes

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperation.html#cfn-quicksight-dataset-importtableoperation-alias

source

The source configuration that specifies which source table to import and any column mappings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperation.html#cfn-quicksight-dataset-importtableoperation-source

ImportTableOperationSourceProperty

class CfnDataSet.ImportTableOperationSourceProperty(*, source_table_id, column_id_mappings=None)

Bases: object

Specifies the source table and column mappings for an import table operation.

Parameters:

source_table_id (str) – The identifier of the source table to import data from.
column_id_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSetColumnIdMappingProperty, Dict[str, Any]]], None]) – The mappings between source column identifiers and target column identifiers during the import.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperationsource.html

ExampleMetadata:

fixture=_generated

Example:

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

import_table_operation_source_property = quicksight.CfnDataSet.ImportTableOperationSourceProperty(
    source_table_id="sourceTableId",

    # the properties below are optional
    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
        source_column_id="sourceColumnId",
        target_column_id="targetColumnId"
    )]
)

Attributes

column_id_mappings

The mappings between source column identifiers and target column identifiers during the import.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperationsource.html#cfn-quicksight-dataset-importtableoperationsource-columnidmappings

source_table_id

The identifier of the source table to import data from.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-importtableoperationsource.html#cfn-quicksight-dataset-importtableoperationsource-sourcetableid

IncrementalRefreshProperty

class CfnDataSet.IncrementalRefreshProperty(*, lookback_window)

Bases: object

The incremental refresh configuration for a dataset.

Parameters:: lookback_window (Union[IResolvable, LookbackWindowProperty, Dict[str, Any]]) – The lookback window setup for an incremental refresh configuration.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-incrementalrefresh.html
ExampleMetadata:: fixture=_generated

Example:

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

incremental_refresh_property = quicksight.CfnDataSet.IncrementalRefreshProperty(
    lookback_window=quicksight.CfnDataSet.LookbackWindowProperty(
        column_name="columnName",
        size=123,
        size_unit="sizeUnit"
    )
)

Attributes

lookback_window

The lookback window setup for an incremental refresh configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-incrementalrefresh.html#cfn-quicksight-dataset-incrementalrefresh-lookbackwindow

IngestionWaitPolicyProperty

class CfnDataSet.IngestionWaitPolicyProperty(*, ingestion_wait_time_in_hours=None, wait_for_spice_ingestion=None)

Bases: object

The wait policy to use when creating or updating a Dataset.

The default is to wait for SPICE ingestion to finish with timeout of 36 hours.

Parameters:

ingestion_wait_time_in_hours (Union[int, float, None]) – The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours. Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true. Default: - 36
wait_for_spice_ingestion (Union[bool, IResolvable, None]) – Wait for SPICE ingestion to finish to mark dataset creation or update as successful. Default (true). Applicable only when DataSetImportMode mode is set to SPICE. Default: - true

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-ingestionwaitpolicy.html

ExampleMetadata:

fixture=_generated

Example:

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

ingestion_wait_policy_property = quicksight.CfnDataSet.IngestionWaitPolicyProperty(
    ingestion_wait_time_in_hours=123,
    wait_for_spice_ingestion=False
)

Attributes

ingestion_wait_time_in_hours

The maximum time (in hours) to wait for Ingestion to complete.

Default timeout is 36 hours. Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

Default:

36

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-ingestionwaitpolicy.html#cfn-quicksight-dataset-ingestionwaitpolicy-ingestionwaittimeinhours

wait_for_spice_ingestion

Wait for SPICE ingestion to finish to mark dataset creation or update as successful.

Default (true). Applicable only when DataSetImportMode mode is set to SPICE.

Default:

true

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-ingestionwaitpolicy.html#cfn-quicksight-dataset-ingestionwaitpolicy-waitforspiceingestion

InputColumnProperty

class CfnDataSet.InputColumnProperty(*, name, type, id=None, sub_type=None)

Bases: object

Metadata for a column that is used as the input of a transform operation.

Parameters:

name (str) – The name of this column in the underlying data source.
type (str) – The data type of the column.
id (Optional[str]) – A unique identifier for the input column.
sub_type (Optional[str]) – The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html

ExampleMetadata:

fixture=_generated

Example:

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

input_column_property = quicksight.CfnDataSet.InputColumnProperty(
    name="name",
    type="type",

    # the properties below are optional
    id="id",
    sub_type="subType"
)

Attributes

id

A unique identifier for the input column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html#cfn-quicksight-dataset-inputcolumn-id

name

The name of this column in the underlying data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html#cfn-quicksight-dataset-inputcolumn-name

sub_type

The sub data type of the column.

Sub types are only available for decimal columns that are part of a SPICE dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html#cfn-quicksight-dataset-inputcolumn-subtype

type

The data type of the column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html#cfn-quicksight-dataset-inputcolumn-type

IntegerDatasetParameterDefaultValuesProperty

class CfnDataSet.IntegerDatasetParameterDefaultValuesProperty(*, static_values=None)

Bases: object

A list of default values for a given integer parameter.

This structure only accepts static values.

Parameters:: static_values (Union[Sequence[Union[int, float]], IResolvable, None]) – A list of static default values for a given integer parameter.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameterdefaultvalues.html
ExampleMetadata:: fixture=_generated

Example:

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

integer_dataset_parameter_default_values_property = quicksight.CfnDataSet.IntegerDatasetParameterDefaultValuesProperty(
    static_values=[123]
)

Attributes

static_values

A list of static default values for a given integer parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameterdefaultvalues.html#cfn-quicksight-dataset-integerdatasetparameterdefaultvalues-staticvalues

IntegerDatasetParameterProperty

class CfnDataSet.IntegerDatasetParameterProperty(*, id, name, value_type, default_values=None)

Bases: object

An integer parameter that is created in the dataset.

Parameters:

id (str) – An identifier for the integer parameter created in the dataset.
name (str) – The name of the integer parameter that is created in the dataset.
value_type (str) – The value type of the dataset parameter. Valid values are single value or multi value .
default_values (Union[IResolvable, IntegerDatasetParameterDefaultValuesProperty, Dict[str, Any], None]) – A list of default values for a given integer parameter. This structure only accepts static values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html

ExampleMetadata:

fixture=_generated

Example:

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

integer_dataset_parameter_property = quicksight.CfnDataSet.IntegerDatasetParameterProperty(
    id="id",
    name="name",
    value_type="valueType",

    # the properties below are optional
    default_values=quicksight.CfnDataSet.IntegerDatasetParameterDefaultValuesProperty(
        static_values=[123]
    )
)

Attributes

default_values

A list of default values for a given integer parameter.

This structure only accepts static values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html#cfn-quicksight-dataset-integerdatasetparameter-defaultvalues

id

An identifier for the integer parameter created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html#cfn-quicksight-dataset-integerdatasetparameter-id

name

The name of the integer parameter that is created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html#cfn-quicksight-dataset-integerdatasetparameter-name

value_type

The value type of the dataset parameter.

Valid values are single value or multi value .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html#cfn-quicksight-dataset-integerdatasetparameter-valuetype

JoinInstructionProperty

class CfnDataSet.JoinInstructionProperty(*, left_operand, on_clause, right_operand, type, left_join_key_properties=None, right_join_key_properties=None)

Bases: object

The instructions associated with a join.

Parameters:

left_operand (str) – The operand on the left side of a join.
on_clause (str) – The join instructions provided in the ON clause of a join.
right_operand (str) – The operand on the right side of a join.
type (str) – The type of join that it is.
left_join_key_properties (Union[IResolvable, JoinKeyPropertiesProperty, Dict[str, Any], None]) – Join key properties of the left operand.
right_join_key_properties (Union[IResolvable, JoinKeyPropertiesProperty, Dict[str, Any], None]) – Join key properties of the right operand.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joininstruction.html

ExampleMetadata:

fixture=_generated

Example:

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

join_instruction_property = quicksight.CfnDataSet.JoinInstructionProperty(
    left_operand="leftOperand",
    on_clause="onClause",
    right_operand="rightOperand",
    type="type",

    # the properties below are optional
    left_join_key_properties=quicksight.CfnDataSet.JoinKeyPropertiesProperty(
        unique_key=False
    ),
    right_join_key_properties=quicksight.CfnDataSet.JoinKeyPropertiesProperty(
        unique_key=False
    )
)

Attributes

left_join_key_properties

Join key properties of the left operand.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joininstruction.html#cfn-quicksight-dataset-joininstruction-leftjoinkeyproperties

left_operand

The operand on the left side of a join.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joininstruction.html#cfn-quicksight-dataset-joininstruction-leftoperand

on_clause

The join instructions provided in the ON clause of a join.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joininstruction.html#cfn-quicksight-dataset-joininstruction-onclause

right_join_key_properties

Join key properties of the right operand.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joininstruction.html#cfn-quicksight-dataset-joininstruction-rightjoinkeyproperties

right_operand

The operand on the right side of a join.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joininstruction.html#cfn-quicksight-dataset-joininstruction-rightoperand

type

The type of join that it is.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joininstruction.html#cfn-quicksight-dataset-joininstruction-type

JoinKeyPropertiesProperty

class CfnDataSet.JoinKeyPropertiesProperty(*, unique_key=None)

Bases: object

Properties associated with the columns participating in a join.

Parameters:: unique_key (Union[bool, IResolvable, None]) – A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Quick Suite to optimize query performance.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinkeyproperties.html
ExampleMetadata:: fixture=_generated

Example:

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

join_key_properties_property = quicksight.CfnDataSet.JoinKeyPropertiesProperty(
    unique_key=False
)

Attributes

unique_key

A value that indicates that a row in a table is uniquely identified by the columns in a join key.

This is used by Quick Suite to optimize query performance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinkeyproperties.html#cfn-quicksight-dataset-joinkeyproperties-uniquekey

JoinOperandPropertiesProperty

class CfnDataSet.JoinOperandPropertiesProperty(*, output_column_name_overrides)

Bases: object

Properties that control how columns are handled for a join operand, including column name overrides.

Parameters:: output_column_name_overrides (Union[IResolvable, Sequence[Union[IResolvable, OutputColumnNameOverrideProperty, Dict[str, Any]]]]) – A list of column name overrides to apply to the join operand’s output columns.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperandproperties.html
ExampleMetadata:: fixture=_generated

Example:

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

join_operand_properties_property = quicksight.CfnDataSet.JoinOperandPropertiesProperty(
    output_column_name_overrides=[quicksight.CfnDataSet.OutputColumnNameOverrideProperty(
        output_column_name="outputColumnName",

        # the properties below are optional
        source_column_name="sourceColumnName"
    )]
)

Attributes

output_column_name_overrides

A list of column name overrides to apply to the join operand’s output columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperandproperties.html#cfn-quicksight-dataset-joinoperandproperties-outputcolumnnameoverrides

JoinOperationProperty

class CfnDataSet.JoinOperationProperty(*, alias, left_operand, on_clause, right_operand, type, left_operand_properties=None, right_operand_properties=None)

Bases: object

A transform operation that combines data from two sources based on specified join conditions.

Parameters:

alias (str) – Alias for this operation.
left_operand (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any]]) – The left operand for the join operation.
on_clause (str) – The join condition that specifies how to match rows between the left and right operands.
right_operand (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any]]) – The right operand for the join operation.
type (str) – The type of join to perform, such as INNER , LEFT , RIGHT , or OUTER .
left_operand_properties (Union[IResolvable, JoinOperandPropertiesProperty, Dict[str, Any], None]) – Properties that control how the left operand’s columns are handled in the join result.
right_operand_properties (Union[IResolvable, JoinOperandPropertiesProperty, Dict[str, Any], None]) – Properties that control how the right operand’s columns are handled in the join result.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

join_operation_property = quicksight.CfnDataSet.JoinOperationProperty(
    alias="alias",
    left_operand=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    ),
    on_clause="onClause",
    right_operand=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    ),
    type="type",

    # the properties below are optional
    left_operand_properties=quicksight.CfnDataSet.JoinOperandPropertiesProperty(
        output_column_name_overrides=[quicksight.CfnDataSet.OutputColumnNameOverrideProperty(
            output_column_name="outputColumnName",

            # the properties below are optional
            source_column_name="sourceColumnName"
        )]
    ),
    right_operand_properties=quicksight.CfnDataSet.JoinOperandPropertiesProperty(
        output_column_name_overrides=[quicksight.CfnDataSet.OutputColumnNameOverrideProperty(
            output_column_name="outputColumnName",

            # the properties below are optional
            source_column_name="sourceColumnName"
        )]
    )
)

Attributes

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-alias

left_operand

The left operand for the join operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-leftoperand

left_operand_properties

Properties that control how the left operand’s columns are handled in the join result.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-leftoperandproperties

on_clause

The join condition that specifies how to match rows between the left and right operands.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-onclause

right_operand

The right operand for the join operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-rightoperand

right_operand_properties

Properties that control how the right operand’s columns are handled in the join result.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-rightoperandproperties

type

The type of join to perform, such as INNER , LEFT , RIGHT , or OUTER .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinoperation.html#cfn-quicksight-dataset-joinoperation-type

LogicalTableProperty

class CfnDataSet.LogicalTableProperty(*, alias, source, data_transforms=None)

Bases: object

A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.

Parameters:

alias (str)
source (Union[IResolvable, LogicalTableSourceProperty, Dict[str, Any]]) – This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
data_transforms (Union[IResolvable, Sequence[Union[IResolvable, TransformOperationProperty, Dict[str, Any]]], None]) – For this structure to be valid, only one of the attributes can be non-null.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-logicaltable.html

ExampleMetadata:

fixture=_generated

Example:

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

logical_table_property = quicksight.CfnDataSet.LogicalTableProperty(
    alias="alias",
    source=quicksight.CfnDataSet.LogicalTableSourceProperty(
        data_set_arn="dataSetArn",
        join_instruction=quicksight.CfnDataSet.JoinInstructionProperty(
            left_operand="leftOperand",
            on_clause="onClause",
            right_operand="rightOperand",
            type="type",

            # the properties below are optional
            left_join_key_properties=quicksight.CfnDataSet.JoinKeyPropertiesProperty(
                unique_key=False
            ),
            right_join_key_properties=quicksight.CfnDataSet.JoinKeyPropertiesProperty(
                unique_key=False
            )
        ),
        physical_table_id="physicalTableId"
    ),

    # the properties below are optional
    data_transforms=[quicksight.CfnDataSet.TransformOperationProperty(
        cast_column_type_operation=quicksight.CfnDataSet.CastColumnTypeOperationProperty(
            column_name="columnName",
            new_column_type="newColumnType",

            # the properties below are optional
            format="format",
            sub_type="subType"
        ),
        create_columns_operation=quicksight.CfnDataSet.CreateColumnsOperationProperty(
            columns=[quicksight.CfnDataSet.CalculatedColumnProperty(
                column_id="columnId",
                column_name="columnName",
                expression="expression"
            )],

            # the properties below are optional
            alias="alias",
            source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                transform_operation_id="transformOperationId",

                # the properties below are optional
                column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                    source_column_id="sourceColumnId",
                    target_column_id="targetColumnId"
                )]
            )
        ),
        filter_operation=quicksight.CfnDataSet.FilterOperationProperty(
            condition_expression="conditionExpression",
            date_filter_condition=quicksight.CfnDataSet.DataSetDateFilterConditionProperty(
                column_name="columnName",
                comparison_filter_condition=quicksight.CfnDataSet.DataSetDateComparisonFilterConditionProperty(
                    operator="operator",

                    # the properties below are optional
                    value=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                        static_value="staticValue"
                    )
                ),
                range_filter_condition=quicksight.CfnDataSet.DataSetDateRangeFilterConditionProperty(
                    include_maximum=False,
                    include_minimum=False,
                    range_maximum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                        static_value="staticValue"
                    ),
                    range_minimum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                        static_value="staticValue"
                    )
                )
            ),
            numeric_filter_condition=quicksight.CfnDataSet.DataSetNumericFilterConditionProperty(
                column_name="columnName",
                comparison_filter_condition=quicksight.CfnDataSet.DataSetNumericComparisonFilterConditionProperty(
                    operator="operator",

                    # the properties below are optional
                    value=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                        static_value=123
                    )
                ),
                range_filter_condition=quicksight.CfnDataSet.DataSetNumericRangeFilterConditionProperty(
                    include_maximum=False,
                    include_minimum=False,
                    range_maximum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                        static_value=123
                    ),
                    range_minimum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                        static_value=123
                    )
                )
            ),
            string_filter_condition=quicksight.CfnDataSet.DataSetStringFilterConditionProperty(
                column_name="columnName",
                comparison_filter_condition=quicksight.CfnDataSet.DataSetStringComparisonFilterConditionProperty(
                    operator="operator",

                    # the properties below are optional
                    value=quicksight.CfnDataSet.DataSetStringFilterValueProperty(
                        static_value="staticValue"
                    )
                ),
                list_filter_condition=quicksight.CfnDataSet.DataSetStringListFilterConditionProperty(
                    operator="operator",

                    # the properties below are optional
                    values=quicksight.CfnDataSet.DataSetStringListFilterValueProperty(
                        static_values=["staticValues"]
                    )
                )
            )
        ),
        override_dataset_parameter_operation=quicksight.CfnDataSet.OverrideDatasetParameterOperationProperty(
            parameter_name="parameterName",

            # the properties below are optional
            new_default_values=quicksight.CfnDataSet.NewDefaultValuesProperty(
                date_time_static_values=["dateTimeStaticValues"],
                decimal_static_values=[123],
                integer_static_values=[123],
                string_static_values=["stringStaticValues"]
            ),
            new_parameter_name="newParameterName"
        ),
        project_operation=quicksight.CfnDataSet.ProjectOperationProperty(
            alias="alias",
            projected_columns=["projectedColumns"],
            source=quicksight.CfnDataSet.TransformOperationSourceProperty(
                transform_operation_id="transformOperationId",

                # the properties below are optional
                column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                    source_column_id="sourceColumnId",
                    target_column_id="targetColumnId"
                )]
            )
        ),
        rename_column_operation=quicksight.CfnDataSet.RenameColumnOperationProperty(
            column_name="columnName",
            new_column_name="newColumnName"
        ),
        tag_column_operation=quicksight.CfnDataSet.TagColumnOperationProperty(
            column_name="columnName",
            tags=[quicksight.CfnDataSet.ColumnTagProperty(
                column_description=quicksight.CfnDataSet.ColumnDescriptionProperty(
                    text="text"
                ),
                column_geographic_role="columnGeographicRole"
            )]
        ),
        untag_column_operation=quicksight.CfnDataSet.UntagColumnOperationProperty(
            column_name="columnName",
            tag_names=["tagNames"]
        )
    )]
)

Attributes

alias

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-logicaltable.html#cfn-quicksight-dataset-logicaltable-alias

Type:: see

data_transforms

For this structure to be valid, only one of the attributes can be non-null.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-logicaltable.html#cfn-quicksight-dataset-logicaltable-datatransforms

source

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-logicaltable.html#cfn-quicksight-dataset-logicaltable-source

LogicalTableSourceProperty

class CfnDataSet.LogicalTableSourceProperty(*, data_set_arn=None, join_instruction=None, physical_table_id=None)

Bases: object

Information about the source of a logical table.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Parameters:

data_set_arn (Optional[str]) – The Amazon Resource Number (ARN) of the parent dataset.
join_instruction (Union[IResolvable, JoinInstructionProperty, Dict[str, Any], None]) – Specifies the result of a join of two logical tables.
physical_table_id (Optional[str]) – Physical table ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-logicaltablesource.html

ExampleMetadata:

fixture=_generated

Example:

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

logical_table_source_property = quicksight.CfnDataSet.LogicalTableSourceProperty(
    data_set_arn="dataSetArn",
    join_instruction=quicksight.CfnDataSet.JoinInstructionProperty(
        left_operand="leftOperand",
        on_clause="onClause",
        right_operand="rightOperand",
        type="type",

        # the properties below are optional
        left_join_key_properties=quicksight.CfnDataSet.JoinKeyPropertiesProperty(
            unique_key=False
        ),
        right_join_key_properties=quicksight.CfnDataSet.JoinKeyPropertiesProperty(
            unique_key=False
        )
    ),
    physical_table_id="physicalTableId"
)

Attributes

data_set_arn

The Amazon Resource Number (ARN) of the parent dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-logicaltablesource.html#cfn-quicksight-dataset-logicaltablesource-datasetarn

join_instruction

Specifies the result of a join of two logical tables.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-logicaltablesource.html#cfn-quicksight-dataset-logicaltablesource-joininstruction

physical_table_id

Physical table ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-logicaltablesource.html#cfn-quicksight-dataset-logicaltablesource-physicaltableid

LookbackWindowProperty

class CfnDataSet.LookbackWindowProperty(*, column_name, size, size_unit)

Bases: object

The lookback window setup of an incremental refresh configuration.

Parameters:

column_name (str) – The name of the lookback window column.
size (Union[int, float]) – The lookback window column size. Default: - 0
size_unit (str) – The size unit that is used for the lookback window column. Valid values for this structure are HOUR , DAY , and WEEK .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-lookbackwindow.html

ExampleMetadata:

fixture=_generated

Example:

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

lookback_window_property = quicksight.CfnDataSet.LookbackWindowProperty(
    column_name="columnName",
    size=123,
    size_unit="sizeUnit"
)

Attributes

column_name

The name of the lookback window column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-lookbackwindow.html#cfn-quicksight-dataset-lookbackwindow-columnname

size

The lookback window column size.

Default:

0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-lookbackwindow.html#cfn-quicksight-dataset-lookbackwindow-size

size_unit

The size unit that is used for the lookback window column.

Valid values for this structure are HOUR , DAY , and WEEK .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-lookbackwindow.html#cfn-quicksight-dataset-lookbackwindow-sizeunit

NewDefaultValuesProperty

class CfnDataSet.NewDefaultValuesProperty(*, date_time_static_values=None, decimal_static_values=None, integer_static_values=None, string_static_values=None)

Bases: object

The new default values for the parameter.

Parameters:

date_time_static_values (Optional[Sequence[str]]) – A list of static default values for a given date time parameter. The valid format for this property is yyyy-MM-dd’T’HH:mm:ss’Z’ .
decimal_static_values (Union[Sequence[Union[int, float]], IResolvable, None]) – A list of static default values for a given decimal parameter.
integer_static_values (Union[Sequence[Union[int, float]], IResolvable, None]) – A list of static default values for a given integer parameter.
string_static_values (Optional[Sequence[str]]) – A list of static default values for a given string parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-newdefaultvalues.html

ExampleMetadata:

fixture=_generated

Example:

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

new_default_values_property = quicksight.CfnDataSet.NewDefaultValuesProperty(
    date_time_static_values=["dateTimeStaticValues"],
    decimal_static_values=[123],
    integer_static_values=[123],
    string_static_values=["stringStaticValues"]
)

Attributes

date_time_static_values

A list of static default values for a given date time parameter.

The valid format for this property is yyyy-MM-dd’T’HH:mm:ss’Z’ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-newdefaultvalues.html#cfn-quicksight-dataset-newdefaultvalues-datetimestaticvalues

decimal_static_values

A list of static default values for a given decimal parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-newdefaultvalues.html#cfn-quicksight-dataset-newdefaultvalues-decimalstaticvalues

integer_static_values

A list of static default values for a given integer parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-newdefaultvalues.html#cfn-quicksight-dataset-newdefaultvalues-integerstaticvalues

string_static_values

A list of static default values for a given string parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-newdefaultvalues.html#cfn-quicksight-dataset-newdefaultvalues-stringstaticvalues

OutputColumnNameOverrideProperty

class CfnDataSet.OutputColumnNameOverrideProperty(*, output_column_name, source_column_name=None)

Bases: object

Specifies a mapping to override the name of an output column from a transform operation.

Parameters:

output_column_name (str) – The new name to assign to the column in the output.
source_column_name (Optional[str]) – The original name of the column from the source transform operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumnnameoverride.html

ExampleMetadata:

fixture=_generated

Example:

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

output_column_name_override_property = quicksight.CfnDataSet.OutputColumnNameOverrideProperty(
    output_column_name="outputColumnName",

    # the properties below are optional
    source_column_name="sourceColumnName"
)

Attributes

output_column_name

The new name to assign to the column in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumnnameoverride.html#cfn-quicksight-dataset-outputcolumnnameoverride-outputcolumnname

source_column_name

The original name of the column from the source transform operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumnnameoverride.html#cfn-quicksight-dataset-outputcolumnnameoverride-sourcecolumnname

OutputColumnProperty

class CfnDataSet.OutputColumnProperty(*, description=None, id=None, name=None, sub_type=None, type=None)

Bases: object

Output column.

Parameters:

description (Optional[str]) – A description for a column.
id (Optional[str]) – A unique identifier for the output column.
name (Optional[str]) – The display name of the column..
sub_type (Optional[str]) – The sub data type of the column.
type (Optional[str]) – The data type of the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html

ExampleMetadata:

fixture=_generated

Example:

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

output_column_property = quicksight.CfnDataSet.OutputColumnProperty(
    description="description",
    id="id",
    name="name",
    sub_type="subType",
    type="type"
)

Attributes

description

A description for a column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html#cfn-quicksight-dataset-outputcolumn-description

id

A unique identifier for the output column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html#cfn-quicksight-dataset-outputcolumn-id

name

The display name of the column..

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html#cfn-quicksight-dataset-outputcolumn-name

sub_type

The sub data type of the column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html#cfn-quicksight-dataset-outputcolumn-subtype

type

The data type of the column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-outputcolumn.html#cfn-quicksight-dataset-outputcolumn-type

OverrideDatasetParameterOperationProperty

class CfnDataSet.OverrideDatasetParameterOperationProperty(*, parameter_name, new_default_values=None, new_parameter_name=None)

Bases: object

A transform operation that overrides the dataset parameter values that are defined in another dataset.

Parameters:

parameter_name (str) – The name of the parameter to be overridden with different values.
new_default_values (Union[IResolvable, NewDefaultValuesProperty, Dict[str, Any], None]) – The new default values for the parameter.
new_parameter_name (Optional[str]) – The new name for the parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-overridedatasetparameteroperation.html

ExampleMetadata:

fixture=_generated

Example:

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

override_dataset_parameter_operation_property = quicksight.CfnDataSet.OverrideDatasetParameterOperationProperty(
    parameter_name="parameterName",

    # the properties below are optional
    new_default_values=quicksight.CfnDataSet.NewDefaultValuesProperty(
        date_time_static_values=["dateTimeStaticValues"],
        decimal_static_values=[123],
        integer_static_values=[123],
        string_static_values=["stringStaticValues"]
    ),
    new_parameter_name="newParameterName"
)

Attributes

new_default_values

The new default values for the parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-overridedatasetparameteroperation.html#cfn-quicksight-dataset-overridedatasetparameteroperation-newdefaultvalues

new_parameter_name

The new name for the parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-overridedatasetparameteroperation.html#cfn-quicksight-dataset-overridedatasetparameteroperation-newparametername

parameter_name

The name of the parameter to be overridden with different values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-overridedatasetparameteroperation.html#cfn-quicksight-dataset-overridedatasetparameteroperation-parametername

ParentDataSetProperty

class CfnDataSet.ParentDataSetProperty(*, data_set_arn, input_columns)

Bases: object

References a parent dataset that serves as a data source, including its columns and metadata.

Parameters:

data_set_arn (str) – The Amazon Resource Name (ARN) of the parent dataset.
input_columns (Union[IResolvable, Sequence[Union[IResolvable, InputColumnProperty, Dict[str, Any]]]]) – The list of input columns available from the parent dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-parentdataset.html

ExampleMetadata:

fixture=_generated

Example:

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

parent_data_set_property = quicksight.CfnDataSet.ParentDataSetProperty(
    data_set_arn="dataSetArn",
    input_columns=[quicksight.CfnDataSet.InputColumnProperty(
        name="name",
        type="type",

        # the properties below are optional
        id="id",
        sub_type="subType"
    )]
)

Attributes

data_set_arn

The Amazon Resource Name (ARN) of the parent dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-parentdataset.html#cfn-quicksight-dataset-parentdataset-datasetarn

input_columns

The list of input columns available from the parent dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-parentdataset.html#cfn-quicksight-dataset-parentdataset-inputcolumns

PerformanceConfigurationProperty

class CfnDataSet.PerformanceConfigurationProperty(*, unique_keys=None)

Bases: object

Parameters:: unique_keys (Union[IResolvable, Sequence[Union[IResolvable, UniqueKeyProperty, Dict[str, Any]]], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-performanceconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

performance_configuration_property = quicksight.CfnDataSet.PerformanceConfigurationProperty(
    unique_keys=[quicksight.CfnDataSet.UniqueKeyProperty(
        column_names=["columnNames"]
    )]
)

Attributes

unique_keys

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-performanceconfiguration.html#cfn-quicksight-dataset-performanceconfiguration-uniquekeys

Type:: see

PhysicalTableProperty

class CfnDataSet.PhysicalTableProperty(*, custom_sql=None, relational_table=None, s3_source=None, saa_s_table=None)

Bases: object

A view of a data source that contains information about the shape of the data in the underlying source.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Parameters:

custom_sql (Union[IResolvable, CustomSqlProperty, Dict[str, Any], None]) – A physical table type built from the results of the custom SQL query.
relational_table (Union[IResolvable, RelationalTableProperty, Dict[str, Any], None]) – A physical table type for relational data sources.
s3_source (Union[IResolvable, S3SourceProperty, Dict[str, Any], None]) – A physical table type for as S3 data source.
saa_s_table (Union[IResolvable, SaaSTableProperty, Dict[str, Any], None]) – A physical table type for Software-as-a-Service (SaaS) sources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html

ExampleMetadata:

fixture=_generated

Example:

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

physical_table_property = quicksight.CfnDataSet.PhysicalTableProperty(
    custom_sql=quicksight.CfnDataSet.CustomSqlProperty(
        columns=[quicksight.CfnDataSet.InputColumnProperty(
            name="name",
            type="type",

            # the properties below are optional
            id="id",
            sub_type="subType"
        )],
        data_source_arn="dataSourceArn",
        name="name",
        sql_query="sqlQuery"
    ),
    relational_table=quicksight.CfnDataSet.RelationalTableProperty(
        data_source_arn="dataSourceArn",
        input_columns=[quicksight.CfnDataSet.InputColumnProperty(
            name="name",
            type="type",

            # the properties below are optional
            id="id",
            sub_type="subType"
        )],
        name="name",

        # the properties below are optional
        catalog="catalog",
        schema="schema"
    ),
    s3_source=quicksight.CfnDataSet.S3SourceProperty(
        data_source_arn="dataSourceArn",
        input_columns=[quicksight.CfnDataSet.InputColumnProperty(
            name="name",
            type="type",

            # the properties below are optional
            id="id",
            sub_type="subType"
        )],

        # the properties below are optional
        upload_settings=quicksight.CfnDataSet.UploadSettingsProperty(
            contains_header=False,
            delimiter="delimiter",
            format="format",
            start_from_row=123,
            text_qualifier="textQualifier"
        )
    ),
    saa_sTable=quicksight.CfnDataSet.SaaSTableProperty(
        data_source_arn="dataSourceArn",
        input_columns=[quicksight.CfnDataSet.InputColumnProperty(
            name="name",
            type="type",

            # the properties below are optional
            id="id",
            sub_type="subType"
        )],
        table_path=[quicksight.CfnDataSet.TablePathElementProperty(
            id="id",
            name="name"
        )]
    )
)

Attributes

custom_sql

A physical table type built from the results of the custom SQL query.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html#cfn-quicksight-dataset-physicaltable-customsql

relational_table

A physical table type for relational data sources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html#cfn-quicksight-dataset-physicaltable-relationaltable

s3_source

A physical table type for as S3 data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html#cfn-quicksight-dataset-physicaltable-s3source

saa_s_table

A physical table type for Software-as-a-Service (SaaS) sources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-physicaltable.html#cfn-quicksight-dataset-physicaltable-saastable

PivotConfigurationProperty

class CfnDataSet.PivotConfigurationProperty(*, pivoted_labels, label_column_name=None)

Bases: object

Configuration for a pivot operation, specifying which column contains labels and how to pivot them.

Parameters:

pivoted_labels (Union[IResolvable, Sequence[Union[IResolvable, PivotedLabelProperty, Dict[str, Any]]]]) – The list of specific label values to pivot into separate columns.
label_column_name (Optional[str]) – The name of the column that contains the labels to be pivoted into separate columns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

pivot_configuration_property = quicksight.CfnDataSet.PivotConfigurationProperty(
    pivoted_labels=[quicksight.CfnDataSet.PivotedLabelProperty(
        label_name="labelName",
        new_column_id="newColumnId",
        new_column_name="newColumnName"
    )],

    # the properties below are optional
    label_column_name="labelColumnName"
)

Attributes

label_column_name

The name of the column that contains the labels to be pivoted into separate columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotconfiguration.html#cfn-quicksight-dataset-pivotconfiguration-labelcolumnname

pivoted_labels

The list of specific label values to pivot into separate columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotconfiguration.html#cfn-quicksight-dataset-pivotconfiguration-pivotedlabels

PivotOperationProperty

class CfnDataSet.PivotOperationProperty(*, alias, pivot_configuration, source, value_column_configuration, group_by_column_names=None)

Bases: object

A transform operation that pivots data by converting row values into columns.

Parameters:

alias (str) – Alias for this operation.
pivot_configuration (Union[IResolvable, PivotConfigurationProperty, Dict[str, Any]]) – Configuration that specifies which labels to pivot and how to structure the resulting columns.
source (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any]]) – The source transform operation that provides input data for pivoting.
value_column_configuration (Union[IResolvable, ValueColumnConfigurationProperty, Dict[str, Any]]) – Configuration for how to aggregate values when multiple rows map to the same pivoted column.
group_by_column_names (Optional[Sequence[str]]) – The list of column names to group by when performing the pivot operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

pivot_operation_property = quicksight.CfnDataSet.PivotOperationProperty(
    alias="alias",
    pivot_configuration=quicksight.CfnDataSet.PivotConfigurationProperty(
        pivoted_labels=[quicksight.CfnDataSet.PivotedLabelProperty(
            label_name="labelName",
            new_column_id="newColumnId",
            new_column_name="newColumnName"
        )],

        # the properties below are optional
        label_column_name="labelColumnName"
    ),
    source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    ),
    value_column_configuration=quicksight.CfnDataSet.ValueColumnConfigurationProperty(
        aggregation_function=quicksight.CfnDataSet.DataPrepAggregationFunctionProperty(
            list_aggregation=quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
                distinct=False,
                separator="separator",

                # the properties below are optional
                input_column_name="inputColumnName"
            ),
            percentile_aggregation=quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
                percentile_value=123,

                # the properties below are optional
                input_column_name="inputColumnName"
            ),
            simple_aggregation=quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
                function_type="functionType",

                # the properties below are optional
                input_column_name="inputColumnName"
            )
        )
    ),

    # the properties below are optional
    group_by_column_names=["groupByColumnNames"]
)

Attributes

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html#cfn-quicksight-dataset-pivotoperation-alias

group_by_column_names

The list of column names to group by when performing the pivot operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html#cfn-quicksight-dataset-pivotoperation-groupbycolumnnames

pivot_configuration

Configuration that specifies which labels to pivot and how to structure the resulting columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html#cfn-quicksight-dataset-pivotoperation-pivotconfiguration

source

The source transform operation that provides input data for pivoting.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html#cfn-quicksight-dataset-pivotoperation-source

value_column_configuration

Configuration for how to aggregate values when multiple rows map to the same pivoted column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotoperation.html#cfn-quicksight-dataset-pivotoperation-valuecolumnconfiguration

PivotedLabelProperty

class CfnDataSet.PivotedLabelProperty(*, label_name, new_column_id, new_column_name)

Bases: object

Specifies a label value to be pivoted into a separate column, including the new column name and identifier.

Parameters:

label_name (str) – The label value from the source data to be pivoted.
new_column_id (str) – A unique identifier for the new column created from this pivoted label.
new_column_name (str) – The name for the new column created from this pivoted label.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotedlabel.html

ExampleMetadata:

fixture=_generated

Example:

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

pivoted_label_property = quicksight.CfnDataSet.PivotedLabelProperty(
    label_name="labelName",
    new_column_id="newColumnId",
    new_column_name="newColumnName"
)

Attributes

label_name

The label value from the source data to be pivoted.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotedlabel.html#cfn-quicksight-dataset-pivotedlabel-labelname

new_column_id

A unique identifier for the new column created from this pivoted label.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotedlabel.html#cfn-quicksight-dataset-pivotedlabel-newcolumnid

new_column_name

The name for the new column created from this pivoted label.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-pivotedlabel.html#cfn-quicksight-dataset-pivotedlabel-newcolumnname

ProjectOperationProperty

class CfnDataSet.ProjectOperationProperty(*, alias=None, projected_columns=None, source=None)

Bases: object

A transform operation that projects columns.

Operations that come after a projection can only refer to projected columns.

Parameters:

alias (Optional[str]) – Alias for this operation.
projected_columns (Optional[Sequence[str]]) – Projected columns.
source (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any], None]) – The source transform operation that provides input data for column projection.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-projectoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

project_operation_property = quicksight.CfnDataSet.ProjectOperationProperty(
    alias="alias",
    projected_columns=["projectedColumns"],
    source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    )
)

Attributes

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-projectoperation.html#cfn-quicksight-dataset-projectoperation-alias

projected_columns

Projected columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-projectoperation.html#cfn-quicksight-dataset-projectoperation-projectedcolumns

source

The source transform operation that provides input data for column projection.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-projectoperation.html#cfn-quicksight-dataset-projectoperation-source

RefreshConfigurationProperty

class CfnDataSet.RefreshConfigurationProperty(*, incremental_refresh)

Bases: object

The refresh configuration of a dataset.

Parameters:: incremental_refresh (Union[IResolvable, IncrementalRefreshProperty, Dict[str, Any]]) – The incremental refresh for the dataset.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

refresh_configuration_property = quicksight.CfnDataSet.RefreshConfigurationProperty(
    incremental_refresh=quicksight.CfnDataSet.IncrementalRefreshProperty(
        lookback_window=quicksight.CfnDataSet.LookbackWindowProperty(
            column_name="columnName",
            size=123,
            size_unit="sizeUnit"
        )
    )
)

Attributes

incremental_refresh

The incremental refresh for the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshconfiguration.html#cfn-quicksight-dataset-refreshconfiguration-incrementalrefresh

RefreshFailureConfigurationProperty

class CfnDataSet.RefreshFailureConfigurationProperty(*, email_alert=None)

Bases: object

The failure configuration of a dataset.

Parameters:: email_alert (Union[IResolvable, RefreshFailureEmailAlertProperty, Dict[str, Any], None]) – The email alert configuration for a dataset refresh failure.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailureconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

refresh_failure_configuration_property = quicksight.CfnDataSet.RefreshFailureConfigurationProperty(
    email_alert=quicksight.CfnDataSet.RefreshFailureEmailAlertProperty(
        alert_status="alertStatus"
    )
)

Attributes

email_alert

The email alert configuration for a dataset refresh failure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailureconfiguration.html#cfn-quicksight-dataset-refreshfailureconfiguration-emailalert

RefreshFailureEmailAlertProperty

class CfnDataSet.RefreshFailureEmailAlertProperty(*, alert_status=None)

Bases: object

The configuration settings for the email alerts that are sent when a dataset refresh fails.

Parameters:: alert_status (Optional[str]) – The status value that determines if email alerts are sent.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailureemailalert.html
ExampleMetadata:: fixture=_generated

Example:

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

refresh_failure_email_alert_property = quicksight.CfnDataSet.RefreshFailureEmailAlertProperty(
    alert_status="alertStatus"
)

Attributes

alert_status

The status value that determines if email alerts are sent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailureemailalert.html#cfn-quicksight-dataset-refreshfailureemailalert-alertstatus

RelationalTableProperty

class CfnDataSet.RelationalTableProperty(*, data_source_arn, input_columns, name, catalog=None, schema=None)

Bases: object

A physical table type for relational data sources.

Parameters:

data_source_arn (str) – The Amazon Resource Name (ARN) for the data source.
input_columns (Union[IResolvable, Sequence[Union[IResolvable, InputColumnProperty, Dict[str, Any]]]]) – The column schema of the table.
name (str) – The name of the relational table.
catalog (Optional[str]) – The catalog associated with a table.
schema (Optional[str]) – The schema name. This name applies to certain relational database engines.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html

ExampleMetadata:

fixture=_generated

Example:

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

relational_table_property = quicksight.CfnDataSet.RelationalTableProperty(
    data_source_arn="dataSourceArn",
    input_columns=[quicksight.CfnDataSet.InputColumnProperty(
        name="name",
        type="type",

        # the properties below are optional
        id="id",
        sub_type="subType"
    )],
    name="name",

    # the properties below are optional
    catalog="catalog",
    schema="schema"
)

Attributes

catalog

The catalog associated with a table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html#cfn-quicksight-dataset-relationaltable-catalog

data_source_arn

The Amazon Resource Name (ARN) for the data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html#cfn-quicksight-dataset-relationaltable-datasourcearn

input_columns

The column schema of the table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html#cfn-quicksight-dataset-relationaltable-inputcolumns

name

The name of the relational table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html#cfn-quicksight-dataset-relationaltable-name

schema

The schema name.

This name applies to certain relational database engines.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-relationaltable.html#cfn-quicksight-dataset-relationaltable-schema

RenameColumnOperationProperty

class CfnDataSet.RenameColumnOperationProperty(*, column_name, new_column_name)

Bases: object

A transform operation that renames a column.

Parameters:

column_name (str) – The name of the column to be renamed.
new_column_name (str) – The new name for the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

rename_column_operation_property = quicksight.CfnDataSet.RenameColumnOperationProperty(
    column_name="columnName",
    new_column_name="newColumnName"
)

Attributes

column_name

The name of the column to be renamed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnoperation.html#cfn-quicksight-dataset-renamecolumnoperation-columnname

new_column_name

The new name for the column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnoperation.html#cfn-quicksight-dataset-renamecolumnoperation-newcolumnname

RenameColumnsOperationProperty

class CfnDataSet.RenameColumnsOperationProperty(*, alias, rename_column_operations, source)

Bases: object

A transform operation that renames one or more columns in the dataset.

Parameters:

alias (str) – Alias for this operation.
rename_column_operations (Union[IResolvable, Sequence[Union[IResolvable, RenameColumnOperationProperty, Dict[str, Any]]]]) – The list of column rename operations to perform, specifying old and new column names.
source (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any]]) – The source transform operation that provides input data for column renaming.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnsoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

rename_columns_operation_property = quicksight.CfnDataSet.RenameColumnsOperationProperty(
    alias="alias",
    rename_column_operations=[quicksight.CfnDataSet.RenameColumnOperationProperty(
        column_name="columnName",
        new_column_name="newColumnName"
    )],
    source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    )
)

Attributes

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnsoperation.html#cfn-quicksight-dataset-renamecolumnsoperation-alias

rename_column_operations

The list of column rename operations to perform, specifying old and new column names.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnsoperation.html#cfn-quicksight-dataset-renamecolumnsoperation-renamecolumnoperations

source

The source transform operation that provides input data for column renaming.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-renamecolumnsoperation.html#cfn-quicksight-dataset-renamecolumnsoperation-source

ResourcePermissionProperty

class CfnDataSet.ResourcePermissionProperty(*, actions, principal)

Bases: object

Permission for the resource.

Parameters:

actions (Sequence[str]) – The IAM action to grant or revoke permisions on.
principal (str) – The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

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

Attributes

actions

The IAM action to grant or revoke permisions on.

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

principal

.

The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-resourcepermission.html#cfn-quicksight-dataset-resourcepermission-principal
Type:: The Amazon Resource Name (ARN) of the principal. This can be one of the following

RowLevelPermissionConfigurationProperty

class CfnDataSet.RowLevelPermissionConfigurationProperty(*, row_level_permission_data_set=None, tag_configuration=None)

Bases: object

Configuration for row level security.

Parameters:

row_level_permission_data_set (Union[IResolvable, RowLevelPermissionDataSetProperty, Dict[str, Any], None]) – The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide. The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
tag_configuration (Union[IResolvable, RowLevelPermissionTagConfigurationProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissionconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

# tag_rule_configurations: Any

row_level_permission_configuration_property = quicksight.CfnDataSet.RowLevelPermissionConfigurationProperty(
    row_level_permission_data_set=quicksight.CfnDataSet.RowLevelPermissionDataSetProperty(
        arn="arn",
        permission_policy="permissionPolicy",

        # the properties below are optional
        format_version="formatVersion",
        namespace="namespace",
        status="status"
    ),
    tag_configuration=quicksight.CfnDataSet.RowLevelPermissionTagConfigurationProperty(
        tag_rules=[quicksight.CfnDataSet.RowLevelPermissionTagRuleProperty(
            column_name="columnName",
            tag_key="tagKey",

            # the properties below are optional
            match_all_value="matchAllValue",
            tag_multi_value_delimiter="tagMultiValueDelimiter"
        )],

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

Attributes

row_level_permission_data_set

The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissionconfiguration.html#cfn-quicksight-dataset-rowlevelpermissionconfiguration-rowlevelpermissiondataset

tag_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissionconfiguration.html#cfn-quicksight-dataset-rowlevelpermissionconfiguration-tagconfiguration

Type:: see

RowLevelPermissionDataSetProperty

class CfnDataSet.RowLevelPermissionDataSetProperty(*, arn, permission_policy, format_version=None, namespace=None, status=None)

Bases: object

Information about a dataset that contains permissions for row-level security (RLS).

The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Quick Sight User Guide .

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.

Parameters:

arn (str) – The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
permission_policy (str) – The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
format_version (Optional[str]) – The user or group rules associated with the dataset that contains permissions for RLS. By default, FormatVersion is VERSION_1 . When FormatVersion is VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2 , UserARN and GroupARN are required, and Namespace must not exist.
namespace (Optional[str]) – The namespace associated with the dataset that contains permissions for RLS.
status (Optional[str]) – The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html

ExampleMetadata:

fixture=_generated

Example:

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

row_level_permission_data_set_property = quicksight.CfnDataSet.RowLevelPermissionDataSetProperty(
    arn="arn",
    permission_policy="permissionPolicy",

    # the properties below are optional
    format_version="formatVersion",
    namespace="namespace",
    status="status"
)

Attributes

arn

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-arn

format_version

The user or group rules associated with the dataset that contains permissions for RLS.

By default, FormatVersion is VERSION_1 . When FormatVersion is VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2 , UserARN and GroupARN are required, and Namespace must not exist.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-formatversion

namespace

The namespace associated with the dataset that contains permissions for RLS.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-namespace

permission_policy

The type of permissions to use when interpreting the permissions for RLS.

DENY_ACCESS is included for backward compatibility only.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-permissionpolicy

status

The status of the row-level security permission dataset.

If enabled, the status is ENABLED . If disabled, the status is DISABLED .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset-status

RowLevelPermissionTagConfigurationProperty

class CfnDataSet.RowLevelPermissionTagConfigurationProperty(*, tag_rules, status=None, tag_rule_configurations=None)

Bases: object

The element you can use to define tags for row-level security.

Parameters:

tag_rules (Union[IResolvable, Sequence[Union[IResolvable, RowLevelPermissionTagRuleProperty, Dict[str, Any]]]]) – A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
status (Optional[str]) – The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
tag_rule_configurations (Any) – The configuration of tags on a dataset to set row-level security.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

# tag_rule_configurations: Any

row_level_permission_tag_configuration_property = quicksight.CfnDataSet.RowLevelPermissionTagConfigurationProperty(
    tag_rules=[quicksight.CfnDataSet.RowLevelPermissionTagRuleProperty(
        column_name="columnName",
        tag_key="tagKey",

        # the properties below are optional
        match_all_value="matchAllValue",
        tag_multi_value_delimiter="tagMultiValueDelimiter"
    )],

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

Attributes

status

The status of row-level security tags.

If enabled, the status is ENABLED . If disabled, the status is DISABLED .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.html#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-status

tag_rule_configurations

The configuration of tags on a dataset to set row-level security.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.html#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-tagruleconfigurations

tag_rules

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.html#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-tagrules

RowLevelPermissionTagRuleProperty

class CfnDataSet.RowLevelPermissionTagRuleProperty(*, column_name, tag_key, match_all_value=None, tag_multi_value_delimiter=None)

Bases: object

A set of rules associated with a tag.

Parameters:

column_name (str) – The column name that a tag key is assigned to.
tag_key (str) – The unique key for a tag.
match_all_value (Optional[str]) – A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
tag_multi_value_delimiter (Optional[str]) – A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html

ExampleMetadata:

fixture=_generated

Example:

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

row_level_permission_tag_rule_property = quicksight.CfnDataSet.RowLevelPermissionTagRuleProperty(
    column_name="columnName",
    tag_key="tagKey",

    # the properties below are optional
    match_all_value="matchAllValue",
    tag_multi_value_delimiter="tagMultiValueDelimiter"
)

Attributes

column_name

The column name that a tag key is assigned to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html#cfn-quicksight-dataset-rowlevelpermissiontagrule-columnname

match_all_value

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one.

For example, you can use an asterisk as your match all value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html#cfn-quicksight-dataset-rowlevelpermissiontagrule-matchallvalue

tag_key

The unique key for a tag.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html#cfn-quicksight-dataset-rowlevelpermissiontagrule-tagkey

tag_multi_value_delimiter

A string that you want to use to delimit the values when you pass the values at run time.

For example, you can delimit the values with a comma.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html#cfn-quicksight-dataset-rowlevelpermissiontagrule-tagmultivaluedelimiter

S3SourceProperty

class CfnDataSet.S3SourceProperty(*, data_source_arn, input_columns, upload_settings=None)

Bases: object

A physical table type for an S3 data source.

Parameters:

data_source_arn (str) – The Amazon Resource Name (ARN) for the data source.
input_columns (Union[IResolvable, Sequence[Union[IResolvable, InputColumnProperty, Dict[str, Any]]]]) – A physical table type for an S3 data source. .. epigraph:: For files that aren’t JSON, only STRING data types are supported in input columns.
upload_settings (Union[IResolvable, UploadSettingsProperty, Dict[str, Any], None]) – Information about the format for the S3 source file or files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html

ExampleMetadata:

fixture=_generated

Example:

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

s3_source_property = quicksight.CfnDataSet.S3SourceProperty(
    data_source_arn="dataSourceArn",
    input_columns=[quicksight.CfnDataSet.InputColumnProperty(
        name="name",
        type="type",

        # the properties below are optional
        id="id",
        sub_type="subType"
    )],

    # the properties below are optional
    upload_settings=quicksight.CfnDataSet.UploadSettingsProperty(
        contains_header=False,
        delimiter="delimiter",
        format="format",
        start_from_row=123,
        text_qualifier="textQualifier"
    )
)

Attributes

data_source_arn

The Amazon Resource Name (ARN) for the data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html#cfn-quicksight-dataset-s3source-datasourcearn

input_columns

A physical table type for an S3 data source.

For files that aren’t JSON, only STRING data types are supported in input columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html#cfn-quicksight-dataset-s3source-inputcolumns

upload_settings

Information about the format for the S3 source file or files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html#cfn-quicksight-dataset-s3source-uploadsettings

SaaSTableProperty

class CfnDataSet.SaaSTableProperty(*, data_source_arn, input_columns, table_path)

Bases: object

A table from a Software-as-a-Service (SaaS) data source, including connection details and column definitions.

Parameters:

data_source_arn (str) – The Amazon Resource Name (ARN) of the SaaS data source.
input_columns (Union[IResolvable, Sequence[Union[IResolvable, InputColumnProperty, Dict[str, Any]]]]) – The list of input columns available from the SaaS table.
table_path (Union[IResolvable, Sequence[Union[IResolvable, TablePathElementProperty, Dict[str, Any]]]]) – The hierarchical path to the table within the SaaS data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-saastable.html

ExampleMetadata:

fixture=_generated

Example:

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

saa_sTable_property = quicksight.CfnDataSet.SaaSTableProperty(
    data_source_arn="dataSourceArn",
    input_columns=[quicksight.CfnDataSet.InputColumnProperty(
        name="name",
        type="type",

        # the properties below are optional
        id="id",
        sub_type="subType"
    )],
    table_path=[quicksight.CfnDataSet.TablePathElementProperty(
        id="id",
        name="name"
    )]
)

Attributes

data_source_arn

The Amazon Resource Name (ARN) of the SaaS data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-saastable.html#cfn-quicksight-dataset-saastable-datasourcearn

input_columns

The list of input columns available from the SaaS table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-saastable.html#cfn-quicksight-dataset-saastable-inputcolumns

table_path

The hierarchical path to the table within the SaaS data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-saastable.html#cfn-quicksight-dataset-saastable-tablepath

SemanticModelConfigurationProperty

class CfnDataSet.SemanticModelConfigurationProperty(*, table_map=None)

Bases: object

Configuration for the semantic model that defines how prepared data is structured for analysis and reporting.

Parameters:: table_map (Union[IResolvable, Mapping[str, Union[IResolvable, SemanticTableProperty, Dict[str, Any]]], None]) – A map of semantic tables that define the analytical structure.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semanticmodelconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

# tag_rule_configurations: Any

semantic_model_configuration_property = quicksight.CfnDataSet.SemanticModelConfigurationProperty(
    table_map={
        "table_map_key": quicksight.CfnDataSet.SemanticTableProperty(
            alias="alias",
            destination_table_id="destinationTableId",

            # the properties below are optional
            row_level_permission_configuration=quicksight.CfnDataSet.RowLevelPermissionConfigurationProperty(
                row_level_permission_data_set=quicksight.CfnDataSet.RowLevelPermissionDataSetProperty(
                    arn="arn",
                    permission_policy="permissionPolicy",

                    # the properties below are optional
                    format_version="formatVersion",
                    namespace="namespace",
                    status="status"
                ),
                tag_configuration=quicksight.CfnDataSet.RowLevelPermissionTagConfigurationProperty(
                    tag_rules=[quicksight.CfnDataSet.RowLevelPermissionTagRuleProperty(
                        column_name="columnName",
                        tag_key="tagKey",

                        # the properties below are optional
                        match_all_value="matchAllValue",
                        tag_multi_value_delimiter="tagMultiValueDelimiter"
                    )],

                    # the properties below are optional
                    status="status",
                    tag_rule_configurations=tag_rule_configurations
                )
            )
        )
    }
)

Attributes

table_map

A map of semantic tables that define the analytical structure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semanticmodelconfiguration.html#cfn-quicksight-dataset-semanticmodelconfiguration-tablemap

SemanticTableProperty

class CfnDataSet.SemanticTableProperty(*, alias, destination_table_id, row_level_permission_configuration=None)

Bases: object

A semantic table that represents the final analytical structure of the data.

Parameters:

alias (str) – Alias for the semantic table.
destination_table_id (str) – The identifier of the destination table from data preparation that provides data to this semantic table.
row_level_permission_configuration (Union[IResolvable, RowLevelPermissionConfigurationProperty, Dict[str, Any], None]) – Configuration for row level security that control data access for this semantic table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semantictable.html

ExampleMetadata:

fixture=_generated

Example:

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

# tag_rule_configurations: Any

semantic_table_property = quicksight.CfnDataSet.SemanticTableProperty(
    alias="alias",
    destination_table_id="destinationTableId",

    # the properties below are optional
    row_level_permission_configuration=quicksight.CfnDataSet.RowLevelPermissionConfigurationProperty(
        row_level_permission_data_set=quicksight.CfnDataSet.RowLevelPermissionDataSetProperty(
            arn="arn",
            permission_policy="permissionPolicy",

            # the properties below are optional
            format_version="formatVersion",
            namespace="namespace",
            status="status"
        ),
        tag_configuration=quicksight.CfnDataSet.RowLevelPermissionTagConfigurationProperty(
            tag_rules=[quicksight.CfnDataSet.RowLevelPermissionTagRuleProperty(
                column_name="columnName",
                tag_key="tagKey",

                # the properties below are optional
                match_all_value="matchAllValue",
                tag_multi_value_delimiter="tagMultiValueDelimiter"
            )],

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

Attributes

alias

Alias for the semantic table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semantictable.html#cfn-quicksight-dataset-semantictable-alias

destination_table_id

The identifier of the destination table from data preparation that provides data to this semantic table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semantictable.html#cfn-quicksight-dataset-semantictable-destinationtableid

row_level_permission_configuration

Configuration for row level security that control data access for this semantic table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semantictable.html#cfn-quicksight-dataset-semantictable-rowlevelpermissionconfiguration

SourceTableProperty

class CfnDataSet.SourceTableProperty(*, data_set=None, physical_table_id=None)

Bases: object

A source table that provides initial data from either a physical table or parent dataset.

Parameters:

data_set (Union[IResolvable, ParentDataSetProperty, Dict[str, Any], None]) – A parent dataset that serves as the data source instead of a physical table.
physical_table_id (Optional[str]) – The identifier of the physical table that serves as the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-sourcetable.html

ExampleMetadata:

fixture=_generated

Example:

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

source_table_property = quicksight.CfnDataSet.SourceTableProperty(
    data_set=quicksight.CfnDataSet.ParentDataSetProperty(
        data_set_arn="dataSetArn",
        input_columns=[quicksight.CfnDataSet.InputColumnProperty(
            name="name",
            type="type",

            # the properties below are optional
            id="id",
            sub_type="subType"
        )]
    ),
    physical_table_id="physicalTableId"
)

Attributes

data_set

A parent dataset that serves as the data source instead of a physical table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-sourcetable.html#cfn-quicksight-dataset-sourcetable-dataset

physical_table_id

The identifier of the physical table that serves as the data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-sourcetable.html#cfn-quicksight-dataset-sourcetable-physicaltableid

StringDatasetParameterDefaultValuesProperty

class CfnDataSet.StringDatasetParameterDefaultValuesProperty(*, static_values=None)

Bases: object

A list of default values for a given string dataset parameter type.

This structure only accepts static values.

Parameters:: static_values (Optional[Sequence[str]]) – A list of static default values for a given string parameter.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameterdefaultvalues.html
ExampleMetadata:: fixture=_generated

Example:

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

string_dataset_parameter_default_values_property = quicksight.CfnDataSet.StringDatasetParameterDefaultValuesProperty(
    static_values=["staticValues"]
)

Attributes

static_values

A list of static default values for a given string parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameterdefaultvalues.html#cfn-quicksight-dataset-stringdatasetparameterdefaultvalues-staticvalues

StringDatasetParameterProperty

class CfnDataSet.StringDatasetParameterProperty(*, id, name, value_type, default_values=None)

Bases: object

A string parameter that is created in the dataset.

Parameters:

id (str) – An identifier for the string parameter that is created in the dataset.
name (str) – The name of the string parameter that is created in the dataset.
value_type (str) – The value type of the dataset parameter. Valid values are single value or multi value .
default_values (Union[IResolvable, StringDatasetParameterDefaultValuesProperty, Dict[str, Any], None]) – A list of default values for a given string dataset parameter type. This structure only accepts static values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html

ExampleMetadata:

fixture=_generated

Example:

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

string_dataset_parameter_property = quicksight.CfnDataSet.StringDatasetParameterProperty(
    id="id",
    name="name",
    value_type="valueType",

    # the properties below are optional
    default_values=quicksight.CfnDataSet.StringDatasetParameterDefaultValuesProperty(
        static_values=["staticValues"]
    )
)

Attributes

default_values

A list of default values for a given string dataset parameter type.

This structure only accepts static values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html#cfn-quicksight-dataset-stringdatasetparameter-defaultvalues

id

An identifier for the string parameter that is created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html#cfn-quicksight-dataset-stringdatasetparameter-id

name

The name of the string parameter that is created in the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html#cfn-quicksight-dataset-stringdatasetparameter-name

value_type

The value type of the dataset parameter.

Valid values are single value or multi value .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html#cfn-quicksight-dataset-stringdatasetparameter-valuetype

TablePathElementProperty

class CfnDataSet.TablePathElementProperty(*, id=None, name=None)

Bases: object

An element in the hierarchical path to a table within a data source, containing both name and identifier.

Parameters:

id (Optional[str]) – The unique identifier of the path element.
name (Optional[str]) – The name of the path element.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-tablepathelement.html

ExampleMetadata:

fixture=_generated

Example:

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

table_path_element_property = quicksight.CfnDataSet.TablePathElementProperty(
    id="id",
    name="name"
)

Attributes

id

The unique identifier of the path element.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-tablepathelement.html#cfn-quicksight-dataset-tablepathelement-id

name

The name of the path element.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-tablepathelement.html#cfn-quicksight-dataset-tablepathelement-name

TagColumnOperationProperty

class CfnDataSet.TagColumnOperationProperty(*, column_name, tags)

Bases: object

A transform operation that tags a column with additional information.

Parameters:

column_name (str) – The column that this operation acts on.
tags (Sequence[Union[ColumnTagProperty, Dict[str, Any]]]) – The dataset column tag, currently only used for geospatial type tagging. .. epigraph:: This is not tags for the AWS tagging feature.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-tagcolumnoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

tag_column_operation_property = quicksight.CfnDataSet.TagColumnOperationProperty(
    column_name="columnName",
    tags=[quicksight.CfnDataSet.ColumnTagProperty(
        column_description=quicksight.CfnDataSet.ColumnDescriptionProperty(
            text="text"
        ),
        column_geographic_role="columnGeographicRole"
    )]
)

Attributes

column_name

The column that this operation acts on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-tagcolumnoperation.html#cfn-quicksight-dataset-tagcolumnoperation-columnname

tags

The dataset column tag, currently only used for geospatial type tagging.

This is not tags for the AWS tagging feature.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-tagcolumnoperation.html#cfn-quicksight-dataset-tagcolumnoperation-tags

TransformOperationProperty

class CfnDataSet.TransformOperationProperty(*, cast_column_type_operation=None, create_columns_operation=None, filter_operation=None, override_dataset_parameter_operation=None, project_operation=None, rename_column_operation=None, tag_column_operation=None, untag_column_operation=None)

Bases: object

A data transformation on a logical table.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Parameters:

cast_column_type_operation (Union[IResolvable, CastColumnTypeOperationProperty, Dict[str, Any], None]) – A transform operation that casts a column to a different type.
create_columns_operation (Union[IResolvable, CreateColumnsOperationProperty, Dict[str, Any], None]) – An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
filter_operation (Union[IResolvable, FilterOperationProperty, Dict[str, Any], None]) – An operation that filters rows based on some condition.
override_dataset_parameter_operation (Union[IResolvable, OverrideDatasetParameterOperationProperty, Dict[str, Any], None]) – A transform operation that overrides the dataset parameter values that are defined in another dataset.
project_operation (Union[IResolvable, ProjectOperationProperty, Dict[str, Any], None]) – An operation that projects columns. Operations that come after a projection can only refer to projected columns.
rename_column_operation (Union[IResolvable, RenameColumnOperationProperty, Dict[str, Any], None]) – An operation that renames a column.
tag_column_operation (Union[IResolvable, TagColumnOperationProperty, Dict[str, Any], None]) – An operation that tags a column with additional information.
untag_column_operation (Union[IResolvable, UntagColumnOperationProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

transform_operation_property = quicksight.CfnDataSet.TransformOperationProperty(
    cast_column_type_operation=quicksight.CfnDataSet.CastColumnTypeOperationProperty(
        column_name="columnName",
        new_column_type="newColumnType",

        # the properties below are optional
        format="format",
        sub_type="subType"
    ),
    create_columns_operation=quicksight.CfnDataSet.CreateColumnsOperationProperty(
        columns=[quicksight.CfnDataSet.CalculatedColumnProperty(
            column_id="columnId",
            column_name="columnName",
            expression="expression"
        )],

        # the properties below are optional
        alias="alias",
        source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        )
    ),
    filter_operation=quicksight.CfnDataSet.FilterOperationProperty(
        condition_expression="conditionExpression",
        date_filter_condition=quicksight.CfnDataSet.DataSetDateFilterConditionProperty(
            column_name="columnName",
            comparison_filter_condition=quicksight.CfnDataSet.DataSetDateComparisonFilterConditionProperty(
                operator="operator",

                # the properties below are optional
                value=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                    static_value="staticValue"
                )
            ),
            range_filter_condition=quicksight.CfnDataSet.DataSetDateRangeFilterConditionProperty(
                include_maximum=False,
                include_minimum=False,
                range_maximum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                    static_value="staticValue"
                ),
                range_minimum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                    static_value="staticValue"
                )
            )
        ),
        numeric_filter_condition=quicksight.CfnDataSet.DataSetNumericFilterConditionProperty(
            column_name="columnName",
            comparison_filter_condition=quicksight.CfnDataSet.DataSetNumericComparisonFilterConditionProperty(
                operator="operator",

                # the properties below are optional
                value=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                    static_value=123
                )
            ),
            range_filter_condition=quicksight.CfnDataSet.DataSetNumericRangeFilterConditionProperty(
                include_maximum=False,
                include_minimum=False,
                range_maximum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                    static_value=123
                ),
                range_minimum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                    static_value=123
                )
            )
        ),
        string_filter_condition=quicksight.CfnDataSet.DataSetStringFilterConditionProperty(
            column_name="columnName",
            comparison_filter_condition=quicksight.CfnDataSet.DataSetStringComparisonFilterConditionProperty(
                operator="operator",

                # the properties below are optional
                value=quicksight.CfnDataSet.DataSetStringFilterValueProperty(
                    static_value="staticValue"
                )
            ),
            list_filter_condition=quicksight.CfnDataSet.DataSetStringListFilterConditionProperty(
                operator="operator",

                # the properties below are optional
                values=quicksight.CfnDataSet.DataSetStringListFilterValueProperty(
                    static_values=["staticValues"]
                )
            )
        )
    ),
    override_dataset_parameter_operation=quicksight.CfnDataSet.OverrideDatasetParameterOperationProperty(
        parameter_name="parameterName",

        # the properties below are optional
        new_default_values=quicksight.CfnDataSet.NewDefaultValuesProperty(
            date_time_static_values=["dateTimeStaticValues"],
            decimal_static_values=[123],
            integer_static_values=[123],
            string_static_values=["stringStaticValues"]
        ),
        new_parameter_name="newParameterName"
    ),
    project_operation=quicksight.CfnDataSet.ProjectOperationProperty(
        alias="alias",
        projected_columns=["projectedColumns"],
        source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        )
    ),
    rename_column_operation=quicksight.CfnDataSet.RenameColumnOperationProperty(
        column_name="columnName",
        new_column_name="newColumnName"
    ),
    tag_column_operation=quicksight.CfnDataSet.TagColumnOperationProperty(
        column_name="columnName",
        tags=[quicksight.CfnDataSet.ColumnTagProperty(
            column_description=quicksight.CfnDataSet.ColumnDescriptionProperty(
                text="text"
            ),
            column_geographic_role="columnGeographicRole"
        )]
    ),
    untag_column_operation=quicksight.CfnDataSet.UntagColumnOperationProperty(
        column_name="columnName",
        tag_names=["tagNames"]
    )
)

Attributes

cast_column_type_operation

A transform operation that casts a column to a different type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html#cfn-quicksight-dataset-transformoperation-castcolumntypeoperation

create_columns_operation

An operation that creates calculated columns.

Columns created in one such operation form a lexical closure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html#cfn-quicksight-dataset-transformoperation-createcolumnsoperation

filter_operation

An operation that filters rows based on some condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html#cfn-quicksight-dataset-transformoperation-filteroperation

override_dataset_parameter_operation

A transform operation that overrides the dataset parameter values that are defined in another dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html#cfn-quicksight-dataset-transformoperation-overridedatasetparameteroperation

project_operation

An operation that projects columns.

Operations that come after a projection can only refer to projected columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html#cfn-quicksight-dataset-transformoperation-projectoperation

rename_column_operation

An operation that renames a column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html#cfn-quicksight-dataset-transformoperation-renamecolumnoperation

tag_column_operation

An operation that tags a column with additional information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html#cfn-quicksight-dataset-transformoperation-tagcolumnoperation

untag_column_operation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html#cfn-quicksight-dataset-transformoperation-untagcolumnoperation

Type:: see

TransformOperationSourceProperty

class CfnDataSet.TransformOperationSourceProperty(*, transform_operation_id, column_id_mappings=None)

Bases: object

Specifies the source of data for a transform operation, including the source operation and column mappings.

Parameters:

transform_operation_id (str) – The identifier of the transform operation that provides input data.
column_id_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSetColumnIdMappingProperty, Dict[str, Any]]], None]) – The mappings between source column identifiers and target column identifiers for this transformation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperationsource.html

ExampleMetadata:

fixture=_generated

Example:

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

transform_operation_source_property = quicksight.CfnDataSet.TransformOperationSourceProperty(
    transform_operation_id="transformOperationId",

    # the properties below are optional
    column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
        source_column_id="sourceColumnId",
        target_column_id="targetColumnId"
    )]
)

Attributes

column_id_mappings

The mappings between source column identifiers and target column identifiers for this transformation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperationsource.html#cfn-quicksight-dataset-transformoperationsource-columnidmappings

transform_operation_id

The identifier of the transform operation that provides input data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperationsource.html#cfn-quicksight-dataset-transformoperationsource-transformoperationid

TransformStepProperty

class CfnDataSet.TransformStepProperty(*, aggregate_step=None, append_step=None, cast_column_types_step=None, create_columns_step=None, filters_step=None, import_table_step=None, join_step=None, pivot_step=None, project_step=None, rename_columns_step=None, unpivot_step=None)

Bases: object

A step in data preparation that performs a specific operation on the data.

Parameters:

aggregate_step (Union[IResolvable, AggregateOperationProperty, Dict[str, Any], None]) – A transform step that groups data and applies aggregation functions to calculate summary values.
append_step (Union[IResolvable, AppendOperationProperty, Dict[str, Any], None]) – A transform step that combines rows from multiple sources by stacking them vertically.
cast_column_types_step (Union[IResolvable, CastColumnTypesOperationProperty, Dict[str, Any], None]) – A transform step that changes the data types of one or more columns.
create_columns_step (Union[IResolvable, CreateColumnsOperationProperty, Dict[str, Any], None]) – Columns created in one such operation form a lexical closure.
filters_step (Union[IResolvable, FiltersOperationProperty, Dict[str, Any], None]) – A transform step that applies filter conditions.
import_table_step (Union[IResolvable, ImportTableOperationProperty, Dict[str, Any], None]) – A transform step that brings data from a source table.
join_step (Union[IResolvable, JoinOperationProperty, Dict[str, Any], None]) – A transform step that combines data from two sources based on specified join conditions.
pivot_step (Union[IResolvable, PivotOperationProperty, Dict[str, Any], None]) – A transform step that converts row values into columns to reshape the data structure.
project_step (Union[IResolvable, ProjectOperationProperty, Dict[str, Any], None]) – Operations that come after a projection can only refer to projected columns.
rename_columns_step (Union[IResolvable, RenameColumnsOperationProperty, Dict[str, Any], None]) – A transform step that changes the names of one or more columns.
unpivot_step (Union[IResolvable, UnpivotOperationProperty, Dict[str, Any], None]) – A transform step that converts columns into rows to normalize the data structure.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html

ExampleMetadata:

fixture=_generated

Example:

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

transform_step_property = quicksight.CfnDataSet.TransformStepProperty(
    aggregate_step=quicksight.CfnDataSet.AggregateOperationProperty(
        aggregations=[quicksight.CfnDataSet.AggregationProperty(
            aggregation_function=quicksight.CfnDataSet.DataPrepAggregationFunctionProperty(
                list_aggregation=quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
                    distinct=False,
                    separator="separator",

                    # the properties below are optional
                    input_column_name="inputColumnName"
                ),
                percentile_aggregation=quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
                    percentile_value=123,

                    # the properties below are optional
                    input_column_name="inputColumnName"
                ),
                simple_aggregation=quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
                    function_type="functionType",

                    # the properties below are optional
                    input_column_name="inputColumnName"
                )
            ),
            new_column_id="newColumnId",
            new_column_name="newColumnName"
        )],
        alias="alias",
        source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        ),

        # the properties below are optional
        group_by_column_names=["groupByColumnNames"]
    ),
    append_step=quicksight.CfnDataSet.AppendOperationProperty(
        alias="alias",
        appended_columns=[quicksight.CfnDataSet.AppendedColumnProperty(
            column_name="columnName",
            new_column_id="newColumnId"
        )],

        # the properties below are optional
        first_source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        ),
        second_source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        )
    ),
    cast_column_types_step=quicksight.CfnDataSet.CastColumnTypesOperationProperty(
        alias="alias",
        cast_column_type_operations=[quicksight.CfnDataSet.CastColumnTypeOperationProperty(
            column_name="columnName",
            new_column_type="newColumnType",

            # the properties below are optional
            format="format",
            sub_type="subType"
        )],
        source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        )
    ),
    create_columns_step=quicksight.CfnDataSet.CreateColumnsOperationProperty(
        columns=[quicksight.CfnDataSet.CalculatedColumnProperty(
            column_id="columnId",
            column_name="columnName",
            expression="expression"
        )],

        # the properties below are optional
        alias="alias",
        source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        )
    ),
    filters_step=quicksight.CfnDataSet.FiltersOperationProperty(
        alias="alias",
        filter_operations=[quicksight.CfnDataSet.FilterOperationProperty(
            condition_expression="conditionExpression",
            date_filter_condition=quicksight.CfnDataSet.DataSetDateFilterConditionProperty(
                column_name="columnName",
                comparison_filter_condition=quicksight.CfnDataSet.DataSetDateComparisonFilterConditionProperty(
                    operator="operator",

                    # the properties below are optional
                    value=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                        static_value="staticValue"
                    )
                ),
                range_filter_condition=quicksight.CfnDataSet.DataSetDateRangeFilterConditionProperty(
                    include_maximum=False,
                    include_minimum=False,
                    range_maximum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                        static_value="staticValue"
                    ),
                    range_minimum=quicksight.CfnDataSet.DataSetDateFilterValueProperty(
                        static_value="staticValue"
                    )
                )
            ),
            numeric_filter_condition=quicksight.CfnDataSet.DataSetNumericFilterConditionProperty(
                column_name="columnName",
                comparison_filter_condition=quicksight.CfnDataSet.DataSetNumericComparisonFilterConditionProperty(
                    operator="operator",

                    # the properties below are optional
                    value=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                        static_value=123
                    )
                ),
                range_filter_condition=quicksight.CfnDataSet.DataSetNumericRangeFilterConditionProperty(
                    include_maximum=False,
                    include_minimum=False,
                    range_maximum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                        static_value=123
                    ),
                    range_minimum=quicksight.CfnDataSet.DataSetNumericFilterValueProperty(
                        static_value=123
                    )
                )
            ),
            string_filter_condition=quicksight.CfnDataSet.DataSetStringFilterConditionProperty(
                column_name="columnName",
                comparison_filter_condition=quicksight.CfnDataSet.DataSetStringComparisonFilterConditionProperty(
                    operator="operator",

                    # the properties below are optional
                    value=quicksight.CfnDataSet.DataSetStringFilterValueProperty(
                        static_value="staticValue"
                    )
                ),
                list_filter_condition=quicksight.CfnDataSet.DataSetStringListFilterConditionProperty(
                    operator="operator",

                    # the properties below are optional
                    values=quicksight.CfnDataSet.DataSetStringListFilterValueProperty(
                        static_values=["staticValues"]
                    )
                )
            )
        )],
        source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        )
    ),
    import_table_step=quicksight.CfnDataSet.ImportTableOperationProperty(
        alias="alias",
        source=quicksight.CfnDataSet.ImportTableOperationSourceProperty(
            source_table_id="sourceTableId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        )
    ),
    join_step=quicksight.CfnDataSet.JoinOperationProperty(
        alias="alias",
        left_operand=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        ),
        on_clause="onClause",
        right_operand=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        ),
        type="type",

        # the properties below are optional
        left_operand_properties=quicksight.CfnDataSet.JoinOperandPropertiesProperty(
            output_column_name_overrides=[quicksight.CfnDataSet.OutputColumnNameOverrideProperty(
                output_column_name="outputColumnName",

                # the properties below are optional
                source_column_name="sourceColumnName"
            )]
        ),
        right_operand_properties=quicksight.CfnDataSet.JoinOperandPropertiesProperty(
            output_column_name_overrides=[quicksight.CfnDataSet.OutputColumnNameOverrideProperty(
                output_column_name="outputColumnName",

                # the properties below are optional
                source_column_name="sourceColumnName"
            )]
        )
    ),
    pivot_step=quicksight.CfnDataSet.PivotOperationProperty(
        alias="alias",
        pivot_configuration=quicksight.CfnDataSet.PivotConfigurationProperty(
            pivoted_labels=[quicksight.CfnDataSet.PivotedLabelProperty(
                label_name="labelName",
                new_column_id="newColumnId",
                new_column_name="newColumnName"
            )],

            # the properties below are optional
            label_column_name="labelColumnName"
        ),
        source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        ),
        value_column_configuration=quicksight.CfnDataSet.ValueColumnConfigurationProperty(
            aggregation_function=quicksight.CfnDataSet.DataPrepAggregationFunctionProperty(
                list_aggregation=quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
                    distinct=False,
                    separator="separator",

                    # the properties below are optional
                    input_column_name="inputColumnName"
                ),
                percentile_aggregation=quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
                    percentile_value=123,

                    # the properties below are optional
                    input_column_name="inputColumnName"
                ),
                simple_aggregation=quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
                    function_type="functionType",

                    # the properties below are optional
                    input_column_name="inputColumnName"
                )
            )
        ),

        # the properties below are optional
        group_by_column_names=["groupByColumnNames"]
    ),
    project_step=quicksight.CfnDataSet.ProjectOperationProperty(
        alias="alias",
        projected_columns=["projectedColumns"],
        source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        )
    ),
    rename_columns_step=quicksight.CfnDataSet.RenameColumnsOperationProperty(
        alias="alias",
        rename_column_operations=[quicksight.CfnDataSet.RenameColumnOperationProperty(
            column_name="columnName",
            new_column_name="newColumnName"
        )],
        source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        )
    ),
    unpivot_step=quicksight.CfnDataSet.UnpivotOperationProperty(
        alias="alias",
        columns_to_unpivot=[quicksight.CfnDataSet.ColumnToUnpivotProperty(
            column_name="columnName",
            new_value="newValue"
        )],
        source=quicksight.CfnDataSet.TransformOperationSourceProperty(
            transform_operation_id="transformOperationId",

            # the properties below are optional
            column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
                source_column_id="sourceColumnId",
                target_column_id="targetColumnId"
            )]
        ),
        unpivoted_label_column_id="unpivotedLabelColumnId",
        unpivoted_label_column_name="unpivotedLabelColumnName",
        unpivoted_value_column_id="unpivotedValueColumnId",
        unpivoted_value_column_name="unpivotedValueColumnName"
    )
)

Attributes

aggregate_step

A transform step that groups data and applies aggregation functions to calculate summary values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-aggregatestep

append_step

A transform step that combines rows from multiple sources by stacking them vertically.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-appendstep

cast_column_types_step

A transform step that changes the data types of one or more columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-castcolumntypesstep

create_columns_step

Columns created in one such operation form a lexical closure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-createcolumnsstep

filters_step

A transform step that applies filter conditions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-filtersstep

import_table_step

A transform step that brings data from a source table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-importtablestep

join_step

A transform step that combines data from two sources based on specified join conditions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-joinstep

pivot_step

A transform step that converts row values into columns to reshape the data structure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-pivotstep

project_step

Operations that come after a projection can only refer to projected columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-projectstep

rename_columns_step

A transform step that changes the names of one or more columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-renamecolumnsstep

unpivot_step

A transform step that converts columns into rows to normalize the data structure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-unpivotstep

UniqueKeyProperty

class CfnDataSet.UniqueKeyProperty(*, column_names)

Bases: object

Parameters:: column_names (Sequence[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uniquekey.html
ExampleMetadata:: fixture=_generated

Example:

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

unique_key_property = quicksight.CfnDataSet.UniqueKeyProperty(
    column_names=["columnNames"]
)

Attributes

column_names

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uniquekey.html#cfn-quicksight-dataset-uniquekey-columnnames

Type:: see

UnpivotOperationProperty

class CfnDataSet.UnpivotOperationProperty(*, alias, columns_to_unpivot, source, unpivoted_label_column_id, unpivoted_label_column_name, unpivoted_value_column_id, unpivoted_value_column_name)

Bases: object

A transform operation that converts columns into rows, normalizing the data structure.

Parameters:

alias (str) – Alias for this operation.
columns_to_unpivot (Union[IResolvable, Sequence[Union[IResolvable, ColumnToUnpivotProperty, Dict[str, Any]]]]) – The list of columns to unpivot from the source data.
source (Union[IResolvable, TransformOperationSourceProperty, Dict[str, Any]]) – The source transform operation that provides input data for unpivoting.
unpivoted_label_column_id (str) – A unique identifier for the new column that will contain the unpivoted column names.
unpivoted_label_column_name (str) – The name for the new column that will contain the unpivoted column names.
unpivoted_value_column_id (str) – A unique identifier for the new column that will contain the unpivoted values.
unpivoted_value_column_name (str) – The name for the new column that will contain the unpivoted values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

unpivot_operation_property = quicksight.CfnDataSet.UnpivotOperationProperty(
    alias="alias",
    columns_to_unpivot=[quicksight.CfnDataSet.ColumnToUnpivotProperty(
        column_name="columnName",
        new_value="newValue"
    )],
    source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    ),
    unpivoted_label_column_id="unpivotedLabelColumnId",
    unpivoted_label_column_name="unpivotedLabelColumnName",
    unpivoted_value_column_id="unpivotedValueColumnId",
    unpivoted_value_column_name="unpivotedValueColumnName"
)

Attributes

alias

Alias for this operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-alias

columns_to_unpivot

The list of columns to unpivot from the source data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-columnstounpivot

source

The source transform operation that provides input data for unpivoting.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-source

unpivoted_label_column_id

A unique identifier for the new column that will contain the unpivoted column names.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-unpivotedlabelcolumnid

unpivoted_label_column_name

The name for the new column that will contain the unpivoted column names.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-unpivotedlabelcolumnname

unpivoted_value_column_id

A unique identifier for the new column that will contain the unpivoted values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-unpivotedvaluecolumnid

unpivoted_value_column_name

The name for the new column that will contain the unpivoted values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-unpivotoperation.html#cfn-quicksight-dataset-unpivotoperation-unpivotedvaluecolumnname

UntagColumnOperationProperty

class CfnDataSet.UntagColumnOperationProperty(*, column_name, tag_names)

Bases: object

A transform operation that removes tags associated with a column.

Parameters:

column_name (str) – The column that this operation acts on.
tag_names (Sequence[str]) – The column tags to remove from this column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-untagcolumnoperation.html

ExampleMetadata:

fixture=_generated

Example:

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

untag_column_operation_property = quicksight.CfnDataSet.UntagColumnOperationProperty(
    column_name="columnName",
    tag_names=["tagNames"]
)

Attributes

column_name

The column that this operation acts on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-untagcolumnoperation.html#cfn-quicksight-dataset-untagcolumnoperation-columnname

tag_names

The column tags to remove from this column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-untagcolumnoperation.html#cfn-quicksight-dataset-untagcolumnoperation-tagnames

UploadSettingsProperty

class CfnDataSet.UploadSettingsProperty(*, contains_header=None, delimiter=None, format=None, start_from_row=None, text_qualifier=None)

Bases: object

Information about the format for a source file or files.

Parameters:

contains_header (Union[bool, IResolvable, None]) – Whether the file has a header row, or the files each have a header row.
delimiter (Optional[str]) – The delimiter between values in the file.
format (Optional[str]) – File format.
start_from_row (Union[int, float, None]) – A row number to start reading data from.
text_qualifier (Optional[str]) – Text qualifier.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html

ExampleMetadata:

fixture=_generated

Example:

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

upload_settings_property = quicksight.CfnDataSet.UploadSettingsProperty(
    contains_header=False,
    delimiter="delimiter",
    format="format",
    start_from_row=123,
    text_qualifier="textQualifier"
)

Attributes

contains_header

Whether the file has a header row, or the files each have a header row.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html#cfn-quicksight-dataset-uploadsettings-containsheader

delimiter

The delimiter between values in the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html#cfn-quicksight-dataset-uploadsettings-delimiter

format

File format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html#cfn-quicksight-dataset-uploadsettings-format

start_from_row

A row number to start reading data from.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html#cfn-quicksight-dataset-uploadsettings-startfromrow

text_qualifier

Text qualifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html#cfn-quicksight-dataset-uploadsettings-textqualifier

ValueColumnConfigurationProperty

class CfnDataSet.ValueColumnConfigurationProperty(*, aggregation_function=None)

Bases: object

Configuration for how to handle value columns in pivot operations, including aggregation settings.

Parameters:: aggregation_function (Union[IResolvable, DataPrepAggregationFunctionProperty, Dict[str, Any], None]) – The aggregation function to apply when multiple values map to the same pivoted cell.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-valuecolumnconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

value_column_configuration_property = quicksight.CfnDataSet.ValueColumnConfigurationProperty(
    aggregation_function=quicksight.CfnDataSet.DataPrepAggregationFunctionProperty(
        list_aggregation=quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
            distinct=False,
            separator="separator",

            # the properties below are optional
            input_column_name="inputColumnName"
        ),
        percentile_aggregation=quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
            percentile_value=123,

            # the properties below are optional
            input_column_name="inputColumnName"
        ),
        simple_aggregation=quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
            function_type="functionType",

            # the properties below are optional
            input_column_name="inputColumnName"
        )
    )
)

Attributes

aggregation_function

The aggregation function to apply when multiple values map to the same pivoted cell.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-valuecolumnconfiguration.html#cfn-quicksight-dataset-valuecolumnconfiguration-aggregationfunction