CfnDataSet

class aws_cdk.aws_quicksight.CfnDataSet(scope, id, *, aws_account_id=None, column_groups=None, column_level_permission_rules=None, data_set_id=None, data_set_usage_configuration=None, field_folders=None, import_mode=None, ingestion_wait_policy=None, logical_table_map=None, name=None, permissions=None, physical_table_map=None, row_level_permission_data_set=None, tags=None)

Bases: CfnResource

A CloudFormation AWS::QuickSight::DataSet.

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

CloudformationResource

AWS::QuickSight::DataSet

Link

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

ExampleMetadata

fixture=_generated

Example:

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

cfn_data_set = quicksight.CfnDataSet(self, "MyCfnDataSet",
    aws_account_id="awsAccountId",
    column_groups=[quicksight.CfnDataSet.ColumnGroupProperty(
        geo_spatial_column_group=quicksight.CfnDataSet.GeoSpatialColumnGroupProperty(
            columns=["columns"],
            name="name",

            # the properties below are optional
            country_code="countryCode"
        )
    )],
    column_level_permission_rules=[quicksight.CfnDataSet.ColumnLevelPermissionRuleProperty(
        column_names=["columnNames"],
        principals=["principals"]
    )],
    data_set_id="dataSetId",
    data_set_usage_configuration=quicksight.CfnDataSet.DataSetUsageConfigurationProperty(
        disable_use_as_direct_query_source=False,
        disable_use_as_imported_source=False
    ),
    field_folders={
        "field_folders_key": quicksight.CfnDataSet.FieldFolderProperty(
            columns=["columns"],
            description="description"
        )
    },
    import_mode="importMode",
    ingestion_wait_policy=quicksight.CfnDataSet.IngestionWaitPolicyProperty(
        ingestion_wait_time_in_hours=123,
        wait_for_spice_ingestion=False
    ),
    logical_table_map={
        "logical_table_map_key": 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"
                ),
                create_columns_operation=quicksight.CfnDataSet.CreateColumnsOperationProperty(
                    columns=[quicksight.CfnDataSet.CalculatedColumnProperty(
                        column_id="columnId",
                        column_name="columnName",
                        expression="expression"
                    )]
                ),
                filter_operation=quicksight.CfnDataSet.FilterOperationProperty(
                    condition_expression="conditionExpression"
                ),
                project_operation=quicksight.CfnDataSet.ProjectOperationProperty(
                    projected_columns=["projectedColumns"]
                ),
                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"
                    )]
                )
            )]
        )
    },
    name="name",
    permissions=[quicksight.CfnDataSet.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    physical_table_map={
        "physical_table_map_key": quicksight.CfnDataSet.PhysicalTableProperty(
            custom_sql=quicksight.CfnDataSet.CustomSqlProperty(
                columns=[quicksight.CfnDataSet.InputColumnProperty(
                    name="name",
                    type="type"
                )],
                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"
                )],
                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
                upload_settings=quicksight.CfnDataSet.UploadSettingsProperty(
                    contains_header=False,
                    delimiter="delimiter",
                    format="format",
                    start_from_row=123,
                    text_qualifier="textQualifier"
                )
            )
        )
    },
    row_level_permission_data_set=quicksight.CfnDataSet.RowLevelPermissionDataSetProperty(
        arn="arn",
        permission_policy="permissionPolicy",

        # the properties below are optional
        format_version="formatVersion",
        namespace="namespace"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::QuickSight::DataSet.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • aws_account_id (Optional[str]) – The AWS account ID.

  • column_groups (Union[IResolvable, Sequence[Union[ColumnGroupProperty, Dict[str, Any], IResolvable]], None]) – Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

  • column_level_permission_rules (Union[IResolvable, Sequence[Union[ColumnLevelPermissionRuleProperty, Dict[str, Any], IResolvable]], None]) – A set of one or more definitions of a ColumnLevelPermissionRule .

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

  • data_set_usage_configuration (Union[DataSetUsageConfigurationProperty, Dict[str, Any], IResolvable, None]) – AWS::QuickSight::DataSet.DataSetUsageConfiguration.

  • field_folders (Union[IResolvable, Mapping[str, Union[FieldFolderProperty, Dict[str, Any], IResolvable]], None]) – The folder that contains fields and nested subfolders for your dataset.

  • import_mode (Optional[str]) – Indicates whether you want to import the data into SPICE.

  • ingestion_wait_policy (Union[IngestionWaitPolicyProperty, Dict[str, Any], IResolvable, 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[LogicalTableProperty, Dict[str, Any], IResolvable]], None]) – Configures the combination and transformation of the data from the physical tables.

  • name (Optional[str]) – The display name for the dataset.

  • permissions (Union[IResolvable, Sequence[Union[ResourcePermissionProperty, Dict[str, Any], IResolvable]], None]) – A list of resource permissions on the dataset.

  • physical_table_map (Union[IResolvable, Mapping[str, Union[PhysicalTableProperty, Dict[str, Any], IResolvable]], None]) – Declares the physical tables that are available in the underlying data sources.

  • row_level_permission_data_set (Union[RowLevelPermissionDataSetProperty, Dict[str, Any], IResolvable, None]) – The row-level security configuration for the data that you want to create.

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

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_depends_on(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_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

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:

# Example automatically generated from non-compiling source. May contain errors.
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 intermdediate 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 resoure, 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)

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.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

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

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

