This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::QuickSight::DataSet Creates a dataset. This operation doesn't support datasets that include uploaded files as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::QuickSight::DataSet", "Properties" : { "[AwsAccountId](#cfn-quicksight-dataset-awsaccountid)" : String, "[ColumnGroups](#cfn-quicksight-dataset-columngroups)" : [ ColumnGroup, ... ], "[ColumnLevelPermissionRules](#cfn-quicksight-dataset-columnlevelpermissionrules)" : [ ColumnLevelPermissionRule, ... ], "[DataPrepConfiguration](#cfn-quicksight-dataset-dataprepconfiguration)" : DataPrepConfiguration, "[DataSetId](#cfn-quicksight-dataset-datasetid)" : String, "[DatasetParameters](#cfn-quicksight-dataset-datasetparameters)" : [ DatasetParameter, ... ], "[DataSetRefreshProperties](#cfn-quicksight-dataset-datasetrefreshproperties)" : DataSetRefreshProperties, "[DataSetUsageConfiguration](#cfn-quicksight-dataset-datasetusageconfiguration)" : DataSetUsageConfiguration, "[FieldFolders](#cfn-quicksight-dataset-fieldfolders)" : {Key: Value, ...}, "[FolderArns](#cfn-quicksight-dataset-folderarns)" : [ String, ... ], "[ImportMode](#cfn-quicksight-dataset-importmode)" : String, "[IngestionWaitPolicy](#cfn-quicksight-dataset-ingestionwaitpolicy)" : IngestionWaitPolicy, "[Name](#cfn-quicksight-dataset-name)" : String, "[PerformanceConfiguration](#cfn-quicksight-dataset-performanceconfiguration)" : PerformanceConfiguration, "[Permissions](#cfn-quicksight-dataset-permissions)" : [ ResourcePermission, ... ], "[PhysicalTableMap](#cfn-quicksight-dataset-physicaltablemap)" : {Key: Value, ...}, "[SemanticModelConfiguration](#cfn-quicksight-dataset-semanticmodelconfiguration)" : SemanticModelConfiguration, "[Tags](#cfn-quicksight-dataset-tags)" : [ Tag, ... ], "[UseAs](#cfn-quicksight-dataset-useas)" : String } } ``` ### YAML ``` Type: AWS::QuickSight::DataSet Properties: [AwsAccountId](#cfn-quicksight-dataset-awsaccountid): String [ColumnGroups](#cfn-quicksight-dataset-columngroups): - ColumnGroup [ColumnLevelPermissionRules](#cfn-quicksight-dataset-columnlevelpermissionrules): - ColumnLevelPermissionRule [DataPrepConfiguration](#cfn-quicksight-dataset-dataprepconfiguration): DataPrepConfiguration [DataSetId](#cfn-quicksight-dataset-datasetid): String [DatasetParameters](#cfn-quicksight-dataset-datasetparameters): - DatasetParameter [DataSetRefreshProperties](#cfn-quicksight-dataset-datasetrefreshproperties): DataSetRefreshProperties [DataSetUsageConfiguration](#cfn-quicksight-dataset-datasetusageconfiguration): DataSetUsageConfiguration [FieldFolders](#cfn-quicksight-dataset-fieldfolders): Key: Value [FolderArns](#cfn-quicksight-dataset-folderarns): - String [ImportMode](#cfn-quicksight-dataset-importmode): String [IngestionWaitPolicy](#cfn-quicksight-dataset-ingestionwaitpolicy): IngestionWaitPolicy [Name](#cfn-quicksight-dataset-name): String [PerformanceConfiguration](#cfn-quicksight-dataset-performanceconfiguration): PerformanceConfiguration [Permissions](#cfn-quicksight-dataset-permissions): - ResourcePermission [PhysicalTableMap](#cfn-quicksight-dataset-physicaltablemap): Key: Value [SemanticModelConfiguration](#cfn-quicksight-dataset-semanticmodelconfiguration): SemanticModelConfiguration [Tags](#cfn-quicksight-dataset-tags): - Tag [UseAs](#cfn-quicksight-dataset-useas): String ``` ## Properties `AwsAccountId` The AWS account ID. *Required*: No *Type*: String *Pattern*: `^[0-9]{12}$` *Minimum*: `12` *Maximum*: `12` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ColumnGroups` Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported. *Required*: No *Type*: Array of [ColumnGroup](aws-properties-quicksight-dataset-columngroup.md) *Minimum*: `1` *Maximum*: `8` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ColumnLevelPermissionRules` A set of one or more definitions of a ` ColumnLevelPermissionRule `. *Required*: No *Type*: Array of [ColumnLevelPermissionRule](aws-properties-quicksight-dataset-columnlevelpermissionrule.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataPrepConfiguration` The data preparation configuration associated with this dataset. *Required*: No *Type*: [DataPrepConfiguration](aws-properties-quicksight-dataset-dataprepconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataSetId` An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DatasetParameters` The parameters that are declared in a dataset. *Required*: No *Type*: Array of [DatasetParameter](aws-properties-quicksight-dataset-datasetparameter.md) *Minimum*: `0` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataSetRefreshProperties` The refresh properties of a dataset. *Required*: No *Type*: [DataSetRefreshProperties](aws-properties-quicksight-dataset-datasetrefreshproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataSetUsageConfiguration` The usage configuration to apply to child datasets that reference this dataset as a source. *Required*: No *Type*: [DataSetUsageConfiguration](aws-properties-quicksight-dataset-datasetusageconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FieldFolders` The folder that contains fields and nested subfolders for your dataset. *Required*: No *Type*: Object of [FieldFolder](aws-properties-quicksight-dataset-fieldfolder.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FolderArns` Property description not available. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ImportMode` Indicates whether you want to import the data into SPICE. *Required*: No *Type*: String *Allowed values*: `SPICE | DIRECT_QUERY` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IngestionWaitPolicy` 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. *Required*: No *Type*: [IngestionWaitPolicy](aws-properties-quicksight-dataset-ingestionwaitpolicy.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The display name for the dataset. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PerformanceConfiguration` The performance optimization configuration of a dataset. *Required*: No *Type*: [PerformanceConfiguration](aws-properties-quicksight-dataset-performanceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Permissions` A list of resource permissions on the dataset. *Required*: No *Type*: Array of [ResourcePermission](aws-properties-quicksight-dataset-resourcepermission.md) *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PhysicalTableMap` Declares the physical tables that are available in the underlying data sources. *Required*: No *Type*: Object of [PhysicalTable](aws-properties-quicksight-dataset-physicaltable.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SemanticModelConfiguration` The semantic model configuration associated with this dataset. *Required*: No *Type*: [SemanticModelConfiguration](aws-properties-quicksight-dataset-semanticmodelconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset. *Required*: No *Type*: Array of [Tag](aws-properties-quicksight-dataset-tag.md) *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UseAs` The usage of the dataset. *Required*: No *Type*: String *Allowed values*: `RLS_RULES` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Fn::GetAtt #### `Arn` The Amazon Resource Name (ARN) of the dataset. `ConsumedSpiceCapacityInBytes` `CreatedTime` The time this dataset version was created. `LastUpdatedTime` The time this dataset version was last updated. `OutputColumns` # AWS::QuickSight::DataSet AggregateOperation A transform operation that groups rows by specified columns and applies aggregation functions to calculate summary values. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Aggregations](#cfn-quicksight-dataset-aggregateoperation-aggregations)" : [ Aggregation, ... ], "[Alias](#cfn-quicksight-dataset-aggregateoperation-alias)" : String, "[GroupByColumnNames](#cfn-quicksight-dataset-aggregateoperation-groupbycolumnnames)" : [ String, ... ], "[Source](#cfn-quicksight-dataset-aggregateoperation-source)" : TransformOperationSource } ``` ### YAML ``` [Aggregations](#cfn-quicksight-dataset-aggregateoperation-aggregations): - Aggregation [Alias](#cfn-quicksight-dataset-aggregateoperation-alias): String [GroupByColumnNames](#cfn-quicksight-dataset-aggregateoperation-groupbycolumnnames): - String [Source](#cfn-quicksight-dataset-aggregateoperation-source): TransformOperationSource ``` ## Properties `Aggregations` The list of aggregation functions to apply to the grouped data, such as `SUM`, `COUNT`, or `AVERAGE`. *Required*: Yes *Type*: Array of [Aggregation](aws-properties-quicksight-dataset-aggregation.md) *Minimum*: `0` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Alias` Alias for this operation. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GroupByColumnNames` The list of column names to group by when performing the aggregation. Rows with the same values in these columns will be grouped together. *Required*: No *Type*: Array of String *Minimum*: `1 | 0` *Maximum*: `127 | 128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The source transform operation that provides input data for the aggregation. *Required*: Yes *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet Aggregation Defines an aggregation function to be applied to grouped data, creating a new column with the calculated result. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AggregationFunction](#cfn-quicksight-dataset-aggregation-aggregationfunction)" : DataPrepAggregationFunction, "[NewColumnId](#cfn-quicksight-dataset-aggregation-newcolumnid)" : String, "[NewColumnName](#cfn-quicksight-dataset-aggregation-newcolumnname)" : String } ``` ### YAML ``` [AggregationFunction](#cfn-quicksight-dataset-aggregation-aggregationfunction): DataPrepAggregationFunction [NewColumnId](#cfn-quicksight-dataset-aggregation-newcolumnid): String [NewColumnName](#cfn-quicksight-dataset-aggregation-newcolumnname): String ``` ## Properties `AggregationFunction` The aggregation function to apply, such as `SUM`, `COUNT`, `AVERAGE`, `MIN`, `MAX` *Required*: Yes *Type*: [DataPrepAggregationFunction](aws-properties-quicksight-dataset-dataprepaggregationfunction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NewColumnId` A unique identifier for the new column that will contain the aggregated values. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NewColumnName` The name for the new column that will contain the aggregated values. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet AppendedColumn Represents a column that will be included in the result of an append operation, combining data from multiple sources. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-appendedcolumn-columnname)" : String, "[NewColumnId](#cfn-quicksight-dataset-appendedcolumn-newcolumnid)" : String } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-appendedcolumn-columnname): String [NewColumnId](#cfn-quicksight-dataset-appendedcolumn-newcolumnid): String ``` ## Properties `ColumnName` The name of the column to include in the appended result. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NewColumnId` A unique identifier for the column in the appended result. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet AppendOperation A transform operation that combines rows from two data sources by stacking them vertically (union operation). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-appendoperation-alias)" : String, "[AppendedColumns](#cfn-quicksight-dataset-appendoperation-appendedcolumns)" : [ AppendedColumn, ... ], "[FirstSource](#cfn-quicksight-dataset-appendoperation-firstsource)" : TransformOperationSource, "[SecondSource](#cfn-quicksight-dataset-appendoperation-secondsource)" : TransformOperationSource } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-appendoperation-alias): String [AppendedColumns](#cfn-quicksight-dataset-appendoperation-appendedcolumns): - AppendedColumn [FirstSource](#cfn-quicksight-dataset-appendoperation-firstsource): TransformOperationSource [SecondSource](#cfn-quicksight-dataset-appendoperation-secondsource): TransformOperationSource ``` ## Properties `Alias` Alias for this operation. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AppendedColumns` The list of columns to include in the appended result, mapping columns from both sources. *Required*: Yes *Type*: Array of [AppendedColumn](aws-properties-quicksight-dataset-appendedcolumn.md) *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FirstSource` The first data source to be included in the append operation. *Required*: No *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecondSource` The second data source to be appended to the first source. *Required*: No *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet CalculatedColumn A calculated column for a dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnId](#cfn-quicksight-dataset-calculatedcolumn-columnid)" : String, "[ColumnName](#cfn-quicksight-dataset-calculatedcolumn-columnname)" : String, "[Expression](#cfn-quicksight-dataset-calculatedcolumn-expression)" : String } ``` ### YAML ``` [ColumnId](#cfn-quicksight-dataset-calculatedcolumn-columnid): String [ColumnName](#cfn-quicksight-dataset-calculatedcolumn-columnname): String [Expression](#cfn-quicksight-dataset-calculatedcolumn-expression): String ``` ## Properties `ColumnId` A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ColumnName` Column name. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Expression` An expression that defines the calculated column. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `250000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet CastColumnTypeOperation A transform operation that casts a column to a different type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-castcolumntypeoperation-columnname)" : String, "[Format](#cfn-quicksight-dataset-castcolumntypeoperation-format)" : String, "[NewColumnType](#cfn-quicksight-dataset-castcolumntypeoperation-newcolumntype)" : String, "[SubType](#cfn-quicksight-dataset-castcolumntypeoperation-subtype)" : String } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-castcolumntypeoperation-columnname): String [Format](#cfn-quicksight-dataset-castcolumntypeoperation-format): String [NewColumnType](#cfn-quicksight-dataset-castcolumntypeoperation-newcolumntype): String [SubType](#cfn-quicksight-dataset-castcolumntypeoperation-subtype): String ``` ## Properties `ColumnName` Column name. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Format` When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NewColumnType` New column data type. *Required*: Yes *Type*: String *Allowed values*: `STRING | INTEGER | DECIMAL | DATETIME` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SubType` The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset. *Required*: No *Type*: String *Allowed values*: `FLOAT | FIXED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet CastColumnTypesOperation A transform operation that changes the data types of one or more columns in the dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-castcolumntypesoperation-alias)" : String, "[CastColumnTypeOperations](#cfn-quicksight-dataset-castcolumntypesoperation-castcolumntypeoperations)" : [ CastColumnTypeOperation, ... ], "[Source](#cfn-quicksight-dataset-castcolumntypesoperation-source)" : TransformOperationSource } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-castcolumntypesoperation-alias): String [CastColumnTypeOperations](#cfn-quicksight-dataset-castcolumntypesoperation-castcolumntypeoperations): - CastColumnTypeOperation [Source](#cfn-quicksight-dataset-castcolumntypesoperation-source): TransformOperationSource ``` ## Properties `Alias` Alias for this operation. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CastColumnTypeOperations` The list of column type casting operations to perform. *Required*: Yes *Type*: Array of [CastColumnTypeOperation](aws-properties-quicksight-dataset-castcolumntypeoperation.md) *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The source transform operation that provides input data for the type casting. *Required*: Yes *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ColumnDescription Metadata that contains a description for a column. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Text](#cfn-quicksight-dataset-columndescription-text)" : String } ``` ### YAML ``` [Text](#cfn-quicksight-dataset-columndescription-text): String ``` ## Properties `Text` The text of a description for a column. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `500` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ColumnGroup Groupings of columns that work together in certain Quick Sight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GeoSpatialColumnGroup](#cfn-quicksight-dataset-columngroup-geospatialcolumngroup)" : GeoSpatialColumnGroup } ``` ### YAML ``` [GeoSpatialColumnGroup](#cfn-quicksight-dataset-columngroup-geospatialcolumngroup): GeoSpatialColumnGroup ``` ## Properties `GeoSpatialColumnGroup` Geospatial column group that denotes a hierarchy. *Required*: No *Type*: [GeoSpatialColumnGroup](aws-properties-quicksight-dataset-geospatialcolumngroup.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ColumnLevelPermissionRule 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnNames](#cfn-quicksight-dataset-columnlevelpermissionrule-columnnames)" : [ String, ... ], "[Principals](#cfn-quicksight-dataset-columnlevelpermissionrule-principals)" : [ String, ... ] } ``` ### YAML ``` [ColumnNames](#cfn-quicksight-dataset-columnlevelpermissionrule-columnnames): - String [Principals](#cfn-quicksight-dataset-columnlevelpermissionrule-principals): - String ``` ## Properties `ColumnNames` An array of column names. *Required*: No *Type*: Array of String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Principals` An array of Amazon Resource Names (ARNs) for Quick users or groups. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ColumnTag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnDescription](#cfn-quicksight-dataset-columntag-columndescription)" : ColumnDescription, "[ColumnGeographicRole](#cfn-quicksight-dataset-columntag-columngeographicrole)" : String } ``` ### YAML ``` [ColumnDescription](#cfn-quicksight-dataset-columntag-columndescription): ColumnDescription [ColumnGeographicRole](#cfn-quicksight-dataset-columntag-columngeographicrole): String ``` ## Properties `ColumnDescription` A description for a column. *Required*: No *Type*: [ColumnDescription](aws-properties-quicksight-dataset-columndescription.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ColumnGeographicRole` A geospatial role for a column. *Required*: No *Type*: String *Allowed values*: `COUNTRY | STATE | COUNTY | CITY | POSTCODE | LONGITUDE | LATITUDE | POLITICAL1 | CENSUS_TRACT | CENSUS_BLOCK_GROUP | CENSUS_BLOCK` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ColumnToUnpivot Specifies a column to be unpivoted, transforming it from a column into rows with associated values. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-columntounpivot-columnname)" : String, "[NewValue](#cfn-quicksight-dataset-columntounpivot-newvalue)" : String } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-columntounpivot-columnname): String [NewValue](#cfn-quicksight-dataset-columntounpivot-newvalue): String ``` ## Properties `ColumnName` The name of the column to unpivot from the source data. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NewValue` The value to assign to this column in the unpivoted result, typically the column name or a descriptive label. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `2047` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet CreateColumnsOperation A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-createcolumnsoperation-alias)" : String, "[Columns](#cfn-quicksight-dataset-createcolumnsoperation-columns)" : [ CalculatedColumn, ... ], "[Source](#cfn-quicksight-dataset-createcolumnsoperation-source)" : TransformOperationSource } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-createcolumnsoperation-alias): String [Columns](#cfn-quicksight-dataset-createcolumnsoperation-columns): - CalculatedColumn [Source](#cfn-quicksight-dataset-createcolumnsoperation-source): TransformOperationSource ``` ## Properties `Alias` Alias for this operation. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Columns` Calculated columns to create. *Required*: Yes *Type*: Array of [CalculatedColumn](aws-properties-quicksight-dataset-calculatedcolumn.md) *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The source transform operation that provides input data for creating new calculated columns. *Required*: No *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet CustomSql A physical table type built from the results of the custom SQL query. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Columns](#cfn-quicksight-dataset-customsql-columns)" : [ InputColumn, ... ], "[DataSourceArn](#cfn-quicksight-dataset-customsql-datasourcearn)" : String, "[Name](#cfn-quicksight-dataset-customsql-name)" : String, "[SqlQuery](#cfn-quicksight-dataset-customsql-sqlquery)" : String } ``` ### YAML ``` [Columns](#cfn-quicksight-dataset-customsql-columns): - InputColumn [DataSourceArn](#cfn-quicksight-dataset-customsql-datasourcearn): String [Name](#cfn-quicksight-dataset-customsql-name): String [SqlQuery](#cfn-quicksight-dataset-customsql-sqlquery): String ``` ## Properties `Columns` The column schema from the SQL query result set. *Required*: Yes *Type*: Array of [InputColumn](aws-properties-quicksight-dataset-inputcolumn.md) *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataSourceArn` The Amazon Resource Name (ARN) of the data source. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` A display name for the SQL query result. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SqlQuery` The SQL query. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `168000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataPrepAggregationFunction Defines the type of aggregation function to apply to data during data preparation, supporting simple and list aggregations. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ListAggregation](#cfn-quicksight-dataset-dataprepaggregationfunction-listaggregation)" : DataPrepListAggregationFunction, "[PercentileAggregation](#cfn-quicksight-dataset-dataprepaggregationfunction-percentileaggregation)" : DataPrepPercentileAggregationFunction, "[SimpleAggregation](#cfn-quicksight-dataset-dataprepaggregationfunction-simpleaggregation)" : DataPrepSimpleAggregationFunction } ``` ### YAML ``` [ListAggregation](#cfn-quicksight-dataset-dataprepaggregationfunction-listaggregation): DataPrepListAggregationFunction [PercentileAggregation](#cfn-quicksight-dataset-dataprepaggregationfunction-percentileaggregation): DataPrepPercentileAggregationFunction [SimpleAggregation](#cfn-quicksight-dataset-dataprepaggregationfunction-simpleaggregation): DataPrepSimpleAggregationFunction ``` ## Properties `ListAggregation` A list aggregation function that concatenates values from multiple rows into a single delimited string. *Required*: No *Type*: [DataPrepListAggregationFunction](aws-properties-quicksight-dataset-datapreplistaggregationfunction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PercentileAggregation` Property description not available. *Required*: No *Type*: [DataPrepPercentileAggregationFunction](aws-properties-quicksight-dataset-datapreppercentileaggregationfunction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SimpleAggregation` A simple aggregation function such as `SUM`, `COUNT`, `AVERAGE`, `MIN`, `MAX`, `MEDIAN`, `VARIANCE`, or `STANDARD_DEVIATION`. *Required*: No *Type*: [DataPrepSimpleAggregationFunction](aws-properties-quicksight-dataset-dataprepsimpleaggregationfunction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataPrepConfiguration Configuration for data preparation operations, defining the complete pipeline from source tables through transformations to destination tables. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DestinationTableMap](#cfn-quicksight-dataset-dataprepconfiguration-destinationtablemap)" : {Key: Value, ...}, "[SourceTableMap](#cfn-quicksight-dataset-dataprepconfiguration-sourcetablemap)" : {Key: Value, ...}, "[TransformStepMap](#cfn-quicksight-dataset-dataprepconfiguration-transformstepmap)" : {Key: Value, ...} } ``` ### YAML ``` [DestinationTableMap](#cfn-quicksight-dataset-dataprepconfiguration-destinationtablemap): Key: Value [SourceTableMap](#cfn-quicksight-dataset-dataprepconfiguration-sourcetablemap): Key: Value [TransformStepMap](#cfn-quicksight-dataset-dataprepconfiguration-transformstepmap): Key: Value ``` ## Properties `DestinationTableMap` A map of destination tables that receive the final prepared data. *Required*: Yes *Type*: Object of [DestinationTable](aws-properties-quicksight-dataset-destinationtable.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceTableMap` A map of source tables that provide information about underlying sources. *Required*: Yes *Type*: Object of [SourceTable](aws-properties-quicksight-dataset-sourcetable.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TransformStepMap` A map of transformation steps that process the data. *Required*: Yes *Type*: Object of [TransformStep](aws-properties-quicksight-dataset-transformstep.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataPrepListAggregationFunction An aggregation function that concatenates values from multiple rows into a single string with a specified separator. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Distinct](#cfn-quicksight-dataset-datapreplistaggregationfunction-distinct)" : Boolean, "[InputColumnName](#cfn-quicksight-dataset-datapreplistaggregationfunction-inputcolumnname)" : String, "[Separator](#cfn-quicksight-dataset-datapreplistaggregationfunction-separator)" : String } ``` ### YAML ``` [Distinct](#cfn-quicksight-dataset-datapreplistaggregationfunction-distinct): Boolean [InputColumnName](#cfn-quicksight-dataset-datapreplistaggregationfunction-inputcolumnname): String [Separator](#cfn-quicksight-dataset-datapreplistaggregationfunction-separator): String ``` ## Properties `Distinct` Whether to include only distinct values in the concatenated result, removing duplicates. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputColumnName` The name of the column containing values to be concatenated. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Separator` The string used to separate values in the concatenated result. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataPrepPercentileAggregationFunction The `DataPrepPercentileAggregationFunction` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](aws-resource-quicksight-dataset.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputColumnName](#cfn-quicksight-dataset-datapreppercentileaggregationfunction-inputcolumnname)" : String, "[PercentileValue](#cfn-quicksight-dataset-datapreppercentileaggregationfunction-percentilevalue)" : Number } ``` ### YAML ``` [InputColumnName](#cfn-quicksight-dataset-datapreppercentileaggregationfunction-inputcolumnname): String [PercentileValue](#cfn-quicksight-dataset-datapreppercentileaggregationfunction-percentilevalue): Number ``` ## Properties `InputColumnName` Property description not available. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PercentileValue` Property description not available. *Required*: Yes *Type*: Number *Minimum*: `0` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataPrepSimpleAggregationFunction A simple aggregation function that performs standard statistical operations on a column. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FunctionType](#cfn-quicksight-dataset-dataprepsimpleaggregationfunction-functiontype)" : String, "[InputColumnName](#cfn-quicksight-dataset-dataprepsimpleaggregationfunction-inputcolumnname)" : String } ``` ### YAML ``` [FunctionType](#cfn-quicksight-dataset-dataprepsimpleaggregationfunction-functiontype): String [InputColumnName](#cfn-quicksight-dataset-dataprepsimpleaggregationfunction-inputcolumnname): String ``` ## Properties `FunctionType` The type of aggregation function to perform, such as `COUNT`, `SUM`, `AVERAGE`, `MIN`, `MAX`, `MEDIAN`, `VARIANCE`, or `STANDARD_DEVIATION`. *Required*: Yes *Type*: String *Allowed values*: `COUNT | DISTINCT_COUNT | SUM | AVERAGE | MEDIAN | MAX | MIN | VARIANCE | STANDARD_DEVIATION` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputColumnName` The name of the column on which to perform the aggregation function. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetColumnIdMapping The `DataSetColumnIdMapping` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](aws-resource-quicksight-dataset.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SourceColumnId](#cfn-quicksight-dataset-datasetcolumnidmapping-sourcecolumnid)" : String, "[TargetColumnId](#cfn-quicksight-dataset-datasetcolumnidmapping-targetcolumnid)" : String } ``` ### YAML ``` [SourceColumnId](#cfn-quicksight-dataset-datasetcolumnidmapping-sourcecolumnid): String [TargetColumnId](#cfn-quicksight-dataset-datasetcolumnidmapping-targetcolumnid): String ``` ## Properties `SourceColumnId` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TargetColumnId` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetDateComparisonFilterCondition A filter condition that compares date values using operators like `BEFORE`, `AFTER`, or their inclusive variants. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Operator](#cfn-quicksight-dataset-datasetdatecomparisonfiltercondition-operator)" : String, "[Value](#cfn-quicksight-dataset-datasetdatecomparisonfiltercondition-value)" : DataSetDateFilterValue } ``` ### YAML ``` [Operator](#cfn-quicksight-dataset-datasetdatecomparisonfiltercondition-operator): String [Value](#cfn-quicksight-dataset-datasetdatecomparisonfiltercondition-value): DataSetDateFilterValue ``` ## Properties `Operator` The comparison operator to use, such as `BEFORE`, `BEFORE_OR_EQUALS_TO`, `AFTER`, or `AFTER_OR_EQUALS_TO`. *Required*: Yes *Type*: String *Allowed values*: `BEFORE | BEFORE_OR_EQUALS_TO | AFTER | AFTER_OR_EQUALS_TO` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The date value to compare against. *Required*: No *Type*: [DataSetDateFilterValue](aws-properties-quicksight-dataset-datasetdatefiltervalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetDateFilterCondition A filter condition for date columns, supporting both comparison and range-based filtering. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-datasetdatefiltercondition-columnname)" : String, "[ComparisonFilterCondition](#cfn-quicksight-dataset-datasetdatefiltercondition-comparisonfiltercondition)" : DataSetDateComparisonFilterCondition, "[RangeFilterCondition](#cfn-quicksight-dataset-datasetdatefiltercondition-rangefiltercondition)" : DataSetDateRangeFilterCondition } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-datasetdatefiltercondition-columnname): String [ComparisonFilterCondition](#cfn-quicksight-dataset-datasetdatefiltercondition-comparisonfiltercondition): DataSetDateComparisonFilterCondition [RangeFilterCondition](#cfn-quicksight-dataset-datasetdatefiltercondition-rangefiltercondition): DataSetDateRangeFilterCondition ``` ## Properties `ColumnName` The name of the date column to filter. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ComparisonFilterCondition` A comparison-based filter condition for the date column. *Required*: No *Type*: [DataSetDateComparisonFilterCondition](aws-properties-quicksight-dataset-datasetdatecomparisonfiltercondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RangeFilterCondition` A range-based filter condition for the date column, filtering values between minimum and maximum dates. *Required*: No *Type*: [DataSetDateRangeFilterCondition](aws-properties-quicksight-dataset-datasetdaterangefiltercondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetDateFilterValue Represents a date value used in filter conditions. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[StaticValue](#cfn-quicksight-dataset-datasetdatefiltervalue-staticvalue)" : String } ``` ### YAML ``` [StaticValue](#cfn-quicksight-dataset-datasetdatefiltervalue-staticvalue): String ``` ## Properties `StaticValue` A static date value used for filtering. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetDateRangeFilterCondition A filter condition that filters date values within a specified range. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeMaximum](#cfn-quicksight-dataset-datasetdaterangefiltercondition-includemaximum)" : Boolean, "[IncludeMinimum](#cfn-quicksight-dataset-datasetdaterangefiltercondition-includeminimum)" : Boolean, "[RangeMaximum](#cfn-quicksight-dataset-datasetdaterangefiltercondition-rangemaximum)" : DataSetDateFilterValue, "[RangeMinimum](#cfn-quicksight-dataset-datasetdaterangefiltercondition-rangeminimum)" : DataSetDateFilterValue } ``` ### YAML ``` [IncludeMaximum](#cfn-quicksight-dataset-datasetdaterangefiltercondition-includemaximum): Boolean [IncludeMinimum](#cfn-quicksight-dataset-datasetdaterangefiltercondition-includeminimum): Boolean [RangeMaximum](#cfn-quicksight-dataset-datasetdaterangefiltercondition-rangemaximum): DataSetDateFilterValue [RangeMinimum](#cfn-quicksight-dataset-datasetdaterangefiltercondition-rangeminimum): DataSetDateFilterValue ``` ## Properties `IncludeMaximum` Whether to include the maximum value in the filter range. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncludeMinimum` Whether to include the minimum value in the filter range. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RangeMaximum` The maximum date value for the range filter. *Required*: No *Type*: [DataSetDateFilterValue](aws-properties-quicksight-dataset-datasetdatefiltervalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RangeMinimum` The minimum date value for the range filter. *Required*: No *Type*: [DataSetDateFilterValue](aws-properties-quicksight-dataset-datasetdatefiltervalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetNumericComparisonFilterCondition A filter condition that compares numeric values using operators like `EQUALS`, `GREATER_THAN`, or `LESS_THAN`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Operator](#cfn-quicksight-dataset-datasetnumericcomparisonfiltercondition-operator)" : String, "[Value](#cfn-quicksight-dataset-datasetnumericcomparisonfiltercondition-value)" : DataSetNumericFilterValue } ``` ### YAML ``` [Operator](#cfn-quicksight-dataset-datasetnumericcomparisonfiltercondition-operator): String [Value](#cfn-quicksight-dataset-datasetnumericcomparisonfiltercondition-value): DataSetNumericFilterValue ``` ## Properties `Operator` The comparison operator to use, such as `EQUALS`, `GREATER_THAN`, `LESS_THAN`, or their variants. *Required*: Yes *Type*: String *Allowed values*: `EQUALS | DOES_NOT_EQUAL | GREATER_THAN | GREATER_THAN_OR_EQUALS_TO | LESS_THAN | LESS_THAN_OR_EQUALS_TO` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The numeric value to compare against. *Required*: No *Type*: [DataSetNumericFilterValue](aws-properties-quicksight-dataset-datasetnumericfiltervalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetNumericFilterCondition A filter condition for numeric columns, supporting both comparison and range-based filtering. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-datasetnumericfiltercondition-columnname)" : String, "[ComparisonFilterCondition](#cfn-quicksight-dataset-datasetnumericfiltercondition-comparisonfiltercondition)" : DataSetNumericComparisonFilterCondition, "[RangeFilterCondition](#cfn-quicksight-dataset-datasetnumericfiltercondition-rangefiltercondition)" : DataSetNumericRangeFilterCondition } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-datasetnumericfiltercondition-columnname): String [ComparisonFilterCondition](#cfn-quicksight-dataset-datasetnumericfiltercondition-comparisonfiltercondition): DataSetNumericComparisonFilterCondition [RangeFilterCondition](#cfn-quicksight-dataset-datasetnumericfiltercondition-rangefiltercondition): DataSetNumericRangeFilterCondition ``` ## Properties `ColumnName` The name of the numeric column to filter. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ComparisonFilterCondition` A comparison-based filter condition for the numeric column. *Required*: No *Type*: [DataSetNumericComparisonFilterCondition](aws-properties-quicksight-dataset-datasetnumericcomparisonfiltercondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RangeFilterCondition` A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers. *Required*: No *Type*: [DataSetNumericRangeFilterCondition](aws-properties-quicksight-dataset-datasetnumericrangefiltercondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetNumericFilterValue Represents a numeric value used in filter conditions. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[StaticValue](#cfn-quicksight-dataset-datasetnumericfiltervalue-staticvalue)" : Number } ``` ### YAML ``` [StaticValue](#cfn-quicksight-dataset-datasetnumericfiltervalue-staticvalue): Number ``` ## Properties `StaticValue` A static numeric value used for filtering. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetNumericRangeFilterCondition A filter condition that filters numeric values within a specified range. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeMaximum](#cfn-quicksight-dataset-datasetnumericrangefiltercondition-includemaximum)" : Boolean, "[IncludeMinimum](#cfn-quicksight-dataset-datasetnumericrangefiltercondition-includeminimum)" : Boolean, "[RangeMaximum](#cfn-quicksight-dataset-datasetnumericrangefiltercondition-rangemaximum)" : DataSetNumericFilterValue, "[RangeMinimum](#cfn-quicksight-dataset-datasetnumericrangefiltercondition-rangeminimum)" : DataSetNumericFilterValue } ``` ### YAML ``` [IncludeMaximum](#cfn-quicksight-dataset-datasetnumericrangefiltercondition-includemaximum): Boolean [IncludeMinimum](#cfn-quicksight-dataset-datasetnumericrangefiltercondition-includeminimum): Boolean [RangeMaximum](#cfn-quicksight-dataset-datasetnumericrangefiltercondition-rangemaximum): DataSetNumericFilterValue [RangeMinimum](#cfn-quicksight-dataset-datasetnumericrangefiltercondition-rangeminimum): DataSetNumericFilterValue ``` ## Properties `IncludeMaximum` Whether to include the maximum value in the filter range. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncludeMinimum` Whether to include the minimum value in the filter range. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RangeMaximum` The maximum numeric value for the range filter. *Required*: No *Type*: [DataSetNumericFilterValue](aws-properties-quicksight-dataset-datasetnumericfiltervalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RangeMinimum` The minimum numeric value for the range filter. *Required*: No *Type*: [DataSetNumericFilterValue](aws-properties-quicksight-dataset-datasetnumericfiltervalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DatasetParameter The parameter declarations of the dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DateTimeDatasetParameter](#cfn-quicksight-dataset-datasetparameter-datetimedatasetparameter)" : DateTimeDatasetParameter, "[DecimalDatasetParameter](#cfn-quicksight-dataset-datasetparameter-decimaldatasetparameter)" : DecimalDatasetParameter, "[IntegerDatasetParameter](#cfn-quicksight-dataset-datasetparameter-integerdatasetparameter)" : IntegerDatasetParameter, "[StringDatasetParameter](#cfn-quicksight-dataset-datasetparameter-stringdatasetparameter)" : StringDatasetParameter } ``` ### YAML ``` [DateTimeDatasetParameter](#cfn-quicksight-dataset-datasetparameter-datetimedatasetparameter): DateTimeDatasetParameter [DecimalDatasetParameter](#cfn-quicksight-dataset-datasetparameter-decimaldatasetparameter): DecimalDatasetParameter [IntegerDatasetParameter](#cfn-quicksight-dataset-datasetparameter-integerdatasetparameter): IntegerDatasetParameter [StringDatasetParameter](#cfn-quicksight-dataset-datasetparameter-stringdatasetparameter): StringDatasetParameter ``` ## Properties `DateTimeDatasetParameter` A date time parameter that is created in the dataset. *Required*: No *Type*: [DateTimeDatasetParameter](aws-properties-quicksight-dataset-datetimedatasetparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DecimalDatasetParameter` A decimal parameter that is created in the dataset. *Required*: No *Type*: [DecimalDatasetParameter](aws-properties-quicksight-dataset-decimaldatasetparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IntegerDatasetParameter` An integer parameter that is created in the dataset. *Required*: No *Type*: [IntegerDatasetParameter](aws-properties-quicksight-dataset-integerdatasetparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StringDatasetParameter` A string parameter that is created in the dataset. *Required*: No *Type*: [StringDatasetParameter](aws-properties-quicksight-dataset-stringdatasetparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetRefreshProperties The refresh properties of a dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FailureConfiguration](#cfn-quicksight-dataset-datasetrefreshproperties-failureconfiguration)" : RefreshFailureConfiguration, "[RefreshConfiguration](#cfn-quicksight-dataset-datasetrefreshproperties-refreshconfiguration)" : RefreshConfiguration } ``` ### YAML ``` [FailureConfiguration](#cfn-quicksight-dataset-datasetrefreshproperties-failureconfiguration): RefreshFailureConfiguration [RefreshConfiguration](#cfn-quicksight-dataset-datasetrefreshproperties-refreshconfiguration): RefreshConfiguration ``` ## Properties `FailureConfiguration` The failure configuration for a dataset. *Required*: No *Type*: [RefreshFailureConfiguration](aws-properties-quicksight-dataset-refreshfailureconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RefreshConfiguration` The refresh configuration for a dataset. *Required*: No *Type*: [RefreshConfiguration](aws-properties-quicksight-dataset-refreshconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetStringComparisonFilterCondition A filter condition that compares string values using operators like `EQUALS`, `CONTAINS`, or `STARTS_WITH`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Operator](#cfn-quicksight-dataset-datasetstringcomparisonfiltercondition-operator)" : String, "[Value](#cfn-quicksight-dataset-datasetstringcomparisonfiltercondition-value)" : DataSetStringFilterValue } ``` ### YAML ``` [Operator](#cfn-quicksight-dataset-datasetstringcomparisonfiltercondition-operator): String [Value](#cfn-quicksight-dataset-datasetstringcomparisonfiltercondition-value): DataSetStringFilterValue ``` ## Properties `Operator` The comparison operator to use, such as `EQUALS`, `CONTAINS`, `STARTS_WITH`, `ENDS_WITH`, or their negations. *Required*: Yes *Type*: String *Allowed values*: `EQUALS | DOES_NOT_EQUAL | CONTAINS | DOES_NOT_CONTAIN | STARTS_WITH | ENDS_WITH` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The string value to compare against. *Required*: No *Type*: [DataSetStringFilterValue](aws-properties-quicksight-dataset-datasetstringfiltervalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetStringFilterCondition A filter condition for string columns, supporting both comparison and list-based filtering. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-datasetstringfiltercondition-columnname)" : String, "[ComparisonFilterCondition](#cfn-quicksight-dataset-datasetstringfiltercondition-comparisonfiltercondition)" : DataSetStringComparisonFilterCondition, "[ListFilterCondition](#cfn-quicksight-dataset-datasetstringfiltercondition-listfiltercondition)" : DataSetStringListFilterCondition } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-datasetstringfiltercondition-columnname): String [ComparisonFilterCondition](#cfn-quicksight-dataset-datasetstringfiltercondition-comparisonfiltercondition): DataSetStringComparisonFilterCondition [ListFilterCondition](#cfn-quicksight-dataset-datasetstringfiltercondition-listfiltercondition): DataSetStringListFilterCondition ``` ## Properties `ColumnName` The name of the string column to filter. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ComparisonFilterCondition` A comparison-based filter condition for the string column. *Required*: No *Type*: [DataSetStringComparisonFilterCondition](aws-properties-quicksight-dataset-datasetstringcomparisonfiltercondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ListFilterCondition` A list-based filter condition that includes or excludes values from a specified list. *Required*: No *Type*: [DataSetStringListFilterCondition](aws-properties-quicksight-dataset-datasetstringlistfiltercondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetStringFilterValue Represents a string value used in filter conditions. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[StaticValue](#cfn-quicksight-dataset-datasetstringfiltervalue-staticvalue)" : String } ``` ### YAML ``` [StaticValue](#cfn-quicksight-dataset-datasetstringfiltervalue-staticvalue): String ``` ## Properties `StaticValue` A static string value used for filtering. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetStringListFilterCondition A filter condition that includes or excludes string values from a specified list. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Operator](#cfn-quicksight-dataset-datasetstringlistfiltercondition-operator)" : String, "[Values](#cfn-quicksight-dataset-datasetstringlistfiltercondition-values)" : DataSetStringListFilterValue } ``` ### YAML ``` [Operator](#cfn-quicksight-dataset-datasetstringlistfiltercondition-operator): String [Values](#cfn-quicksight-dataset-datasetstringlistfiltercondition-values): DataSetStringListFilterValue ``` ## Properties `Operator` The list operator to use, either `INCLUDE` to match values in the list or `EXCLUDE` to filter out values in the list. *Required*: Yes *Type*: String *Allowed values*: `INCLUDE | EXCLUDE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Values` The list of string values to include or exclude in the filter. *Required*: No *Type*: [DataSetStringListFilterValue](aws-properties-quicksight-dataset-datasetstringlistfiltervalue.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetStringListFilterValue Represents a list of string values used in filter conditions. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[StaticValues](#cfn-quicksight-dataset-datasetstringlistfiltervalue-staticvalues)" : [ String, ... ] } ``` ### YAML ``` [StaticValues](#cfn-quicksight-dataset-datasetstringlistfiltervalue-staticvalues): - String ``` ## Properties `StaticValues` A list of static string values used for filtering. *Required*: No *Type*: Array of String *Minimum*: `0 | 0` *Maximum*: `512 | 1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DataSetUsageConfiguration The usage configuration to apply to child datasets that reference this dataset as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DisableUseAsDirectQuerySource](#cfn-quicksight-dataset-datasetusageconfiguration-disableuseasdirectquerysource)" : Boolean, "[DisableUseAsImportedSource](#cfn-quicksight-dataset-datasetusageconfiguration-disableuseasimportedsource)" : Boolean } ``` ### YAML ``` [DisableUseAsDirectQuerySource](#cfn-quicksight-dataset-datasetusageconfiguration-disableuseasdirectquerysource): Boolean [DisableUseAsImportedSource](#cfn-quicksight-dataset-datasetusageconfiguration-disableuseasimportedsource): Boolean ``` ## Properties `DisableUseAsDirectQuerySource` An option that controls whether a child dataset of a direct query can use this dataset as a source. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisableUseAsImportedSource` An option that controls whether a child dataset that's stored in Quick Sight can use this dataset as a source. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DateTimeDatasetParameter A date time parameter that is created in the dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DefaultValues](#cfn-quicksight-dataset-datetimedatasetparameter-defaultvalues)" : DateTimeDatasetParameterDefaultValues, "[Id](#cfn-quicksight-dataset-datetimedatasetparameter-id)" : String, "[Name](#cfn-quicksight-dataset-datetimedatasetparameter-name)" : String, "[TimeGranularity](#cfn-quicksight-dataset-datetimedatasetparameter-timegranularity)" : String, "[ValueType](#cfn-quicksight-dataset-datetimedatasetparameter-valuetype)" : String } ``` ### YAML ``` [DefaultValues](#cfn-quicksight-dataset-datetimedatasetparameter-defaultvalues): DateTimeDatasetParameterDefaultValues [Id](#cfn-quicksight-dataset-datetimedatasetparameter-id): String [Name](#cfn-quicksight-dataset-datetimedatasetparameter-name): String [TimeGranularity](#cfn-quicksight-dataset-datetimedatasetparameter-timegranularity): String [ValueType](#cfn-quicksight-dataset-datetimedatasetparameter-valuetype): String ``` ## Properties `DefaultValues` A list of default values for a given date time parameter. This structure only accepts static values. *Required*: No *Type*: [DateTimeDatasetParameterDefaultValues](aws-properties-quicksight-dataset-datetimedatasetparameterdefaultvalues.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Id` An identifier for the parameter that is created in the dataset. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9-]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the date time parameter that is created in the dataset. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9]+$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeGranularity` The time granularity of the date time parameter. *Required*: No *Type*: String *Allowed values*: `YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECOND` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueType` The value type of the dataset parameter. Valid values are `single value` or `multi value`. *Required*: Yes *Type*: String *Allowed values*: `MULTI_VALUED | SINGLE_VALUED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DateTimeDatasetParameterDefaultValues The `DateTimeDatasetParameterDefaultValues` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](aws-resource-quicksight-dataset.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[StaticValues](#cfn-quicksight-dataset-datetimedatasetparameterdefaultvalues-staticvalues)" : [ String, ... ] } ``` ### YAML ``` [StaticValues](#cfn-quicksight-dataset-datetimedatasetparameterdefaultvalues-staticvalues): - String ``` ## Properties `StaticValues` A list of static default values for a given date time parameter. The valid format for this property is `yyyy-MM-dd’T’HH:mm:ss’Z’`. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DecimalDatasetParameter A decimal parameter that is created in the dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DefaultValues](#cfn-quicksight-dataset-decimaldatasetparameter-defaultvalues)" : DecimalDatasetParameterDefaultValues, "[Id](#cfn-quicksight-dataset-decimaldatasetparameter-id)" : String, "[Name](#cfn-quicksight-dataset-decimaldatasetparameter-name)" : String, "[ValueType](#cfn-quicksight-dataset-decimaldatasetparameter-valuetype)" : String } ``` ### YAML ``` [DefaultValues](#cfn-quicksight-dataset-decimaldatasetparameter-defaultvalues): DecimalDatasetParameterDefaultValues [Id](#cfn-quicksight-dataset-decimaldatasetparameter-id): String [Name](#cfn-quicksight-dataset-decimaldatasetparameter-name): String [ValueType](#cfn-quicksight-dataset-decimaldatasetparameter-valuetype): String ``` ## Properties `DefaultValues` A list of default values for a given decimal parameter. This structure only accepts static values. *Required*: No *Type*: [DecimalDatasetParameterDefaultValues](aws-properties-quicksight-dataset-decimaldatasetparameterdefaultvalues.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Id` An identifier for the decimal parameter created in the dataset. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9-]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the decimal parameter that is created in the dataset. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9]+$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueType` The value type of the dataset parameter. Valid values are `single value` or `multi value`. *Required*: Yes *Type*: String *Allowed values*: `MULTI_VALUED | SINGLE_VALUED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DecimalDatasetParameterDefaultValues A list of default values for a given decimal parameter. This structure only accepts static values. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[StaticValues](#cfn-quicksight-dataset-decimaldatasetparameterdefaultvalues-staticvalues)" : [ Number, ... ] } ``` ### YAML ``` [StaticValues](#cfn-quicksight-dataset-decimaldatasetparameterdefaultvalues-staticvalues): - Number ``` ## Properties `StaticValues` A list of static default values for a given decimal parameter. *Required*: No *Type*: Array of Number *Minimum*: `0` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DestinationTable Defines a destination table in data preparation that receives the final transformed data. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-destinationtable-alias)" : String, "[Source](#cfn-quicksight-dataset-destinationtable-source)" : DestinationTableSource } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-destinationtable-alias): String [Source](#cfn-quicksight-dataset-destinationtable-source): DestinationTableSource ``` ## Properties `Alias` Alias for the destination table. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The source configuration that specifies which transform operation provides data to this destination table. *Required*: Yes *Type*: [DestinationTableSource](aws-properties-quicksight-dataset-destinationtablesource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet DestinationTableSource Specifies the source of data for a destination table, including the transform operation and column mappings. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TransformOperationId](#cfn-quicksight-dataset-destinationtablesource-transformoperationid)" : String } ``` ### YAML ``` [TransformOperationId](#cfn-quicksight-dataset-destinationtablesource-transformoperationid): String ``` ## Properties `TransformOperationId` The identifier of the transform operation that provides data to the destination table. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z-]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet FieldFolder A FieldFolder element is a folder that contains fields and nested subfolders. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Columns](#cfn-quicksight-dataset-fieldfolder-columns)" : [ String, ... ], "[Description](#cfn-quicksight-dataset-fieldfolder-description)" : String } ``` ### YAML ``` [Columns](#cfn-quicksight-dataset-fieldfolder-columns): - String [Description](#cfn-quicksight-dataset-fieldfolder-description): String ``` ## Properties `Columns` A folder has a list of columns. A column can only be in one folder. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `5000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description for a field folder. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `500` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet FilterOperation A transform operation that filters rows based on a condition. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConditionExpression](#cfn-quicksight-dataset-filteroperation-conditionexpression)" : String, "[DateFilterCondition](#cfn-quicksight-dataset-filteroperation-datefiltercondition)" : DataSetDateFilterCondition, "[NumericFilterCondition](#cfn-quicksight-dataset-filteroperation-numericfiltercondition)" : DataSetNumericFilterCondition, "[StringFilterCondition](#cfn-quicksight-dataset-filteroperation-stringfiltercondition)" : DataSetStringFilterCondition } ``` ### YAML ``` [ConditionExpression](#cfn-quicksight-dataset-filteroperation-conditionexpression): String [DateFilterCondition](#cfn-quicksight-dataset-filteroperation-datefiltercondition): DataSetDateFilterCondition [NumericFilterCondition](#cfn-quicksight-dataset-filteroperation-numericfiltercondition): DataSetNumericFilterCondition [StringFilterCondition](#cfn-quicksight-dataset-filteroperation-stringfiltercondition): DataSetStringFilterCondition ``` ## Properties `ConditionExpression` An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DateFilterCondition` A date-based filter condition within a filter operation. *Required*: No *Type*: [DataSetDateFilterCondition](aws-properties-quicksight-dataset-datasetdatefiltercondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NumericFilterCondition` A numeric-based filter condition within a filter operation. *Required*: No *Type*: [DataSetNumericFilterCondition](aws-properties-quicksight-dataset-datasetnumericfiltercondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StringFilterCondition` A string-based filter condition within a filter operation. *Required*: No *Type*: [DataSetStringFilterCondition](aws-properties-quicksight-dataset-datasetstringfiltercondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet FiltersOperation A transform operation that applies one or more filter conditions. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-filtersoperation-alias)" : String, "[FilterOperations](#cfn-quicksight-dataset-filtersoperation-filteroperations)" : [ FilterOperation, ... ], "[Source](#cfn-quicksight-dataset-filtersoperation-source)" : TransformOperationSource } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-filtersoperation-alias): String [FilterOperations](#cfn-quicksight-dataset-filtersoperation-filteroperations): - FilterOperation [Source](#cfn-quicksight-dataset-filtersoperation-source): TransformOperationSource ``` ## Properties `Alias` Alias for this operation. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FilterOperations` The list of filter operations to apply. *Required*: Yes *Type*: Array of [FilterOperation](aws-properties-quicksight-dataset-filteroperation.md) *Minimum*: `0` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The source transform operation that provides input data for filtering. *Required*: Yes *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet GeoSpatialColumnGroup Geospatial column group that denotes a hierarchy. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Columns](#cfn-quicksight-dataset-geospatialcolumngroup-columns)" : [ String, ... ], "[CountryCode](#cfn-quicksight-dataset-geospatialcolumngroup-countrycode)" : String, "[Name](#cfn-quicksight-dataset-geospatialcolumngroup-name)" : String } ``` ### YAML ``` [Columns](#cfn-quicksight-dataset-geospatialcolumngroup-columns): - String [CountryCode](#cfn-quicksight-dataset-geospatialcolumngroup-countrycode): String [Name](#cfn-quicksight-dataset-geospatialcolumngroup-name): String ``` ## Properties `Columns` Columns in this hierarchy. *Required*: Yes *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `127 | 16` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CountryCode` Country code. *Required*: No *Type*: String *Allowed values*: `US` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` A display name for the hierarchy. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ImportTableOperation A transform operation that imports data from a source table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-importtableoperation-alias)" : String, "[Source](#cfn-quicksight-dataset-importtableoperation-source)" : ImportTableOperationSource } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-importtableoperation-alias): String [Source](#cfn-quicksight-dataset-importtableoperation-source): ImportTableOperationSource ``` ## Properties `Alias` Alias for this operation. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The source configuration that specifies which source table to import and any column mappings. *Required*: Yes *Type*: [ImportTableOperationSource](aws-properties-quicksight-dataset-importtableoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ImportTableOperationSource Specifies the source table and column mappings for an import table operation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnIdMappings](#cfn-quicksight-dataset-importtableoperationsource-columnidmappings)" : [ DataSetColumnIdMapping, ... ], "[SourceTableId](#cfn-quicksight-dataset-importtableoperationsource-sourcetableid)" : String } ``` ### YAML ``` [ColumnIdMappings](#cfn-quicksight-dataset-importtableoperationsource-columnidmappings): - DataSetColumnIdMapping [SourceTableId](#cfn-quicksight-dataset-importtableoperationsource-sourcetableid): String ``` ## Properties `ColumnIdMappings` The mappings between source column identifiers and target column identifiers during the import. *Required*: No *Type*: Array of [DataSetColumnIdMapping](aws-properties-quicksight-dataset-datasetcolumnidmapping.md) *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceTableId` The identifier of the source table to import data from. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z-]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet IncrementalRefresh The incremental refresh configuration for a dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LookbackWindow](#cfn-quicksight-dataset-incrementalrefresh-lookbackwindow)" : LookbackWindow } ``` ### YAML ``` [LookbackWindow](#cfn-quicksight-dataset-incrementalrefresh-lookbackwindow): LookbackWindow ``` ## Properties `LookbackWindow` The lookback window setup for an incremental refresh configuration. *Required*: Yes *Type*: [LookbackWindow](aws-properties-quicksight-dataset-lookbackwindow.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet IngestionWaitPolicy 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IngestionWaitTimeInHours](#cfn-quicksight-dataset-ingestionwaitpolicy-ingestionwaittimeinhours)" : Number, "[WaitForSpiceIngestion](#cfn-quicksight-dataset-ingestionwaitpolicy-waitforspiceingestion)" : Boolean } ``` ### YAML ``` [IngestionWaitTimeInHours](#cfn-quicksight-dataset-ingestionwaitpolicy-ingestionwaittimeinhours): Number [WaitForSpiceIngestion](#cfn-quicksight-dataset-ingestionwaitpolicy-waitforspiceingestion): Boolean ``` ## Properties `IngestionWaitTimeInHours` 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. *Required*: No *Type*: Number *Minimum*: `1` *Maximum*: `36` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WaitForSpiceIngestion` 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. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet InputColumn Metadata for a column that is used as the input of a transform operation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Id](#cfn-quicksight-dataset-inputcolumn-id)" : String, "[Name](#cfn-quicksight-dataset-inputcolumn-name)" : String, "[SubType](#cfn-quicksight-dataset-inputcolumn-subtype)" : String, "[Type](#cfn-quicksight-dataset-inputcolumn-type)" : String } ``` ### YAML ``` [Id](#cfn-quicksight-dataset-inputcolumn-id): String [Name](#cfn-quicksight-dataset-inputcolumn-name): String [SubType](#cfn-quicksight-dataset-inputcolumn-subtype): String [Type](#cfn-quicksight-dataset-inputcolumn-type): String ``` ## Properties `Id` A unique identifier for the input column. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of this column in the underlying data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SubType` The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset. *Required*: No *Type*: String *Allowed values*: `FLOAT | FIXED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The data type of the column. **Note:**`SEMISTRUCT` represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience. *Required*: Yes *Type*: String *Allowed values*: `STRING | INTEGER | DECIMAL | DATETIME | BIT | BOOLEAN | JSON | SEMISTRUCT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet IntegerDatasetParameter An integer parameter that is created in the dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DefaultValues](#cfn-quicksight-dataset-integerdatasetparameter-defaultvalues)" : IntegerDatasetParameterDefaultValues, "[Id](#cfn-quicksight-dataset-integerdatasetparameter-id)" : String, "[Name](#cfn-quicksight-dataset-integerdatasetparameter-name)" : String, "[ValueType](#cfn-quicksight-dataset-integerdatasetparameter-valuetype)" : String } ``` ### YAML ``` [DefaultValues](#cfn-quicksight-dataset-integerdatasetparameter-defaultvalues): IntegerDatasetParameterDefaultValues [Id](#cfn-quicksight-dataset-integerdatasetparameter-id): String [Name](#cfn-quicksight-dataset-integerdatasetparameter-name): String [ValueType](#cfn-quicksight-dataset-integerdatasetparameter-valuetype): String ``` ## Properties `DefaultValues` A list of default values for a given integer parameter. This structure only accepts static values. *Required*: No *Type*: [IntegerDatasetParameterDefaultValues](aws-properties-quicksight-dataset-integerdatasetparameterdefaultvalues.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Id` An identifier for the integer parameter created in the dataset. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9-]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the integer parameter that is created in the dataset. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9]+$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueType` The value type of the dataset parameter. Valid values are `single value` or `multi value`. *Required*: Yes *Type*: String *Allowed values*: `MULTI_VALUED | SINGLE_VALUED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet IntegerDatasetParameterDefaultValues A list of default values for a given integer parameter. This structure only accepts static values. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[StaticValues](#cfn-quicksight-dataset-integerdatasetparameterdefaultvalues-staticvalues)" : [ Integer, ... ] } ``` ### YAML ``` [StaticValues](#cfn-quicksight-dataset-integerdatasetparameterdefaultvalues-staticvalues): - Integer ``` ## Properties `StaticValues` A list of static default values for a given integer parameter. *Required*: No *Type*: Array of Integer *Minimum*: `0` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet JoinInstruction The instructions associated with a join. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LeftJoinKeyProperties](#cfn-quicksight-dataset-joininstruction-leftjoinkeyproperties)" : JoinKeyProperties, "[LeftOperand](#cfn-quicksight-dataset-joininstruction-leftoperand)" : String, "[OnClause](#cfn-quicksight-dataset-joininstruction-onclause)" : String, "[RightJoinKeyProperties](#cfn-quicksight-dataset-joininstruction-rightjoinkeyproperties)" : JoinKeyProperties, "[RightOperand](#cfn-quicksight-dataset-joininstruction-rightoperand)" : String, "[Type](#cfn-quicksight-dataset-joininstruction-type)" : String } ``` ### YAML ``` [LeftJoinKeyProperties](#cfn-quicksight-dataset-joininstruction-leftjoinkeyproperties): JoinKeyProperties [LeftOperand](#cfn-quicksight-dataset-joininstruction-leftoperand): String [OnClause](#cfn-quicksight-dataset-joininstruction-onclause): String [RightJoinKeyProperties](#cfn-quicksight-dataset-joininstruction-rightjoinkeyproperties): JoinKeyProperties [RightOperand](#cfn-quicksight-dataset-joininstruction-rightoperand): String [Type](#cfn-quicksight-dataset-joininstruction-type): String ``` ## Properties `LeftJoinKeyProperties` Join key properties of the left operand. *Required*: No *Type*: [JoinKeyProperties](aws-properties-quicksight-dataset-joinkeyproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LeftOperand` The operand on the left side of a join. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z-]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OnClause` The join instructions provided in the `ON` clause of a join. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RightJoinKeyProperties` Join key properties of the right operand. *Required*: No *Type*: [JoinKeyProperties](aws-properties-quicksight-dataset-joinkeyproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RightOperand` The operand on the right side of a join. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z-]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of join that it is. *Required*: Yes *Type*: String *Allowed values*: `INNER | OUTER | LEFT | RIGHT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet JoinKeyProperties Properties associated with the columns participating in a join. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[UniqueKey](#cfn-quicksight-dataset-joinkeyproperties-uniquekey)" : Boolean } ``` ### YAML ``` [UniqueKey](#cfn-quicksight-dataset-joinkeyproperties-uniquekey): Boolean ``` ## Properties `UniqueKey` A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Quick to optimize query performance. *Required*: No *Type*: [Boolean](aws-properties-quicksight-dataset-uniquekey.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet JoinOperandProperties Properties that control how columns are handled for a join operand, including column name overrides. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[OutputColumnNameOverrides](#cfn-quicksight-dataset-joinoperandproperties-outputcolumnnameoverrides)" : [ OutputColumnNameOverride, ... ] } ``` ### YAML ``` [OutputColumnNameOverrides](#cfn-quicksight-dataset-joinoperandproperties-outputcolumnnameoverrides): - OutputColumnNameOverride ``` ## Properties `OutputColumnNameOverrides` A list of column name overrides to apply to the join operand's output columns. *Required*: Yes *Type*: Array of [OutputColumnNameOverride](aws-properties-quicksight-dataset-outputcolumnnameoverride.md) *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet JoinOperation A transform operation that combines data from two sources based on specified join conditions. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-joinoperation-alias)" : String, "[LeftOperand](#cfn-quicksight-dataset-joinoperation-leftoperand)" : TransformOperationSource, "[LeftOperandProperties](#cfn-quicksight-dataset-joinoperation-leftoperandproperties)" : JoinOperandProperties, "[OnClause](#cfn-quicksight-dataset-joinoperation-onclause)" : String, "[RightOperand](#cfn-quicksight-dataset-joinoperation-rightoperand)" : TransformOperationSource, "[RightOperandProperties](#cfn-quicksight-dataset-joinoperation-rightoperandproperties)" : JoinOperandProperties, "[Type](#cfn-quicksight-dataset-joinoperation-type)" : String } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-joinoperation-alias): String [LeftOperand](#cfn-quicksight-dataset-joinoperation-leftoperand): TransformOperationSource [LeftOperandProperties](#cfn-quicksight-dataset-joinoperation-leftoperandproperties): JoinOperandProperties [OnClause](#cfn-quicksight-dataset-joinoperation-onclause): String [RightOperand](#cfn-quicksight-dataset-joinoperation-rightoperand): TransformOperationSource [RightOperandProperties](#cfn-quicksight-dataset-joinoperation-rightoperandproperties): JoinOperandProperties [Type](#cfn-quicksight-dataset-joinoperation-type): String ``` ## Properties `Alias` Alias for this operation. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LeftOperand` The left operand for the join operation. *Required*: Yes *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LeftOperandProperties` Properties that control how the left operand's columns are handled in the join result. *Required*: No *Type*: [JoinOperandProperties](aws-properties-quicksight-dataset-joinoperandproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OnClause` The join condition that specifies how to match rows between the left and right operands. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RightOperand` The right operand for the join operation. *Required*: Yes *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RightOperandProperties` Properties that control how the right operand's columns are handled in the join result. *Required*: No *Type*: [JoinOperandProperties](aws-properties-quicksight-dataset-joinoperandproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of join to perform, such as `INNER`, `LEFT`, `RIGHT`, or `OUTER`. *Required*: Yes *Type*: String *Allowed values*: `INNER | OUTER | LEFT | RIGHT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet LogicalTableSource 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataSetArn](#cfn-quicksight-dataset-logicaltablesource-datasetarn)" : String, "[JoinInstruction](#cfn-quicksight-dataset-logicaltablesource-joininstruction)" : JoinInstruction, "[PhysicalTableId](#cfn-quicksight-dataset-logicaltablesource-physicaltableid)" : String } ``` ### YAML ``` [DataSetArn](#cfn-quicksight-dataset-logicaltablesource-datasetarn): String [JoinInstruction](#cfn-quicksight-dataset-logicaltablesource-joininstruction): JoinInstruction [PhysicalTableId](#cfn-quicksight-dataset-logicaltablesource-physicaltableid): String ``` ## Properties `DataSetArn` The Amazon Resource Number (ARN) of the parent dataset. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JoinInstruction` Specifies the result of a join of two logical tables. *Required*: No *Type*: [JoinInstruction](aws-properties-quicksight-dataset-joininstruction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PhysicalTableId` Physical table ID. *Required*: No *Type*: String *Pattern*: `^[0-9a-zA-Z-]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet LookbackWindow The lookback window setup of an incremental refresh configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-lookbackwindow-columnname)" : String, "[Size](#cfn-quicksight-dataset-lookbackwindow-size)" : Number, "[SizeUnit](#cfn-quicksight-dataset-lookbackwindow-sizeunit)" : String } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-lookbackwindow-columnname): String [Size](#cfn-quicksight-dataset-lookbackwindow-size): Number [SizeUnit](#cfn-quicksight-dataset-lookbackwindow-sizeunit): String ``` ## Properties `ColumnName` The name of the lookback window column. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Size` The lookback window column size. *Required*: Yes *Type*: Number *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SizeUnit` The size unit that is used for the lookback window column. Valid values for this structure are `HOUR`, `DAY`, and `WEEK`. *Required*: Yes *Type*: String *Allowed values*: `HOUR | DAY | WEEK` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet NewDefaultValues The new default values for the parameter. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DateTimeStaticValues](#cfn-quicksight-dataset-newdefaultvalues-datetimestaticvalues)" : [ String, ... ], "[DecimalStaticValues](#cfn-quicksight-dataset-newdefaultvalues-decimalstaticvalues)" : [ Number, ... ], "[IntegerStaticValues](#cfn-quicksight-dataset-newdefaultvalues-integerstaticvalues)" : [ Integer, ... ], "[StringStaticValues](#cfn-quicksight-dataset-newdefaultvalues-stringstaticvalues)" : [ String, ... ] } ``` ### YAML ``` [DateTimeStaticValues](#cfn-quicksight-dataset-newdefaultvalues-datetimestaticvalues): - String [DecimalStaticValues](#cfn-quicksight-dataset-newdefaultvalues-decimalstaticvalues): - Number [IntegerStaticValues](#cfn-quicksight-dataset-newdefaultvalues-integerstaticvalues): - Integer [StringStaticValues](#cfn-quicksight-dataset-newdefaultvalues-stringstaticvalues): - String ``` ## Properties `DateTimeStaticValues` A list of static default values for a given date time parameter. The valid format for this property is `yyyy-MM-dd’T’HH:mm:ss’Z’`. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DecimalStaticValues` A list of static default values for a given decimal parameter. *Required*: No *Type*: Array of Number *Minimum*: `0` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IntegerStaticValues` A list of static default values for a given integer parameter. *Required*: No *Type*: Array of Integer *Minimum*: `0` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StringStaticValues` A list of static default values for a given string parameter. *Required*: No *Type*: Array of String *Minimum*: `0 | 0` *Maximum*: `512 | 32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet OutputColumn Output column. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-quicksight-dataset-outputcolumn-description)" : String, "[Id](#cfn-quicksight-dataset-outputcolumn-id)" : String, "[Name](#cfn-quicksight-dataset-outputcolumn-name)" : String, "[SubType](#cfn-quicksight-dataset-outputcolumn-subtype)" : String, "[Type](#cfn-quicksight-dataset-outputcolumn-type)" : String } ``` ### YAML ``` [Description](#cfn-quicksight-dataset-outputcolumn-description): String [Id](#cfn-quicksight-dataset-outputcolumn-id): String [Name](#cfn-quicksight-dataset-outputcolumn-name): String [SubType](#cfn-quicksight-dataset-outputcolumn-subtype): String [Type](#cfn-quicksight-dataset-outputcolumn-type): String ``` ## Properties `Description` A description for a column. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `500` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Id` A unique identifier for the output column. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The display name of the column.. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SubType` The sub data type of the column. *Required*: No *Type*: String *Allowed values*: `FLOAT | FIXED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The data type of the column. *Required*: No *Type*: String *Allowed values*: `STRING | INTEGER | DECIMAL | DATETIME` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet OutputColumnNameOverride Specifies a mapping to override the name of an output column from a transform operation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[OutputColumnName](#cfn-quicksight-dataset-outputcolumnnameoverride-outputcolumnname)" : String, "[SourceColumnName](#cfn-quicksight-dataset-outputcolumnnameoverride-sourcecolumnname)" : String } ``` ### YAML ``` [OutputColumnName](#cfn-quicksight-dataset-outputcolumnnameoverride-outputcolumnname): String [SourceColumnName](#cfn-quicksight-dataset-outputcolumnnameoverride-sourcecolumnname): String ``` ## Properties `OutputColumnName` The new name to assign to the column in the output. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceColumnName` The original name of the column from the source transform operation. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet OverrideDatasetParameterOperation A transform operation that overrides the dataset parameter values that are defined in another dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[NewDefaultValues](#cfn-quicksight-dataset-overridedatasetparameteroperation-newdefaultvalues)" : NewDefaultValues, "[NewParameterName](#cfn-quicksight-dataset-overridedatasetparameteroperation-newparametername)" : String, "[ParameterName](#cfn-quicksight-dataset-overridedatasetparameteroperation-parametername)" : String } ``` ### YAML ``` [NewDefaultValues](#cfn-quicksight-dataset-overridedatasetparameteroperation-newdefaultvalues): NewDefaultValues [NewParameterName](#cfn-quicksight-dataset-overridedatasetparameteroperation-newparametername): String [ParameterName](#cfn-quicksight-dataset-overridedatasetparameteroperation-parametername): String ``` ## Properties `NewDefaultValues` The new default values for the parameter. *Required*: No *Type*: [NewDefaultValues](aws-properties-quicksight-dataset-newdefaultvalues.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NewParameterName` The new name for the parameter. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9]+$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ParameterName` The name of the parameter to be overridden with different values. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9]+$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ParentDataSet References a parent dataset that serves as a data source, including its columns and metadata. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataSetArn](#cfn-quicksight-dataset-parentdataset-datasetarn)" : String, "[InputColumns](#cfn-quicksight-dataset-parentdataset-inputcolumns)" : [ InputColumn, ... ] } ``` ### YAML ``` [DataSetArn](#cfn-quicksight-dataset-parentdataset-datasetarn): String [InputColumns](#cfn-quicksight-dataset-parentdataset-inputcolumns): - InputColumn ``` ## Properties `DataSetArn` The Amazon Resource Name (ARN) of the parent dataset. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputColumns` The list of input columns available from the parent dataset. *Required*: Yes *Type*: Array of [InputColumn](aws-properties-quicksight-dataset-inputcolumn.md) *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet PerformanceConfiguration The `PerformanceConfiguration` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](aws-resource-quicksight-dataset.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[UniqueKeys](#cfn-quicksight-dataset-performanceconfiguration-uniquekeys)" : [ UniqueKey, ... ] } ``` ### YAML ``` [UniqueKeys](#cfn-quicksight-dataset-performanceconfiguration-uniquekeys): - UniqueKey ``` ## Properties `UniqueKeys` Property description not available. *Required*: No *Type*: Array of [UniqueKey](aws-properties-quicksight-dataset-uniquekey.md) *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet PhysicalTable 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomSql](#cfn-quicksight-dataset-physicaltable-customsql)" : CustomSql, "[RelationalTable](#cfn-quicksight-dataset-physicaltable-relationaltable)" : RelationalTable, "[S3Source](#cfn-quicksight-dataset-physicaltable-s3source)" : S3Source, "[SaaSTable](#cfn-quicksight-dataset-physicaltable-saastable)" : SaaSTable } ``` ### YAML ``` [CustomSql](#cfn-quicksight-dataset-physicaltable-customsql): CustomSql [RelationalTable](#cfn-quicksight-dataset-physicaltable-relationaltable): RelationalTable [S3Source](#cfn-quicksight-dataset-physicaltable-s3source): S3Source [SaaSTable](#cfn-quicksight-dataset-physicaltable-saastable): SaaSTable ``` ## Properties `CustomSql` A physical table type built from the results of the custom SQL query. *Required*: No *Type*: [CustomSql](aws-properties-quicksight-dataset-customsql.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RelationalTable` A physical table type for relational data sources. *Required*: No *Type*: [RelationalTable](aws-properties-quicksight-dataset-relationaltable.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3Source` A physical table type for as S3 data source. *Required*: No *Type*: [S3Source](aws-properties-quicksight-dataset-s3source.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SaaSTable` A physical table type for Software-as-a-Service (SaaS) sources. *Required*: No *Type*: [SaaSTable](aws-properties-quicksight-dataset-saastable.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet PivotConfiguration Configuration for a pivot operation, specifying which column contains labels and how to pivot them. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LabelColumnName](#cfn-quicksight-dataset-pivotconfiguration-labelcolumnname)" : String, "[PivotedLabels](#cfn-quicksight-dataset-pivotconfiguration-pivotedlabels)" : [ PivotedLabel, ... ] } ``` ### YAML ``` [LabelColumnName](#cfn-quicksight-dataset-pivotconfiguration-labelcolumnname): String [PivotedLabels](#cfn-quicksight-dataset-pivotconfiguration-pivotedlabels): - PivotedLabel ``` ## Properties `LabelColumnName` The name of the column that contains the labels to be pivoted into separate columns. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PivotedLabels` The list of specific label values to pivot into separate columns. *Required*: Yes *Type*: Array of [PivotedLabel](aws-properties-quicksight-dataset-pivotedlabel.md) *Minimum*: `0` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet PivotedLabel Specifies a label value to be pivoted into a separate column, including the new column name and identifier. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LabelName](#cfn-quicksight-dataset-pivotedlabel-labelname)" : String, "[NewColumnId](#cfn-quicksight-dataset-pivotedlabel-newcolumnid)" : String, "[NewColumnName](#cfn-quicksight-dataset-pivotedlabel-newcolumnname)" : String } ``` ### YAML ``` [LabelName](#cfn-quicksight-dataset-pivotedlabel-labelname): String [NewColumnId](#cfn-quicksight-dataset-pivotedlabel-newcolumnid): String [NewColumnName](#cfn-quicksight-dataset-pivotedlabel-newcolumnname): String ``` ## Properties `LabelName` The label value from the source data to be pivoted. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `2047` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NewColumnId` A unique identifier for the new column created from this pivoted label. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NewColumnName` The name for the new column created from this pivoted label. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet PivotOperation A transform operation that pivots data by converting row values into columns. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-pivotoperation-alias)" : String, "[GroupByColumnNames](#cfn-quicksight-dataset-pivotoperation-groupbycolumnnames)" : [ String, ... ], "[PivotConfiguration](#cfn-quicksight-dataset-pivotoperation-pivotconfiguration)" : PivotConfiguration, "[Source](#cfn-quicksight-dataset-pivotoperation-source)" : TransformOperationSource, "[ValueColumnConfiguration](#cfn-quicksight-dataset-pivotoperation-valuecolumnconfiguration)" : ValueColumnConfiguration } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-pivotoperation-alias): String [GroupByColumnNames](#cfn-quicksight-dataset-pivotoperation-groupbycolumnnames): - String [PivotConfiguration](#cfn-quicksight-dataset-pivotoperation-pivotconfiguration): PivotConfiguration [Source](#cfn-quicksight-dataset-pivotoperation-source): TransformOperationSource [ValueColumnConfiguration](#cfn-quicksight-dataset-pivotoperation-valuecolumnconfiguration): ValueColumnConfiguration ``` ## Properties `Alias` Alias for this operation. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GroupByColumnNames` The list of column names to group by when performing the pivot operation. *Required*: No *Type*: Array of String *Minimum*: `1 | 0` *Maximum*: `127 | 128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PivotConfiguration` Configuration that specifies which labels to pivot and how to structure the resulting columns. *Required*: Yes *Type*: [PivotConfiguration](aws-properties-quicksight-dataset-pivotconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The source transform operation that provides input data for pivoting. *Required*: Yes *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueColumnConfiguration` Configuration for how to aggregate values when multiple rows map to the same pivoted column. *Required*: Yes *Type*: [ValueColumnConfiguration](aws-properties-quicksight-dataset-valuecolumnconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ProjectOperation A transform operation that projects columns. Operations that come after a projection can only refer to projected columns. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-projectoperation-alias)" : String, "[ProjectedColumns](#cfn-quicksight-dataset-projectoperation-projectedcolumns)" : [ String, ... ], "[Source](#cfn-quicksight-dataset-projectoperation-source)" : TransformOperationSource } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-projectoperation-alias): String [ProjectedColumns](#cfn-quicksight-dataset-projectoperation-projectedcolumns): - String [Source](#cfn-quicksight-dataset-projectoperation-source): TransformOperationSource ``` ## Properties `Alias` Alias for this operation. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectedColumns` Projected columns. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The source transform operation that provides input data for column projection. *Required*: No *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet RefreshConfiguration The refresh configuration of a dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncrementalRefresh](#cfn-quicksight-dataset-refreshconfiguration-incrementalrefresh)" : IncrementalRefresh } ``` ### YAML ``` [IncrementalRefresh](#cfn-quicksight-dataset-refreshconfiguration-incrementalrefresh): IncrementalRefresh ``` ## Properties `IncrementalRefresh` The incremental refresh for the dataset. *Required*: Yes *Type*: [IncrementalRefresh](aws-properties-quicksight-dataset-incrementalrefresh.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet RefreshFailureConfiguration The failure configuration of a dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EmailAlert](#cfn-quicksight-dataset-refreshfailureconfiguration-emailalert)" : RefreshFailureEmailAlert } ``` ### YAML ``` [EmailAlert](#cfn-quicksight-dataset-refreshfailureconfiguration-emailalert): RefreshFailureEmailAlert ``` ## Properties `EmailAlert` The email alert configuration for a dataset refresh failure. *Required*: No *Type*: [RefreshFailureEmailAlert](aws-properties-quicksight-dataset-refreshfailureemailalert.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet RefreshFailureEmailAlert The configuration settings for the email alerts that are sent when a dataset refresh fails. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AlertStatus](#cfn-quicksight-dataset-refreshfailureemailalert-alertstatus)" : String } ``` ### YAML ``` [AlertStatus](#cfn-quicksight-dataset-refreshfailureemailalert-alertstatus): String ``` ## Properties `AlertStatus` The status value that determines if email alerts are sent. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet RelationalTable A physical table type for relational data sources. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Catalog](#cfn-quicksight-dataset-relationaltable-catalog)" : String, "[DataSourceArn](#cfn-quicksight-dataset-relationaltable-datasourcearn)" : String, "[InputColumns](#cfn-quicksight-dataset-relationaltable-inputcolumns)" : [ InputColumn, ... ], "[Name](#cfn-quicksight-dataset-relationaltable-name)" : String, "[Schema](#cfn-quicksight-dataset-relationaltable-schema)" : String } ``` ### YAML ``` [Catalog](#cfn-quicksight-dataset-relationaltable-catalog): String [DataSourceArn](#cfn-quicksight-dataset-relationaltable-datasourcearn): String [InputColumns](#cfn-quicksight-dataset-relationaltable-inputcolumns): - InputColumn [Name](#cfn-quicksight-dataset-relationaltable-name): String [Schema](#cfn-quicksight-dataset-relationaltable-schema): String ``` ## Properties `Catalog` The catalog associated with a table. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataSourceArn` The Amazon Resource Name (ARN) for the data source. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputColumns` The column schema of the table. *Required*: Yes *Type*: Array of [InputColumn](aws-properties-quicksight-dataset-inputcolumn.md) *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the relational table. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Schema` The schema name. This name applies to certain relational database engines. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet RenameColumnOperation A transform operation that renames a column. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-renamecolumnoperation-columnname)" : String, "[NewColumnName](#cfn-quicksight-dataset-renamecolumnoperation-newcolumnname)" : String } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-renamecolumnoperation-columnname): String [NewColumnName](#cfn-quicksight-dataset-renamecolumnoperation-newcolumnname): String ``` ## Properties `ColumnName` The name of the column to be renamed. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NewColumnName` The new name for the column. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet RenameColumnsOperation A transform operation that renames one or more columns in the dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-renamecolumnsoperation-alias)" : String, "[RenameColumnOperations](#cfn-quicksight-dataset-renamecolumnsoperation-renamecolumnoperations)" : [ RenameColumnOperation, ... ], "[Source](#cfn-quicksight-dataset-renamecolumnsoperation-source)" : TransformOperationSource } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-renamecolumnsoperation-alias): String [RenameColumnOperations](#cfn-quicksight-dataset-renamecolumnsoperation-renamecolumnoperations): - RenameColumnOperation [Source](#cfn-quicksight-dataset-renamecolumnsoperation-source): TransformOperationSource ``` ## Properties `Alias` Alias for this operation. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RenameColumnOperations` The list of column rename operations to perform, specifying old and new column names. *Required*: Yes *Type*: Array of [RenameColumnOperation](aws-properties-quicksight-dataset-renamecolumnoperation.md) *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The source transform operation that provides input data for column renaming. *Required*: Yes *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ResourcePermission Permission for the resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Actions](#cfn-quicksight-dataset-resourcepermission-actions)" : [ String, ... ], "[Principal](#cfn-quicksight-dataset-resourcepermission-principal)" : String } ``` ### YAML ``` [Actions](#cfn-quicksight-dataset-resourcepermission-actions): - String [Principal](#cfn-quicksight-dataset-resourcepermission-principal): String ``` ## Properties `Actions` The IAM action to grant or revoke permisions on *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Principal` The Amazon Resource Name (ARN) of the principal. This can be one of the following: + The ARN of an Amazon Quick user or group associated with a data source or dataset. (This is common.) + The ARN of an Amazon Quick user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) + The ARN of an AWS account root: This is an IAM ARN rather than a Quick ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.) *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet RowLevelPermissionConfiguration Configuration for row level security. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[RowLevelPermissionDataSet](#cfn-quicksight-dataset-rowlevelpermissionconfiguration-rowlevelpermissiondataset)" : RowLevelPermissionDataSet, "[TagConfiguration](#cfn-quicksight-dataset-rowlevelpermissionconfiguration-tagconfiguration)" : RowLevelPermissionTagConfiguration } ``` ### YAML ``` [RowLevelPermissionDataSet](#cfn-quicksight-dataset-rowlevelpermissionconfiguration-rowlevelpermissiondataset): RowLevelPermissionDataSet [TagConfiguration](#cfn-quicksight-dataset-rowlevelpermissionconfiguration-tagconfiguration): RowLevelPermissionTagConfiguration ``` ## Properties `RowLevelPermissionDataSet` Property description not available. *Required*: No *Type*: [RowLevelPermissionDataSet](aws-properties-quicksight-dataset-rowlevelpermissiondataset.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TagConfiguration` Property description not available. *Required*: No *Type*: [RowLevelPermissionTagConfiguration](aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet RowLevelPermissionDataSet 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](https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html) in the *Quick Sight User Guide*. The option to deny permissions by setting `PermissionPolicy` to `DENY_ACCESS` is not supported for new RLS datasets. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Arn](#cfn-quicksight-dataset-rowlevelpermissiondataset-arn)" : String, "[FormatVersion](#cfn-quicksight-dataset-rowlevelpermissiondataset-formatversion)" : String, "[Namespace](#cfn-quicksight-dataset-rowlevelpermissiondataset-namespace)" : String, "[PermissionPolicy](#cfn-quicksight-dataset-rowlevelpermissiondataset-permissionpolicy)" : String, "[Status](#cfn-quicksight-dataset-rowlevelpermissiondataset-status)" : String } ``` ### YAML ``` [Arn](#cfn-quicksight-dataset-rowlevelpermissiondataset-arn): String [FormatVersion](#cfn-quicksight-dataset-rowlevelpermissiondataset-formatversion): String [Namespace](#cfn-quicksight-dataset-rowlevelpermissiondataset-namespace): String [PermissionPolicy](#cfn-quicksight-dataset-rowlevelpermissiondataset-permissionpolicy): String [Status](#cfn-quicksight-dataset-rowlevelpermissiondataset-status): String ``` ## Properties `Arn` The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FormatVersion` 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. *Required*: No *Type*: String *Allowed values*: `VERSION_1 | VERSION_2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Namespace` The namespace associated with the dataset that contains permissions for RLS. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9._-]*$` *Minimum*: `0` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PermissionPolicy` The type of permissions to use when interpreting the permissions for RLS. `DENY_ACCESS` is included for backward compatibility only. *Required*: Yes *Type*: String *Allowed values*: `GRANT_ACCESS | DENY_ACCESS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Status` The status of the row-level security permission dataset. If enabled, the status is `ENABLED`. If disabled, the status is `DISABLED`. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet RowLevelPermissionTagConfiguration The element you can use to define tags for row-level security. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Status](#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-status)" : String, "[TagRuleConfigurations](#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-tagruleconfigurations)" : [ [ , ... ], ... ], "[TagRules](#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-tagrules)" : [ RowLevelPermissionTagRule, ... ] } ``` ### YAML ``` [Status](#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-status): String [TagRuleConfigurations](#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-tagruleconfigurations): - - [TagRules](#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration-tagrules): - RowLevelPermissionTagRule ``` ## Properties `Status` The status of row-level security tags. If enabled, the status is `ENABLED`. If disabled, the status is `DISABLED`. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TagRuleConfigurations` The configuration of tags on a dataset to set row-level security. *Required*: No *Type*: Array of Array *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TagRules` A set of rules associated with row-level security, such as the tag names and columns that they are assigned to. *Required*: Yes *Type*: Array of [RowLevelPermissionTagRule](aws-properties-quicksight-dataset-rowlevelpermissiontagrule.md) *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet RowLevelPermissionTagRule A set of rules associated with a tag. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-rowlevelpermissiontagrule-columnname)" : String, "[MatchAllValue](#cfn-quicksight-dataset-rowlevelpermissiontagrule-matchallvalue)" : String, "[TagKey](#cfn-quicksight-dataset-rowlevelpermissiontagrule-tagkey)" : String, "[TagMultiValueDelimiter](#cfn-quicksight-dataset-rowlevelpermissiontagrule-tagmultivaluedelimiter)" : String } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-rowlevelpermissiontagrule-columnname): String [MatchAllValue](#cfn-quicksight-dataset-rowlevelpermissiontagrule-matchallvalue): String [TagKey](#cfn-quicksight-dataset-rowlevelpermissiontagrule-tagkey): String [TagMultiValueDelimiter](#cfn-quicksight-dataset-rowlevelpermissiontagrule-tagmultivaluedelimiter): String ``` ## Properties `ColumnName` The column name that a tag key is assigned to. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MatchAllValue` A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TagKey` The unique key for a tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TagMultiValueDelimiter` A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet S3Source A physical table type for an S3 data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataSourceArn](#cfn-quicksight-dataset-s3source-datasourcearn)" : String, "[InputColumns](#cfn-quicksight-dataset-s3source-inputcolumns)" : [ InputColumn, ... ], "[UploadSettings](#cfn-quicksight-dataset-s3source-uploadsettings)" : UploadSettings } ``` ### YAML ``` [DataSourceArn](#cfn-quicksight-dataset-s3source-datasourcearn): String [InputColumns](#cfn-quicksight-dataset-s3source-inputcolumns): - InputColumn [UploadSettings](#cfn-quicksight-dataset-s3source-uploadsettings): UploadSettings ``` ## Properties `DataSourceArn` The Amazon Resource Name (ARN) for the data source. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputColumns` A physical table type for an S3 data source. For files that aren't JSON, only `STRING` data types are supported in input columns. *Required*: Yes *Type*: Array of [InputColumn](aws-properties-quicksight-dataset-inputcolumn.md) *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UploadSettings` Information about the format for the S3 source file or files. *Required*: No *Type*: [UploadSettings](aws-properties-quicksight-dataset-uploadsettings.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet SaaSTable A table from a Software-as-a-Service (SaaS) data source, including connection details and column definitions. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataSourceArn](#cfn-quicksight-dataset-saastable-datasourcearn)" : String, "[InputColumns](#cfn-quicksight-dataset-saastable-inputcolumns)" : [ InputColumn, ... ], "[TablePath](#cfn-quicksight-dataset-saastable-tablepath)" : [ TablePathElement, ... ] } ``` ### YAML ``` [DataSourceArn](#cfn-quicksight-dataset-saastable-datasourcearn): String [InputColumns](#cfn-quicksight-dataset-saastable-inputcolumns): - InputColumn [TablePath](#cfn-quicksight-dataset-saastable-tablepath): - TablePathElement ``` ## Properties `DataSourceArn` The Amazon Resource Name (ARN) of the SaaS data source. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputColumns` The list of input columns available from the SaaS table. *Required*: Yes *Type*: Array of [InputColumn](aws-properties-quicksight-dataset-inputcolumn.md) *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TablePath` The hierarchical path to the table within the SaaS data source. *Required*: Yes *Type*: Array of [TablePathElement](aws-properties-quicksight-dataset-tablepathelement.md) *Minimum*: `1` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet SemanticModelConfiguration Configuration for the semantic model that defines how prepared data is structured for analysis and reporting. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TableMap](#cfn-quicksight-dataset-semanticmodelconfiguration-tablemap)" : {Key: Value, ...} } ``` ### YAML ``` [TableMap](#cfn-quicksight-dataset-semanticmodelconfiguration-tablemap): Key: Value ``` ## Properties `TableMap` A map of semantic tables that define the analytical structure. *Required*: No *Type*: Object of [SemanticTable](aws-properties-quicksight-dataset-semantictable.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet SemanticTable A semantic table that represents the final analytical structure of the data. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-semantictable-alias)" : String, "[DestinationTableId](#cfn-quicksight-dataset-semantictable-destinationtableid)" : String, "[RowLevelPermissionConfiguration](#cfn-quicksight-dataset-semantictable-rowlevelpermissionconfiguration)" : RowLevelPermissionConfiguration } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-semantictable-alias): String [DestinationTableId](#cfn-quicksight-dataset-semantictable-destinationtableid): String [RowLevelPermissionConfiguration](#cfn-quicksight-dataset-semantictable-rowlevelpermissionconfiguration): RowLevelPermissionConfiguration ``` ## Properties `Alias` Alias for the semantic table. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DestinationTableId` The identifier of the destination table from data preparation that provides data to this semantic table. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z-]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RowLevelPermissionConfiguration` Configuration for row level security that control data access for this semantic table. *Required*: No *Type*: [RowLevelPermissionConfiguration](aws-properties-quicksight-dataset-rowlevelpermissionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet SourceTable A source table that provides initial data from either a physical table or parent dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataSet](#cfn-quicksight-dataset-sourcetable-dataset)" : ParentDataSet, "[PhysicalTableId](#cfn-quicksight-dataset-sourcetable-physicaltableid)" : String } ``` ### YAML ``` [DataSet](#cfn-quicksight-dataset-sourcetable-dataset): ParentDataSet [PhysicalTableId](#cfn-quicksight-dataset-sourcetable-physicaltableid): String ``` ## Properties `DataSet` A parent dataset that serves as the data source instead of a physical table. *Required*: No *Type*: [ParentDataSet](aws-properties-quicksight-dataset-parentdataset.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PhysicalTableId` The identifier of the physical table that serves as the data source. *Required*: No *Type*: String *Pattern*: `^[0-9a-zA-Z-]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet StringDatasetParameter A string parameter that is created in the dataset. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DefaultValues](#cfn-quicksight-dataset-stringdatasetparameter-defaultvalues)" : StringDatasetParameterDefaultValues, "[Id](#cfn-quicksight-dataset-stringdatasetparameter-id)" : String, "[Name](#cfn-quicksight-dataset-stringdatasetparameter-name)" : String, "[ValueType](#cfn-quicksight-dataset-stringdatasetparameter-valuetype)" : String } ``` ### YAML ``` [DefaultValues](#cfn-quicksight-dataset-stringdatasetparameter-defaultvalues): StringDatasetParameterDefaultValues [Id](#cfn-quicksight-dataset-stringdatasetparameter-id): String [Name](#cfn-quicksight-dataset-stringdatasetparameter-name): String [ValueType](#cfn-quicksight-dataset-stringdatasetparameter-valuetype): String ``` ## Properties `DefaultValues` A list of default values for a given string dataset parameter type. This structure only accepts static values. *Required*: No *Type*: [StringDatasetParameterDefaultValues](aws-properties-quicksight-dataset-stringdatasetparameterdefaultvalues.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Id` An identifier for the string parameter that is created in the dataset. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9-]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the string parameter that is created in the dataset. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9]+$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueType` The value type of the dataset parameter. Valid values are `single value` or `multi value`. *Required*: Yes *Type*: String *Allowed values*: `MULTI_VALUED | SINGLE_VALUED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet StringDatasetParameterDefaultValues A list of default values for a given string dataset parameter type. This structure only accepts static values. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[StaticValues](#cfn-quicksight-dataset-stringdatasetparameterdefaultvalues-staticvalues)" : [ String, ... ] } ``` ### YAML ``` [StaticValues](#cfn-quicksight-dataset-stringdatasetparameterdefaultvalues-staticvalues): - String ``` ## Properties `StaticValues` A list of static default values for a given string parameter. *Required*: No *Type*: Array of String *Minimum*: `0 | 0` *Maximum*: `512 | 32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet TablePathElement An element in the hierarchical path to a table within a data source, containing both name and identifier. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Id](#cfn-quicksight-dataset-tablepathelement-id)" : String, "[Name](#cfn-quicksight-dataset-tablepathelement-name)" : String } ``` ### YAML ``` [Id](#cfn-quicksight-dataset-tablepathelement-id): String [Name](#cfn-quicksight-dataset-tablepathelement-name): String ``` ## Properties `Id` The unique identifier of the path element. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the path element. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet Tag The `Tag` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](aws-resource-quicksight-dataset.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-quicksight-dataset-tag-key)" : String, "[Value](#cfn-quicksight-dataset-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-quicksight-dataset-tag-key): String [Value](#cfn-quicksight-dataset-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet TagColumnOperation A transform operation that tags a column with additional information. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-tagcolumnoperation-columnname)" : String, "[Tags](#cfn-quicksight-dataset-tagcolumnoperation-tags)" : [ ColumnTag, ... ] } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-tagcolumnoperation-columnname): String [Tags](#cfn-quicksight-dataset-tagcolumnoperation-tags): - ColumnTag ``` ## Properties `ColumnName` The column that this operation acts on. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` The dataset column tag, currently only used for geospatial type tagging. This is not tags for the AWS tagging feature. *Required*: Yes *Type*: Array of [ColumnTag](aws-properties-quicksight-dataset-columntag.md) *Minimum*: `1` *Maximum*: `16` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet TransformOperation 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CastColumnTypeOperation](#cfn-quicksight-dataset-transformoperation-castcolumntypeoperation)" : CastColumnTypeOperation, "[CreateColumnsOperation](#cfn-quicksight-dataset-transformoperation-createcolumnsoperation)" : CreateColumnsOperation, "[FilterOperation](#cfn-quicksight-dataset-transformoperation-filteroperation)" : FilterOperation, "[OverrideDatasetParameterOperation](#cfn-quicksight-dataset-transformoperation-overridedatasetparameteroperation)" : OverrideDatasetParameterOperation, "[ProjectOperation](#cfn-quicksight-dataset-transformoperation-projectoperation)" : ProjectOperation, "[RenameColumnOperation](#cfn-quicksight-dataset-transformoperation-renamecolumnoperation)" : RenameColumnOperation, "[TagColumnOperation](#cfn-quicksight-dataset-transformoperation-tagcolumnoperation)" : TagColumnOperation, "[UntagColumnOperation](#cfn-quicksight-dataset-transformoperation-untagcolumnoperation)" : UntagColumnOperation } ``` ### YAML ``` [CastColumnTypeOperation](#cfn-quicksight-dataset-transformoperation-castcolumntypeoperation): CastColumnTypeOperation [CreateColumnsOperation](#cfn-quicksight-dataset-transformoperation-createcolumnsoperation): CreateColumnsOperation [FilterOperation](#cfn-quicksight-dataset-transformoperation-filteroperation): FilterOperation [OverrideDatasetParameterOperation](#cfn-quicksight-dataset-transformoperation-overridedatasetparameteroperation): OverrideDatasetParameterOperation [ProjectOperation](#cfn-quicksight-dataset-transformoperation-projectoperation): ProjectOperation [RenameColumnOperation](#cfn-quicksight-dataset-transformoperation-renamecolumnoperation): RenameColumnOperation [TagColumnOperation](#cfn-quicksight-dataset-transformoperation-tagcolumnoperation): TagColumnOperation [UntagColumnOperation](#cfn-quicksight-dataset-transformoperation-untagcolumnoperation): UntagColumnOperation ``` ## Properties `CastColumnTypeOperation` A transform operation that casts a column to a different type. *Required*: No *Type*: [CastColumnTypeOperation](aws-properties-quicksight-dataset-castcolumntypeoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CreateColumnsOperation` An operation that creates calculated columns. Columns created in one such operation form a lexical closure. *Required*: No *Type*: [CreateColumnsOperation](aws-properties-quicksight-dataset-createcolumnsoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FilterOperation` An operation that filters rows based on some condition. *Required*: No *Type*: [FilterOperation](aws-properties-quicksight-dataset-filteroperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OverrideDatasetParameterOperation` A transform operation that overrides the dataset parameter values that are defined in another dataset. *Required*: No *Type*: [OverrideDatasetParameterOperation](aws-properties-quicksight-dataset-overridedatasetparameteroperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectOperation` An operation that projects columns. Operations that come after a projection can only refer to projected columns. *Required*: No *Type*: [ProjectOperation](aws-properties-quicksight-dataset-projectoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RenameColumnOperation` An operation that renames a column. *Required*: No *Type*: [RenameColumnOperation](aws-properties-quicksight-dataset-renamecolumnoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TagColumnOperation` An operation that tags a column with additional information. *Required*: No *Type*: [TagColumnOperation](aws-properties-quicksight-dataset-tagcolumnoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UntagColumnOperation` Property description not available. *Required*: No *Type*: [UntagColumnOperation](aws-properties-quicksight-dataset-untagcolumnoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet TransformOperationSource Specifies the source of data for a transform operation, including the source operation and column mappings. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnIdMappings](#cfn-quicksight-dataset-transformoperationsource-columnidmappings)" : [ DataSetColumnIdMapping, ... ], "[TransformOperationId](#cfn-quicksight-dataset-transformoperationsource-transformoperationid)" : String } ``` ### YAML ``` [ColumnIdMappings](#cfn-quicksight-dataset-transformoperationsource-columnidmappings): - DataSetColumnIdMapping [TransformOperationId](#cfn-quicksight-dataset-transformoperationsource-transformoperationid): String ``` ## Properties `ColumnIdMappings` The mappings between source column identifiers and target column identifiers for this transformation. *Required*: No *Type*: Array of [DataSetColumnIdMapping](aws-properties-quicksight-dataset-datasetcolumnidmapping.md) *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TransformOperationId` The identifier of the transform operation that provides input data. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z-]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet TransformStep A step in data preparation that performs a specific operation on the data. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AggregateStep](#cfn-quicksight-dataset-transformstep-aggregatestep)" : AggregateOperation, "[AppendStep](#cfn-quicksight-dataset-transformstep-appendstep)" : AppendOperation, "[CastColumnTypesStep](#cfn-quicksight-dataset-transformstep-castcolumntypesstep)" : CastColumnTypesOperation, "[CreateColumnsStep](#cfn-quicksight-dataset-transformstep-createcolumnsstep)" : CreateColumnsOperation, "[FiltersStep](#cfn-quicksight-dataset-transformstep-filtersstep)" : FiltersOperation, "[ImportTableStep](#cfn-quicksight-dataset-transformstep-importtablestep)" : ImportTableOperation, "[JoinStep](#cfn-quicksight-dataset-transformstep-joinstep)" : JoinOperation, "[PivotStep](#cfn-quicksight-dataset-transformstep-pivotstep)" : PivotOperation, "[ProjectStep](#cfn-quicksight-dataset-transformstep-projectstep)" : ProjectOperation, "[RenameColumnsStep](#cfn-quicksight-dataset-transformstep-renamecolumnsstep)" : RenameColumnsOperation, "[UnpivotStep](#cfn-quicksight-dataset-transformstep-unpivotstep)" : UnpivotOperation } ``` ### YAML ``` [AggregateStep](#cfn-quicksight-dataset-transformstep-aggregatestep): AggregateOperation [AppendStep](#cfn-quicksight-dataset-transformstep-appendstep): AppendOperation [CastColumnTypesStep](#cfn-quicksight-dataset-transformstep-castcolumntypesstep): CastColumnTypesOperation [CreateColumnsStep](#cfn-quicksight-dataset-transformstep-createcolumnsstep): CreateColumnsOperation [FiltersStep](#cfn-quicksight-dataset-transformstep-filtersstep): FiltersOperation [ImportTableStep](#cfn-quicksight-dataset-transformstep-importtablestep): ImportTableOperation [JoinStep](#cfn-quicksight-dataset-transformstep-joinstep): JoinOperation [PivotStep](#cfn-quicksight-dataset-transformstep-pivotstep): PivotOperation [ProjectStep](#cfn-quicksight-dataset-transformstep-projectstep): ProjectOperation [RenameColumnsStep](#cfn-quicksight-dataset-transformstep-renamecolumnsstep): RenameColumnsOperation [UnpivotStep](#cfn-quicksight-dataset-transformstep-unpivotstep): UnpivotOperation ``` ## Properties `AggregateStep` A transform step that groups data and applies aggregation functions to calculate summary values. *Required*: No *Type*: [AggregateOperation](aws-properties-quicksight-dataset-aggregateoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AppendStep` A transform step that combines rows from multiple sources by stacking them vertically. *Required*: No *Type*: [AppendOperation](aws-properties-quicksight-dataset-appendoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CastColumnTypesStep` A transform step that changes the data types of one or more columns. *Required*: No *Type*: [CastColumnTypesOperation](aws-properties-quicksight-dataset-castcolumntypesoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CreateColumnsStep` Property description not available. *Required*: No *Type*: [CreateColumnsOperation](aws-properties-quicksight-dataset-createcolumnsoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FiltersStep` A transform step that applies filter conditions. *Required*: No *Type*: [FiltersOperation](aws-properties-quicksight-dataset-filtersoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ImportTableStep` A transform step that brings data from a source table. *Required*: No *Type*: [ImportTableOperation](aws-properties-quicksight-dataset-importtableoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JoinStep` A transform step that combines data from two sources based on specified join conditions. *Required*: No *Type*: [JoinOperation](aws-properties-quicksight-dataset-joinoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PivotStep` A transform step that converts row values into columns to reshape the data structure. *Required*: No *Type*: [PivotOperation](aws-properties-quicksight-dataset-pivotoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectStep` Property description not available. *Required*: No *Type*: [ProjectOperation](aws-properties-quicksight-dataset-projectoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RenameColumnsStep` A transform step that changes the names of one or more columns. *Required*: No *Type*: [RenameColumnsOperation](aws-properties-quicksight-dataset-renamecolumnsoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UnpivotStep` A transform step that converts columns into rows to normalize the data structure. *Required*: No *Type*: [UnpivotOperation](aws-properties-quicksight-dataset-unpivotoperation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet UniqueKey The `UniqueKey` property type specifies Property description not available. for an [AWS::QuickSight::DataSet](aws-resource-quicksight-dataset.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnNames](#cfn-quicksight-dataset-uniquekey-columnnames)" : [ String, ... ] } ``` ### YAML ``` [ColumnNames](#cfn-quicksight-dataset-uniquekey-columnnames): - String ``` ## Properties `ColumnNames` Property description not available. *Required*: Yes *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `127 | 1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet UnpivotOperation A transform operation that converts columns into rows, normalizing the data structure. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Alias](#cfn-quicksight-dataset-unpivotoperation-alias)" : String, "[ColumnsToUnpivot](#cfn-quicksight-dataset-unpivotoperation-columnstounpivot)" : [ ColumnToUnpivot, ... ], "[Source](#cfn-quicksight-dataset-unpivotoperation-source)" : TransformOperationSource, "[UnpivotedLabelColumnId](#cfn-quicksight-dataset-unpivotoperation-unpivotedlabelcolumnid)" : String, "[UnpivotedLabelColumnName](#cfn-quicksight-dataset-unpivotoperation-unpivotedlabelcolumnname)" : String, "[UnpivotedValueColumnId](#cfn-quicksight-dataset-unpivotoperation-unpivotedvaluecolumnid)" : String, "[UnpivotedValueColumnName](#cfn-quicksight-dataset-unpivotoperation-unpivotedvaluecolumnname)" : String } ``` ### YAML ``` [Alias](#cfn-quicksight-dataset-unpivotoperation-alias): String [ColumnsToUnpivot](#cfn-quicksight-dataset-unpivotoperation-columnstounpivot): - ColumnToUnpivot [Source](#cfn-quicksight-dataset-unpivotoperation-source): TransformOperationSource [UnpivotedLabelColumnId](#cfn-quicksight-dataset-unpivotoperation-unpivotedlabelcolumnid): String [UnpivotedLabelColumnName](#cfn-quicksight-dataset-unpivotoperation-unpivotedlabelcolumnname): String [UnpivotedValueColumnId](#cfn-quicksight-dataset-unpivotoperation-unpivotedvaluecolumnid): String [UnpivotedValueColumnName](#cfn-quicksight-dataset-unpivotoperation-unpivotedvaluecolumnname): String ``` ## Properties `Alias` Alias for this operation. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ColumnsToUnpivot` The list of columns to unpivot from the source data. *Required*: Yes *Type*: Array of [ColumnToUnpivot](aws-properties-quicksight-dataset-columntounpivot.md) *Minimum*: `0` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The source transform operation that provides input data for unpivoting. *Required*: Yes *Type*: [TransformOperationSource](aws-properties-quicksight-dataset-transformoperationsource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UnpivotedLabelColumnId` A unique identifier for the new column that will contain the unpivoted column names. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UnpivotedLabelColumnName` The name for the new column that will contain the unpivoted column names. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UnpivotedValueColumnId` A unique identifier for the new column that will contain the unpivoted values. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UnpivotedValueColumnName` The name for the new column that will contain the unpivoted values. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet UntagColumnOperation A transform operation that removes tags associated with a column. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ColumnName](#cfn-quicksight-dataset-untagcolumnoperation-columnname)" : String, "[TagNames](#cfn-quicksight-dataset-untagcolumnoperation-tagnames)" : [ String, ... ] } ``` ### YAML ``` [ColumnName](#cfn-quicksight-dataset-untagcolumnoperation-columnname): String [TagNames](#cfn-quicksight-dataset-untagcolumnoperation-tagnames): - String ``` ## Properties `ColumnName` The column that this operation acts on. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TagNames` The column tags to remove from this column. *Required*: Yes *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet UploadSettings Information about the format for a source file or files. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ContainsHeader](#cfn-quicksight-dataset-uploadsettings-containsheader)" : Boolean, "[Delimiter](#cfn-quicksight-dataset-uploadsettings-delimiter)" : String, "[Format](#cfn-quicksight-dataset-uploadsettings-format)" : String, "[StartFromRow](#cfn-quicksight-dataset-uploadsettings-startfromrow)" : Number, "[TextQualifier](#cfn-quicksight-dataset-uploadsettings-textqualifier)" : String } ``` ### YAML ``` [ContainsHeader](#cfn-quicksight-dataset-uploadsettings-containsheader): Boolean [Delimiter](#cfn-quicksight-dataset-uploadsettings-delimiter): String [Format](#cfn-quicksight-dataset-uploadsettings-format): String [StartFromRow](#cfn-quicksight-dataset-uploadsettings-startfromrow): Number [TextQualifier](#cfn-quicksight-dataset-uploadsettings-textqualifier): String ``` ## Properties `ContainsHeader` Whether the file has a header row, or the files each have a header row. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Delimiter` The delimiter between values in the file. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Format` File format. *Required*: No *Type*: String *Allowed values*: `CSV | TSV | CLF | ELF | XLSX | JSON` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StartFromRow` A row number to start reading data from. *Required*: No *Type*: Number *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TextQualifier` Text qualifier. *Required*: No *Type*: String *Allowed values*: `DOUBLE_QUOTE | SINGLE_QUOTE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::QuickSight::DataSet ValueColumnConfiguration Configuration for how to handle value columns in pivot operations, including aggregation settings. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AggregationFunction](#cfn-quicksight-dataset-valuecolumnconfiguration-aggregationfunction)" : DataPrepAggregationFunction } ``` ### YAML ``` [AggregationFunction](#cfn-quicksight-dataset-valuecolumnconfiguration-aggregationfunction): DataPrepAggregationFunction ``` ## Properties `AggregationFunction` The aggregation function to apply when multiple values map to the same pivoted cell. *Required*: No *Type*: [DataPrepAggregationFunction](aws-properties-quicksight-dataset-dataprepaggregationfunction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)