CfnDataSetMixinProps

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

Bases: object

Properties for CfnDataSetPropsMixin.

Parameters:

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

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

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

  • data_prep_configuration (Union[IResolvable, DataPrepConfigurationProperty, Dict[str, Any], None]) – The data preparation configuration associated with this dataset.

  • data_set_id (Optional[str]) – An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

  • dataset_parameters (Union[IResolvable, Sequence[Union[IResolvable, DatasetParameterProperty, Dict[str, Any]]], None]) – The parameters that are declared in a dataset.

  • data_set_refresh_properties (Union[IResolvable, DataSetRefreshPropertiesProperty, Dict[str, Any], None]) – The refresh properties of a dataset.

  • data_set_usage_configuration (Union[IResolvable, DataSetUsageConfigurationProperty, Dict[str, Any], None]) – The usage configuration to apply to child datasets that reference this dataset as a source.

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

  • folder_arns (Optional[Sequence[str]])

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

  • ingestion_wait_policy (Union[IResolvable, IngestionWaitPolicyProperty, Dict[str, Any], None]) – The wait policy to use when creating or updating a Dataset. The default is to wait for SPICE ingestion to finish with timeout of 36 hours.

  • logical_table_map (Union[IResolvable, Mapping[str, Union[IResolvable, LogicalTableProperty, Dict[str, Any]]], None])

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

  • performance_configuration (Union[IResolvable, PerformanceConfigurationProperty, Dict[str, Any], None]) – The performance optimization configuration of a dataset.

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

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

  • row_level_permission_data_set (Union[IResolvable, RowLevelPermissionDataSetProperty, Dict[str, Any], None]) – (deprecated) Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide. The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.

  • row_level_permission_tag_configuration (Union[IResolvable, RowLevelPermissionTagConfigurationProperty, Dict[str, Any], None]) – (deprecated) The configuration of tags on a dataset to set row-level security.

  • semantic_model_configuration (Union[IResolvable, SemanticModelConfigurationProperty, Dict[str, Any], None]) – The semantic model configuration associated with this dataset.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

  • use_as (Optional[str]) – The usage of the dataset.

See:

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

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
aws_account_id

The AWS account ID.

See:

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

column_groups

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

Currently, only geospatial hierarchy is supported.

See:

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

column_level_permission_rules

A set of one or more definitions of a ColumnLevelPermissionRule .

See:

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

data_prep_configuration

The data preparation configuration associated with this dataset.

See:

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

data_set_id

An ID for the dataset that you want to create.

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

See:

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

data_set_refresh_properties

The refresh properties of a dataset.

See:

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

data_set_usage_configuration

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

See:

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

dataset_parameters

The parameters that are declared in a dataset.

See:

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

field_folders

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

See:

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

folder_arns

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

Type:

see

import_mode

Indicates whether you want to import the data into SPICE.

See:

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

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.

See:

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

logical_table_map

this property has been deprecated

See:

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

Stability:

deprecated

Type:

deprecated

name

The display name for the dataset.

See:

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

performance_configuration

The performance optimization configuration of a dataset.

See:

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

permissions

A list of resource permissions on the dataset.

See:

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

physical_table_map

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

See:

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

row_level_permission_data_set

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

The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide.

Deprecated:

this property has been deprecated

See:

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

Stability:

deprecated

row_level_permission_tag_configuration

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

Deprecated:

this property has been deprecated

See:

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

Stability:

deprecated

semantic_model_configuration

The semantic model configuration associated with this dataset.

See:

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

tags

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

See:

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

use_as

The usage of the dataset.

See:

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