Return type

str

attr_consumed_spice_capacity_in_bytes

ConsumedSpiceCapacityInBytes

Type

cloudformationAttribute

Return type

IResolvable

attr_created_time

The time this dataset version was created.

CloudformationAttribute

CreatedTime

Return type

str

attr_last_updated_time

The time this dataset version was last updated.

CloudformationAttribute

LastUpdatedTime

Return type

str

attr_output_columns

OutputColumns

Type

cloudformationAttribute

Return type

IResolvable

aws_account_id

The AWS account ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-awsaccountid

Return type

Optional[str]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

column_groups

Groupings of columns that work together in certain Amazon QuickSight features.

Currently, only geospatial hierarchy is supported.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-columngroups

Return type

Union[IResolvable, List[Union[ColumnGroupProperty, IResolvable]], None]

column_level_permission_rules

A set of one or more definitions of a ColumnLevelPermissionRule .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-columnlevelpermissionrules

Return type

Union[IResolvable, List[Union[ColumnLevelPermissionRuleProperty, IResolvable]], None]

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.

Return type

List[str]

data_set_id

An ID for the dataset that you want to create.

This ID is unique per AWS Region for each AWS account.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetid

Return type

Optional[str]

data_set_usage_configuration

AWS::QuickSight::DataSet.DataSetUsageConfiguration.

Link

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

Return type

Union[DataSetUsageConfigurationProperty, IResolvable, None]

field_folders

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-fieldfolders

Return type

Union[IResolvable, Mapping[str, Union[FieldFolderProperty, IResolvable]], None]

import_mode

Indicates whether you want to import the data into SPICE.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-importmode

Return type

Optional[str]

ingestion_wait_policy

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.

Link

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

Return type

Union[IngestionWaitPolicyProperty, IResolvable, None]

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

Return type

str

Returns

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

logical_table_map

Configures the combination and transformation of the data from the physical tables.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-logicaltablemap

Return type

Union[IResolvable, Mapping[str, Union[LogicalTableProperty, IResolvable]], None]

name

The display name for the dataset.

Link

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

Return type

Optional[str]

node

The tree node.

Return type

Node

permissions

A list of resource permissions on the dataset.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-permissions

Return type

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

physical_table_map

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-physicaltablemap

Return type

Union[IResolvable, Mapping[str, Union[PhysicalTableProperty, IResolvable]], None]

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

Return type

str

row_level_permission_data_set

The row-level security configuration for the data that you want to create.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset

Return type

Union[RowLevelPermissionDataSetProperty, IResolvable, None]

stack

The stack in which this element is defined.

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

Return type

Stack

tags

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-tags

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

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

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

Parameters

x (Any) –

Return type

bool

Returns

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

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

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.

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, Amazon QuickSight preserves the existing calculated column.

  • column_name (str) – Column name.

  • expression (str) – An expression that defines the calculated column.

Link

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, Amazon QuickSight preserves the existing calculated column.

Link

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

Return type

str

column_name

Column name.

Link

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

Return type

str

expression

An expression that defines the calculated column.

Link

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

Return type

str

CastColumnTypeOperationProperty

class CfnDataSet.CastColumnTypeOperationProperty(*, column_name, new_column_type, format=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 Amazon QuickSight to denote the source data format.

Link

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"
)

