CfnDataSetProps

class aws_cdk.aws_quicksight.CfnDataSetProps(*, 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: object

Properties for defining a CfnDataSet.

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

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_props = quicksight.CfnDataSetProps(
    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"
    )]
)

Attributes

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]

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]

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_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]

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]

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]

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

Optional[List[CfnTag]]