--- # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "awscc_quicksight_data_set Resource - terraform-provider-awscc" subcategory: "" description: |- Definition of the AWS::QuickSight::DataSet Resource Type. --- # awscc_quicksight_data_set (Resource) Definition of the AWS::QuickSight::DataSet Resource Type. ## Schema ### Optional - `aws_account_id` (String) - `column_groups` (Attributes List)
Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
(see [below for nested schema](#nestedatt--column_groups)) - `column_level_permission_rules` (Attributes List) (see [below for nested schema](#nestedatt--column_level_permission_rules)) - `data_set_id` (String) - `field_folders` (Attributes Map) (see [below for nested schema](#nestedatt--field_folders)) - `import_mode` (String) - `ingestion_wait_policy` (Attributes)Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.
(see [below for nested schema](#nestedatt--ingestion_wait_policy)) - `logical_table_map` (Attributes Map) (see [below for nested schema](#nestedatt--logical_table_map)) - `name` (String)The display name for the dataset.
- `permissions` (Attributes List)A list of resource permissions on the dataset.
(see [below for nested schema](#nestedatt--permissions)) - `physical_table_map` (Attributes Map) (see [below for nested schema](#nestedatt--physical_table_map)) - `row_level_permission_data_set` (Attributes)The row-level security configuration for the dataset.
(see [below for nested schema](#nestedatt--row_level_permission_data_set)) - `tags` (Attributes List)Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
(see [below for nested schema](#nestedatt--tags)) ### Read-Only - `arn` (String)The Amazon Resource Name (ARN) of the resource.
- `consumed_spice_capacity_in_bytes` (Number)The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
- `created_time` (String)The time that this dataset was created.
- `id` (String) Uniquely identifies the resource. - `last_updated_time` (String)The last time that this dataset was updated.
- `output_columns` (Attributes List)The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
(see [below for nested schema](#nestedatt--output_columns)) ### Nested Schema for `column_groups` Optional: - `geo_spatial_column_group` (Attributes)Geospatial column group that denotes a hierarchy.
(see [below for nested schema](#nestedatt--column_groups--geo_spatial_column_group)) ### Nested Schema for `column_groups.geo_spatial_column_group` Optional: - `columns` (List of String)Columns in this hierarchy.
- `country_code` (String) - `name` (String)A display name for the hierarchy.
### Nested Schema for `column_level_permission_rules` Optional: - `column_names` (List of String) - `principals` (List of String) ### Nested Schema for `field_folders` Optional: - `columns` (List of String) - `description` (String) ### Nested Schema for `ingestion_wait_policy` Optional: - `ingestion_wait_time_in_hours` (Number)The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours. Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.
- `wait_for_spice_ingestion` (Boolean)Wait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true). Applicable only when DataSetImportMode mode is set to SPICE.
### Nested Schema for `logical_table_map` Optional: - `alias` (String)A display name for the logical table.
- `data_transforms` (Attributes List)Transform operations that act on this logical table.
(see [below for nested schema](#nestedatt--logical_table_map--data_transforms)) - `source` (Attributes)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.
(see [below for nested schema](#nestedatt--logical_table_map--source)) ### Nested Schema for `logical_table_map.data_transforms` Optional: - `cast_column_type_operation` (Attributes)A transform operation that casts a column to a different type.
(see [below for nested schema](#nestedatt--logical_table_map--data_transforms--cast_column_type_operation)) - `create_columns_operation` (Attributes)A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
(see [below for nested schema](#nestedatt--logical_table_map--data_transforms--create_columns_operation)) - `filter_operation` (Attributes)A transform operation that filters rows based on a condition.
(see [below for nested schema](#nestedatt--logical_table_map--data_transforms--filter_operation)) - `project_operation` (Attributes)A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.
(see [below for nested schema](#nestedatt--logical_table_map--data_transforms--project_operation)) - `rename_column_operation` (Attributes)A transform operation that renames a column.
(see [below for nested schema](#nestedatt--logical_table_map--data_transforms--rename_column_operation)) - `tag_column_operation` (Attributes)A transform operation that tags a column with additional information.
(see [below for nested schema](#nestedatt--logical_table_map--data_transforms--tag_column_operation)) ### Nested Schema for `logical_table_map.data_transforms.cast_column_type_operation` Optional: - `column_name` (String)Column name.
- `format` (String)When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
- `new_column_type` (String) ### Nested Schema for `logical_table_map.data_transforms.create_columns_operation` Optional: - `columns` (Attributes List)Calculated columns to create.
(see [below for nested schema](#nestedatt--logical_table_map--data_transforms--create_columns_operation--columns)) ### Nested Schema for `logical_table_map.data_transforms.create_columns_operation.columns` Optional: - `column_id` (String)A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
- `column_name` (String)Column name.
- `expression` (String)An expression that defines the calculated column.
### Nested Schema for `logical_table_map.data_transforms.filter_operation` Optional: - `condition_expression` (String)An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
### Nested Schema for `logical_table_map.data_transforms.project_operation` Optional: - `projected_columns` (List of String)Projected columns.
### Nested Schema for `logical_table_map.data_transforms.rename_column_operation` Optional: - `column_name` (String)The name of the column to be renamed.
- `new_column_name` (String)The new name for the column.
### Nested Schema for `logical_table_map.data_transforms.tag_column_operation` Optional: - `column_name` (String)The column that this operation acts on.
- `tags` (Attributes List)The dataset column tag, currently only used for geospatial type tagging. .
This is not tags for the AWS tagging feature. .
Metadata that contains a description for a column.
(see [below for nested schema](#nestedatt--logical_table_map--data_transforms--tag_column_operation--tags--column_description)) - `column_geographic_role` (String) ### Nested Schema for `logical_table_map.data_transforms.tag_column_operation.tags.column_description` Optional: - `text` (String)The text of a description for a column.
### Nested Schema for `logical_table_map.source` Optional: - `join_instruction` (Attributes)Join instruction.
(see [below for nested schema](#nestedatt--logical_table_map--source--join_instruction)) - `physical_table_id` (String)Physical table ID.
### Nested Schema for `logical_table_map.source.join_instruction` Optional: - `left_join_key_properties` (Attributes) (see [below for nested schema](#nestedatt--logical_table_map--source--join_instruction--left_join_key_properties)) - `left_operand` (String)Left operand.
- `on_clause` (String)On Clause.
- `right_join_key_properties` (Attributes) (see [below for nested schema](#nestedatt--logical_table_map--source--join_instruction--right_join_key_properties)) - `right_operand` (String)Right operand.
- `type` (String) ### Nested Schema for `logical_table_map.source.join_instruction.type` Optional: - `unique_key` (Boolean) ### Nested Schema for `logical_table_map.source.join_instruction.type` Optional: - `unique_key` (Boolean) ### Nested Schema for `permissions` Optional: - `actions` (List of String)The IAM action to grant or revoke permissions on.
- `principal` (String)The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
A physical table type built from the results of the custom SQL query.
(see [below for nested schema](#nestedatt--physical_table_map--custom_sql)) - `relational_table` (Attributes)A physical table type for relational data sources.
(see [below for nested schema](#nestedatt--physical_table_map--relational_table)) - `s3_source` (Attributes)A physical table type for as S3 data source.
(see [below for nested schema](#nestedatt--physical_table_map--s3_source)) ### Nested Schema for `physical_table_map.custom_sql` Optional: - `columns` (Attributes List)The column schema from the SQL query result set.
(see [below for nested schema](#nestedatt--physical_table_map--custom_sql--columns)) - `data_source_arn` (String)The Amazon Resource Name (ARN) of the data source.
- `name` (String)A display name for the SQL query result.
- `sql_query` (String)The SQL query.
### Nested Schema for `physical_table_map.custom_sql.columns` Optional: - `name` (String)The name of this column in the underlying data source.
- `type` (String) ### Nested Schema for `physical_table_map.relational_table` Optional: - `catalog` (String)The catalog associated with a table.
- `data_source_arn` (String)The Amazon Resource Name (ARN) for the data source.
- `input_columns` (Attributes List)The column schema of the table.
(see [below for nested schema](#nestedatt--physical_table_map--relational_table--input_columns)) - `name` (String)The name of the relational table.
- `schema` (String)The schema name. This name applies to certain relational database engines.
### Nested Schema for `physical_table_map.relational_table.input_columns` Optional: - `name` (String)The name of this column in the underlying data source.
- `type` (String) ### Nested Schema for `physical_table_map.s3_source` Optional: - `data_source_arn` (String)The amazon Resource Name (ARN) for the data source.
- `input_columns` (Attributes List)A physical table type for as S3 data source.
(see [below for nested schema](#nestedatt--physical_table_map--s3_source--input_columns)) - `upload_settings` (Attributes)Information about the format for a source file or files.
(see [below for nested schema](#nestedatt--physical_table_map--s3_source--upload_settings)) ### Nested Schema for `physical_table_map.s3_source.input_columns` Optional: - `name` (String)The name of this column in the underlying data source.
- `type` (String) ### Nested Schema for `physical_table_map.s3_source.upload_settings` Optional: - `contains_header` (Boolean)Whether the file has a header row, or the files each have a header row.
- `delimiter` (String)The delimiter between values in the file.
- `format` (String) - `start_from_row` (Number)A row number to start reading data from.
- `text_qualifier` (String) ### Nested Schema for `row_level_permission_data_set` Optional: - `arn` (String)The Amazon Resource Name (ARN) of the permission dataset.
- `format_version` (String) - `namespace` (String)The namespace associated with the row-level permissions dataset.
- `permission_policy` (String) ### Nested Schema for `tags` Optional: - `key` (String)Tag key.
- `value` (String)Tag value.
### Nested Schema for `output_columns` Read-Only: - `description` (String)A description for a column.
- `name` (String)A display name for the dataset.
- `type` (String) ## Import Import is supported using the following syntax: ```shell $ terraform import awscc_quicksight_data_set.example