Attributes

column_name

Column name.

Link

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

Return type

str

format

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

Link

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

Return type

Optional[str]

new_column_type

New column data type.

Link

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

Return type

str

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.

Link

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.

Link

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

Return type

Optional[str]

ColumnGroupProperty

class CfnDataSet.ColumnGroupProperty(*, geo_spatial_column_group=None)

Bases: object

Groupings of columns that work together in certain Amazon QuickSight 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[GeoSpatialColumnGroupProperty, Dict[str, Any], IResolvable, None]) – Geospatial column group that denotes a hierarchy.

Link

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.

Link

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

Return type

Union[GeoSpatialColumnGroupProperty, IResolvable, None]

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 Amazon QuickSight users or groups.

Link

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.

Link

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

Return type

Optional[List[str]]

principals

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

Link

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

Return type

Optional[List[str]]

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[ColumnDescriptionProperty, Dict[str, Any], IResolvable, None]) – A description for a column.

  • column_geographic_role (Optional[str]) – A geospatial role for a column.

Link

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.

Link

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

Return type

Union[ColumnDescriptionProperty, IResolvable, None]

column_geographic_role

A geospatial role for a column.

Link

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

Return type

Optional[str]

CreateColumnsOperationProperty

class CfnDataSet.CreateColumnsOperationProperty(*, columns)

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[CalculatedColumnProperty, Dict[str, Any], IResolvable]]]) – Calculated columns to create.

Link

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"
    )]
)

Attributes

columns

Calculated columns to create.

Link

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

Return type

Union[IResolvable, List[Union[CalculatedColumnProperty, IResolvable]]]

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[InputColumnProperty, Dict[str, Any], IResolvable]]]) – 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.

Link

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"
    )],
    data_source_arn="dataSourceArn",
    name="name",
    sql_query="sqlQuery"
)

Attributes

columns

The column schema from the SQL query result set.

Link

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

Return type

Union[IResolvable, List[Union[InputColumnProperty, IResolvable]]]

data_source_arn

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

Link

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

Return type

str

name

A display name for the SQL query result.

Link

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

Return type

str

sql_query

The SQL query.

Link

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

Return type

str

DataSetUsageConfigurationProperty

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

Bases: object

Parameters
  • disable_use_as_direct_query_source (Union[bool, IResolvable, None]) – CfnDataSet.DataSetUsageConfigurationProperty.DisableUseAsDirectQuerySource.

  • disable_use_as_imported_source (Union[bool, IResolvable, None]) – CfnDataSet.DataSetUsageConfigurationProperty.DisableUseAsImportedSource.

Link

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

CfnDataSet.DataSetUsageConfigurationProperty.DisableUseAsDirectQuerySource.

Link

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

Return type

Union[bool, IResolvable, None]

disable_use_as_imported_source

CfnDataSet.DataSetUsageConfigurationProperty.DisableUseAsImportedSource.

Link

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

Return type

Union[bool, IResolvable, None]

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.

Link

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.

Link

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

Return type

Optional[List[str]]

description

The description for a field folder.

Link

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

Return type

Optional[str]

FilterOperationProperty

class CfnDataSet.FilterOperationProperty(*, condition_expression)

Bases: object

A transform operation that filters rows based on a condition.

Parameters

condition_expression (str) – An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.

Link

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"
)

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.

Link

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

Return type

str

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.

Link

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.

Link

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

Return type

List[str]

country_code

Country code.

Link

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

Return type

Optional[str]

name

A display name for the hierarchy.

Link

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

Return type

str

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.

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

Link

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.

Link

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

Return type

Union[int, float, None]

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.

Link

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

Return type

Union[bool, IResolvable, None]

InputColumnProperty

class CfnDataSet.InputColumnProperty(*, name, type)

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.

Link

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"
)

Attributes

name

The name of this column in the underlying data source.

Link

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

Return type

str

type

The data type of the column.

Link

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

Return type

str

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[JoinKeyPropertiesProperty, Dict[str, Any], IResolvable, None]) – Join key properties of the left operand.

  • right_join_key_properties (Union[JoinKeyPropertiesProperty, Dict[str, Any], IResolvable, None]) – Join key properties of the right operand.

Link

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.

Link

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

Return type

Union[JoinKeyPropertiesProperty, IResolvable, None]

left_operand

The operand on the left side of a join.

Link

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

Return type

str

on_clause

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

Link

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

Return type

str

right_join_key_properties

Join key properties of the right operand.

Link

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

Return type

Union[JoinKeyPropertiesProperty, IResolvable, None]

right_operand

The operand on the right side of a join.

Link

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

Return type

str

type

The type of join that it is.

Link

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

Return type

str

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 Amazon QuickSight to optimize query performance.

Link

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 Amazon QuickSight to optimize query performance.

Link

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

Return type

Union[bool, IResolvable, None]

LogicalTableProperty

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

Bases: object

A logical table is a unit that joins and that data transformations operate on.

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
Link

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"
        ),
        create_columns_operation=quicksight.CfnDataSet.CreateColumnsOperationProperty(
            columns=[quicksight.CfnDataSet.CalculatedColumnProperty(
                column_id="columnId",
                column_name="columnName",
                expression="expression"
            )]
        ),
        filter_operation=quicksight.CfnDataSet.FilterOperationProperty(
            condition_expression="conditionExpression"
        ),
        project_operation=quicksight.CfnDataSet.ProjectOperationProperty(
            projected_columns=["projectedColumns"]
        ),
        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"
            )]
        )
    )]
)

Attributes

alias

A display name for the logical table.

Link

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

Return type

str

data_transforms

Transform operations that act on this logical table.

Link

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

Return type

Union[IResolvable, List[Union[TransformOperationProperty, IResolvable]], None]

source

Source of this logical table.

Link

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

Return type

Union[LogicalTableSourceProperty, IResolvable]

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]) – CfnDataSet.LogicalTableSourceProperty.DataSetArn.

  • join_instruction (Union[JoinInstructionProperty, Dict[str, Any], IResolvable, None]) – Specifies the result of a join of two logical tables.

  • physical_table_id (Optional[str]) – Physical table ID.

Link

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

CfnDataSet.LogicalTableSourceProperty.DataSetArn.

Link

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

Return type

Optional[str]

join_instruction

Specifies the result of a join of two logical tables.

Link

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

Return type

Union[JoinInstructionProperty, IResolvable, None]

physical_table_id

Physical table ID.

Link

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

Return type

Optional[str]

OutputColumnProperty

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

Bases: object

Output column.

Parameters
  • description (Optional[str]) – A description for a column.

  • name (Optional[str]) – A display name for the dataset.

  • type (Optional[str]) – Type.

Link

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",
    name="name",
    type="type"
)

Attributes

description

A description for a column.

Link

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

Return type

Optional[str]

name

A display name for the dataset.

Link

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

Return type

Optional[str]

type

Type.

Link

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

Return type

Optional[str]

PhysicalTableProperty

class CfnDataSet.PhysicalTableProperty(*, custom_sql=None, relational_table=None, s3_source=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
Link

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"
        )],
        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"
        )],
        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
        upload_settings=quicksight.CfnDataSet.UploadSettingsProperty(
            contains_header=False,
            delimiter="delimiter",
            format="format",
            start_from_row=123,
            text_qualifier="textQualifier"
        )
    )
)

Attributes

custom_sql

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

Link

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

Return type

Union[CustomSqlProperty, IResolvable, None]

relational_table

A physical table type for relational data sources.

Link

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

Return type

Union[RelationalTableProperty, IResolvable, None]

s3_source

A physical table type for as S3 data source.

Link

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

Return type

Union[S3SourceProperty, IResolvable, None]

ProjectOperationProperty

class CfnDataSet.ProjectOperationProperty(*, projected_columns)

Bases: object

A transform operation that projects columns.

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

Parameters

projected_columns (Sequence[str]) – Projected columns.

Link

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(
    projected_columns=["projectedColumns"]
)

Attributes

projected_columns

Projected columns.

Link

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

Return type

List[str]

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[InputColumnProperty, Dict[str, Any], IResolvable]]]) – The column schema of the table.

  • name (str) – The name of the relational table.

  • catalog (Optional[str]) – CfnDataSet.RelationalTableProperty.Catalog.

  • schema (Optional[str]) – The schema name. This name applies to certain relational database engines.

Link

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"
    )],
    name="name",

    # the properties below are optional
    catalog="catalog",
    schema="schema"
)

Attributes

catalog

CfnDataSet.RelationalTableProperty.Catalog.

Link

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

Return type

Optional[str]

data_source_arn

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

Link

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

Return type

str

input_columns

The column schema of the table.

Link

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

Return type

Union[IResolvable, List[Union[InputColumnProperty, IResolvable]]]

name

The name of the relational table.

Link

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

Return type

str

schema

The schema name.

This name applies to certain relational database engines.

Link

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

Return type

Optional[str]

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.

Link

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.

Link

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

Return type

str

new_column_name

The new name for the column.

Link

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

Return type

str

ResourcePermissionProperty

class CfnDataSet.ResourcePermissionProperty(*, actions, principal)

Bases: object

Permission for the resource.

Parameters
  • actions (Sequence[str]) – The IAM action to grand 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 QuickSight user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

Link

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 grand or revoke permisions on.

Link

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

Return type

List[str]

principal

.

  • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

  • The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

  • The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)

Link

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

Return type

str

RowLevelPermissionDataSetProperty

class CfnDataSet.RowLevelPermissionDataSetProperty(*, arn, permission_policy, format_version=None, namespace=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 Amazon QuickSight 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.

Link

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"
)

Attributes

arn

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

Link

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

Return type

str

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.

Link

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

Return type

Optional[str]

namespace

The namespace associated with the dataset that contains permissions for RLS.

Link

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

Return type

Optional[str]

permission_policy

The type of permissions to use when interpreting the permissions for RLS.

DENY_ACCESS is included for backward compatibility only.

Link

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

Return type

str

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[InputColumnProperty, Dict[str, Any], IResolvable]]]) – 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[UploadSettingsProperty, Dict[str, Any], IResolvable, None]) – Information about the format for the S3 source file or files.

Link

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

Link

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

Return type

str

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.

Link

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

Return type

Union[IResolvable, List[Union[InputColumnProperty, IResolvable]]]

upload_settings

Information about the format for the S3 source file or files.

Link

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

Return type

Union[UploadSettingsProperty, IResolvable, None]

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.

Link

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.

Link

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

Return type

str

tags

The dataset column tag, currently only used for geospatial type tagging.

This is not tags for the AWS tagging feature.

Link

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

Return type

List[ColumnTagProperty]

TransformOperationProperty

class CfnDataSet.TransformOperationProperty(*, cast_column_type_operation=None, create_columns_operation=None, filter_operation=None, project_operation=None, rename_column_operation=None, tag_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
Link

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"
    ),
    create_columns_operation=quicksight.CfnDataSet.CreateColumnsOperationProperty(
        columns=[quicksight.CfnDataSet.CalculatedColumnProperty(
            column_id="columnId",
            column_name="columnName",
            expression="expression"
        )]
    ),
    filter_operation=quicksight.CfnDataSet.FilterOperationProperty(
        condition_expression="conditionExpression"
    ),
    project_operation=quicksight.CfnDataSet.ProjectOperationProperty(
        projected_columns=["projectedColumns"]
    ),
    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"
        )]
    )
)

Attributes

cast_column_type_operation

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

Link

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

Return type

Union[CastColumnTypeOperationProperty, IResolvable, None]

create_columns_operation

An operation that creates calculated columns.

Columns created in one such operation form a lexical closure.

Link

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

Return type

Union[CreateColumnsOperationProperty, IResolvable, None]

filter_operation

An operation that filters rows based on some condition.

Link

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

Return type

Union[FilterOperationProperty, IResolvable, None]

project_operation

An operation that projects columns.

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

Link

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

Return type

Union[ProjectOperationProperty, IResolvable, None]

rename_column_operation

An operation that renames a column.

Link

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

Return type

Union[RenameColumnOperationProperty, IResolvable, None]

tag_column_operation

An operation that tags a column with additional information.

Link

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

Return type

Union[TagColumnOperationProperty, IResolvable, None]

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.

Link

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.

Link

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

Return type

Union[bool, IResolvable, None]

delimiter

The delimiter between values in the file.

Link

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

Return type

Optional[str]

format

File format.

Link

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

Return type

Optional[str]

start_from_row

A row number to start reading data from.

Link

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

Return type

Union[int, float, None]

text_qualifier

Text qualifier.

Link

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

Return type

Optional[str]