AWS Native v0.64.0, Jun 2 23
AWS Native v0.64.0, Jun 2 23
aws-native.quicksight.DataSet
Explore with Pulumi AI
Definition of the AWS::QuickSight::DataSet Resource Type.
Create DataSet Resource
new DataSet(name: string, args?: DataSetArgs, opts?: CustomResourceOptions);
@overload
def DataSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
aws_account_id: Optional[str] = None,
column_groups: Optional[Sequence[DataSetColumnGroupArgs]] = None,
column_level_permission_rules: Optional[Sequence[DataSetColumnLevelPermissionRuleArgs]] = None,
data_set_id: Optional[str] = None,
data_set_refresh_properties: Optional[DataSetRefreshPropertiesArgs] = None,
data_set_usage_configuration: Optional[DataSetUsageConfigurationArgs] = None,
dataset_parameters: Optional[Sequence[DataSetDatasetParameterArgs]] = None,
field_folders: Optional[DataSetFieldFolderMapArgs] = None,
import_mode: Optional[DataSetImportMode] = None,
ingestion_wait_policy: Optional[DataSetIngestionWaitPolicyArgs] = None,
logical_table_map: Optional[DataSetLogicalTableMapArgs] = None,
name: Optional[str] = None,
permissions: Optional[Sequence[DataSetResourcePermissionArgs]] = None,
physical_table_map: Optional[DataSetPhysicalTableMapArgs] = None,
row_level_permission_data_set: Optional[DataSetRowLevelPermissionDataSetArgs] = None,
row_level_permission_tag_configuration: Optional[DataSetRowLevelPermissionTagConfigurationArgs] = None,
tags: Optional[Sequence[DataSetTagArgs]] = None)
@overload
def DataSet(resource_name: str,
args: Optional[DataSetArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewDataSet(ctx *Context, name string, args *DataSetArgs, opts ...ResourceOption) (*DataSet, error)
public DataSet(string name, DataSetArgs? args = null, CustomResourceOptions? opts = null)
public DataSet(String name, DataSetArgs args)
public DataSet(String name, DataSetArgs args, CustomResourceOptions options)
type: aws-native:quicksight:DataSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DataSetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DataSetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataSetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DataSet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The DataSet resource accepts the following input properties:
- Aws
Account stringId - Column
Groups List<Pulumi.Aws Native. Quick Sight. Inputs. Data Set Column Group Args> - Column
Level List<Pulumi.Permission Rules Aws Native. Quick Sight. Inputs. Data Set Column Level Permission Rule Args> - Data
Set stringId - Data
Set Pulumi.Refresh Properties Aws Native. Quick Sight. Inputs. Data Set Refresh Properties Args - Data
Set Pulumi.Usage Configuration Aws Native. Quick Sight. Inputs. Data Set Usage Configuration Args - Dataset
Parameters List<Pulumi.Aws Native. Quick Sight. Inputs. Data Set Dataset Parameter Args> - Field
Folders Pulumi.Aws Native. Quick Sight. Inputs. Data Set Field Folder Map Args - Import
Mode Pulumi.Aws Native. Quick Sight. Data Set Import Mode - Ingestion
Wait Pulumi.Policy Aws Native. Quick Sight. Inputs. Data Set Ingestion Wait Policy Args - Logical
Table Pulumi.Map Aws Native. Quick Sight. Inputs. Data Set Logical Table Map Args - Name string
- Permissions
List<Pulumi.
Aws Native. Quick Sight. Inputs. Data Set Resource Permission Args> - Physical
Table Pulumi.Map Aws Native. Quick Sight. Inputs. Data Set Physical Table Map Args - Row
Level Pulumi.Permission Data Set Aws Native. Quick Sight. Inputs. Data Set Row Level Permission Data Set Args - Row
Level Pulumi.Permission Tag Configuration Aws Native. Quick Sight. Inputs. Data Set Row Level Permission Tag Configuration Args - List<Pulumi.
Aws Native. Quick Sight. Inputs. Data Set Tag Args>
- Aws
Account stringId - Column
Groups []DataSet Column Group Args - Column
Level []DataPermission Rules Set Column Level Permission Rule Args - Data
Set stringId - Data
Set DataRefresh Properties Set Refresh Properties Args - Data
Set DataUsage Configuration Set Usage Configuration Args - Dataset
Parameters []DataSet Dataset Parameter Args - Field
Folders DataSet Field Folder Map Args - Import
Mode DataSet Import Mode - Ingestion
Wait DataPolicy Set Ingestion Wait Policy Args - Logical
Table DataMap Set Logical Table Map Args - Name string
- Permissions
[]Data
Set Resource Permission Args - Physical
Table DataMap Set Physical Table Map Args - Row
Level DataPermission Data Set Set Row Level Permission Data Set Args - Row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration Args - []Data
Set Tag Args
- aws
Account StringId - column
Groups List<DataSet Column Group Args> - column
Level List<DataPermission Rules Set Column Level Permission Rule Args> - data
Set StringId - data
Set DataRefresh Properties Set Refresh Properties Args - data
Set DataUsage Configuration Set Usage Configuration Args - dataset
Parameters List<DataSet Dataset Parameter Args> - field
Folders DataSet Field Folder Map Args - import
Mode DataSet Import Mode - ingestion
Wait DataPolicy Set Ingestion Wait Policy Args - logical
Table DataMap Set Logical Table Map Args - name String
- permissions
List<Data
Set Resource Permission Args> - physical
Table DataMap Set Physical Table Map Args - row
Level DataPermission Data Set Set Row Level Permission Data Set Args - row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration Args - List<Data
Set Tag Args>
- aws
Account stringId - column
Groups DataSet Column Group Args[] - column
Level DataPermission Rules Set Column Level Permission Rule Args[] - data
Set stringId - data
Set DataRefresh Properties Set Refresh Properties Args - data
Set DataUsage Configuration Set Usage Configuration Args - dataset
Parameters DataSet Dataset Parameter Args[] - field
Folders DataSet Field Folder Map Args - import
Mode DataSet Import Mode - ingestion
Wait DataPolicy Set Ingestion Wait Policy Args - logical
Table DataMap Set Logical Table Map Args - name string
- permissions
Data
Set Resource Permission Args[] - physical
Table DataMap Set Physical Table Map Args - row
Level DataPermission Data Set Set Row Level Permission Data Set Args - row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration Args - Data
Set Tag Args[]
- aws_
account_ strid - column_
groups Sequence[DataSet Column Group Args] - column_
level_ Sequence[Datapermission_ rules Set Column Level Permission Rule Args] - data_
set_ strid - data_
set_ Datarefresh_ properties Set Refresh Properties Args - data_
set_ Datausage_ configuration Set Usage Configuration Args - dataset_
parameters Sequence[DataSet Dataset Parameter Args] - field_
folders DataSet Field Folder Map Args - import_
mode DataSet Import Mode - ingestion_
wait_ Datapolicy Set Ingestion Wait Policy Args - logical_
table_ Datamap Set Logical Table Map Args - name str
- permissions
Sequence[Data
Set Resource Permission Args] - physical_
table_ Datamap Set Physical Table Map Args - row_
level_ Datapermission_ data_ set Set Row Level Permission Data Set Args - row_
level_ Datapermission_ tag_ configuration Set Row Level Permission Tag Configuration Args - Sequence[Data
Set Tag Args]
- aws
Account StringId - column
Groups List<Property Map> - column
Level List<Property Map>Permission Rules - data
Set StringId - data
Set Property MapRefresh Properties - data
Set Property MapUsage Configuration - dataset
Parameters List<Property Map> - field
Folders Property Map - import
Mode "SPICE" | "DIRECT_QUERY" - ingestion
Wait Property MapPolicy - logical
Table Property MapMap - name String
- permissions List<Property Map>
- physical
Table Property MapMap - row
Level Property MapPermission Data Set - row
Level Property MapPermission Tag Configuration - List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the DataSet resource produces the following output properties:
- Arn string
- Consumed
Spice doubleCapacity In Bytes - Created
Time string - Id string
The provider-assigned unique ID for this managed resource.
- Last
Updated stringTime - Output
Columns List<Pulumi.Aws Native. Quick Sight. Outputs. Data Set Output Column>
- Arn string
- Consumed
Spice float64Capacity In Bytes - Created
Time string - Id string
The provider-assigned unique ID for this managed resource.
- Last
Updated stringTime - Output
Columns []DataSet Output Column
- arn String
- consumed
Spice DoubleCapacity In Bytes - created
Time String - id String
The provider-assigned unique ID for this managed resource.
- last
Updated StringTime - output
Columns List<DataSet Output Column>
- arn string
- consumed
Spice numberCapacity In Bytes - created
Time string - id string
The provider-assigned unique ID for this managed resource.
- last
Updated stringTime - output
Columns DataSet Output Column[]
- arn str
- consumed_
spice_ floatcapacity_ in_ bytes - created_
time str - id str
The provider-assigned unique ID for this managed resource.
- last_
updated_ strtime - output_
columns Sequence[DataSet Output Column]
- arn String
- consumed
Spice NumberCapacity In Bytes - created
Time String - id String
The provider-assigned unique ID for this managed resource.
- last
Updated StringTime - output
Columns List<Property Map>
Supporting Types
DataSetColumnDataType
- String
- STRING
- Integer
- INTEGER
- Decimal
- DECIMAL
- Datetime
- DATETIME
- Data
Set Column Data Type String - STRING
- Data
Set Column Data Type Integer - INTEGER
- Data
Set Column Data Type Decimal - DECIMAL
- Data
Set Column Data Type Datetime - DATETIME
- String
- STRING
- Integer
- INTEGER
- Decimal
- DECIMAL
- Datetime
- DATETIME
- String
- STRING
- Integer
- INTEGER
- Decimal
- DECIMAL
- Datetime
- DATETIME
- STRING
- STRING
- INTEGER
- INTEGER
- DECIMAL
- DECIMAL
- DATETIME
- DATETIME
- "STRING"
- STRING
- "INTEGER"
- INTEGER
- "DECIMAL"
- DECIMAL
- "DATETIME"
- DATETIME
DataSetColumnGroup
DataSetColumnLevelPermissionRule
- Column
Names List<string> - Principals List<string>
- Column
Names []string - Principals []string
- column
Names List<String> - principals List<String>
- column
Names string[] - principals string[]
- column_
names Sequence[str] - principals Sequence[str]
- column
Names List<String> - principals List<String>
DataSetDatasetParameter
- Date
Time Pulumi.Dataset Parameter Aws Native. Quick Sight. Inputs. Data Set Date Time Dataset Parameter - Decimal
Dataset Pulumi.Parameter Aws Native. Quick Sight. Inputs. Data Set Decimal Dataset Parameter - Integer
Dataset Pulumi.Parameter Aws Native. Quick Sight. Inputs. Data Set Integer Dataset Parameter - String
Dataset Pulumi.Parameter Aws Native. Quick Sight. Inputs. Data Set String Dataset Parameter
DataSetDatasetParameterValueType
- Multi
Valued - MULTI_VALUED
- Single
Valued - SINGLE_VALUED
- Data
Set Dataset Parameter Value Type Multi Valued - MULTI_VALUED
- Data
Set Dataset Parameter Value Type Single Valued - SINGLE_VALUED
- Multi
Valued - MULTI_VALUED
- Single
Valued - SINGLE_VALUED
- Multi
Valued - MULTI_VALUED
- Single
Valued - SINGLE_VALUED
- MULTI_VALUED
- MULTI_VALUED
- SINGLE_VALUED
- SINGLE_VALUED
- "MULTI_VALUED"
- MULTI_VALUED
- "SINGLE_VALUED"
- SINGLE_VALUED
DataSetDateTimeDatasetParameter
DataSetDateTimeDatasetParameterDefaultValues
- Static
Values List<string>
- Static
Values []string
- static
Values List<String>
- static
Values string[]
- static_
values Sequence[str]
- static
Values List<String>
DataSetDecimalDatasetParameter
DataSetDecimalDatasetParameterDefaultValues
- Static
Values List<double>
- Static
Values []float64
- static
Values List<Double>
- static
Values number[]
- static_
values Sequence[float]
- static
Values List<Number>
DataSetGeoSpatialColumnGroup
- Columns List<string>
- Name string
- Country
Code Pulumi.Aws Native. Quick Sight. Data Set Geo Spatial Country Code
- Columns []string
- Name string
- Country
Code DataSet Geo Spatial Country Code
- columns List<String>
- name String
- country
Code DataSet Geo Spatial Country Code
- columns string[]
- name string
- country
Code DataSet Geo Spatial Country Code
- columns Sequence[str]
- name str
- country_
code DataSet Geo Spatial Country Code
- columns List<String>
- name String
- country
Code "US"
DataSetGeoSpatialCountryCode
- Us
- US
- Data
Set Geo Spatial Country Code Us - US
- Us
- US
- Us
- US
- US
- US
- "US"
- US
DataSetImportMode
- Spice
- SPICE
- Direct
Query - DIRECT_QUERY
- Data
Set Import Mode Spice - SPICE
- Data
Set Import Mode Direct Query - DIRECT_QUERY
- Spice
- SPICE
- Direct
Query - DIRECT_QUERY
- Spice
- SPICE
- Direct
Query - DIRECT_QUERY
- SPICE
- SPICE
- DIRECT_QUERY
- DIRECT_QUERY
- "SPICE"
- SPICE
- "DIRECT_QUERY"
- DIRECT_QUERY
DataSetIncrementalRefresh
DataSetIngestionWaitPolicy
- Ingestion
Wait doubleTime In Hours - Wait
For boolSpice Ingestion
- Ingestion
Wait float64Time In Hours - Wait
For boolSpice Ingestion
- ingestion
Wait DoubleTime In Hours - wait
For BooleanSpice Ingestion
- ingestion
Wait numberTime In Hours - wait
For booleanSpice Ingestion
- ingestion
Wait NumberTime In Hours - wait
For BooleanSpice Ingestion
DataSetIntegerDatasetParameter
DataSetIntegerDatasetParameterDefaultValues
- Static
Values List<double>
- Static
Values []float64
- static
Values List<Double>
- static
Values number[]
- static_
values Sequence[float]
- static
Values List<Number>
DataSetLookbackWindow
- Column
Name string - Size float64
- Size
Unit DataSet Size Unit
- column
Name String - size Double
- size
Unit DataSet Size Unit
- column
Name string - size number
- size
Unit DataSet Size Unit
- column_
name str - size float
- size_
unit DataSet Size Unit
- column
Name String - size Number
- size
Unit "HOUR" | "DAY" | "WEEK"
DataSetOutputColumn
- Description string
- Name string
- Type
Data
Set Column Data Type
- description String
- name String
- type
Data
Set Column Data Type
- description string
- name string
- type
Data
Set Column Data Type
DataSetRefreshConfiguration
DataSetRefreshProperties
DataSetResourcePermission
DataSetRowLevelPermissionDataSet
DataSetRowLevelPermissionFormatVersion
- Version1
- VERSION_1
- Version2
- VERSION_2
- Data
Set Row Level Permission Format Version Version1 - VERSION_1
- Data
Set Row Level Permission Format Version Version2 - VERSION_2
- Version1
- VERSION_1
- Version2
- VERSION_2
- Version1
- VERSION_1
- Version2
- VERSION_2
- VERSION1
- VERSION_1
- VERSION2
- VERSION_2
- "VERSION_1"
- VERSION_1
- "VERSION_2"
- VERSION_2
DataSetRowLevelPermissionPolicy
- Grant
Access - GRANT_ACCESS
- Deny
Access - DENY_ACCESS
- Data
Set Row Level Permission Policy Grant Access - GRANT_ACCESS
- Data
Set Row Level Permission Policy Deny Access - DENY_ACCESS
- Grant
Access - GRANT_ACCESS
- Deny
Access - DENY_ACCESS
- Grant
Access - GRANT_ACCESS
- Deny
Access - DENY_ACCESS
- GRANT_ACCESS
- GRANT_ACCESS
- DENY_ACCESS
- DENY_ACCESS
- "GRANT_ACCESS"
- GRANT_ACCESS
- "DENY_ACCESS"
- DENY_ACCESS
DataSetRowLevelPermissionTagConfiguration
- tag_
rules Sequence[DataSet Row Level Permission Tag Rule] - status
Data
Set Status - tag_
rule_ Sequence[Sequence[str]]configurations
- tag
Rules List<Property Map> - status "ENABLED" | "DISABLED"
- tag
Rule List<List<String>>Configurations
DataSetRowLevelPermissionTagRule
- Column
Name string - Tag
Key string - Match
All stringValue - Tag
Multi stringValue Delimiter
- Column
Name string - Tag
Key string - Match
All stringValue - Tag
Multi stringValue Delimiter
- column
Name String - tag
Key String - match
All StringValue - tag
Multi StringValue Delimiter
- column
Name string - tag
Key string - match
All stringValue - tag
Multi stringValue Delimiter
- column_
name str - tag_
key str - match_
all_ strvalue - tag_
multi_ strvalue_ delimiter
- column
Name String - tag
Key String - match
All StringValue - tag
Multi StringValue Delimiter
DataSetSizeUnit
- Hour
- HOUR
- Day
- DAY
- Week
- WEEK
- Data
Set Size Unit Hour - HOUR
- Data
Set Size Unit Day - DAY
- Data
Set Size Unit Week - WEEK
- Hour
- HOUR
- Day
- DAY
- Week
- WEEK
- Hour
- HOUR
- Day
- DAY
- Week
- WEEK
- HOUR
- HOUR
- DAY
- DAY
- WEEK
- WEEK
- "HOUR"
- HOUR
- "DAY"
- DAY
- "WEEK"
- WEEK
DataSetStatus
- Enabled
- ENABLED
- Disabled
- DISABLED
- Data
Set Status Enabled - ENABLED
- Data
Set Status Disabled - DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
DataSetStringDatasetParameter
DataSetStringDatasetParameterDefaultValues
- Static
Values List<string>
- Static
Values []string
- static
Values List<String>
- static
Values string[]
- static_
values Sequence[str]
- static
Values List<String>
DataSetTag
DataSetTimeGranularity
- Year
- YEAR
- Quarter
- QUARTER
- Month
- MONTH
- Week
- WEEK
- Day
- DAY
- Hour
- HOUR
- Minute
- MINUTE
- Second
- SECOND
- Millisecond
- MILLISECOND
- Data
Set Time Granularity Year - YEAR
- Data
Set Time Granularity Quarter - QUARTER
- Data
Set Time Granularity Month - MONTH
- Data
Set Time Granularity Week - WEEK
- Data
Set Time Granularity Day - DAY
- Data
Set Time Granularity Hour - HOUR
- Data
Set Time Granularity Minute - MINUTE
- Data
Set Time Granularity Second - SECOND
- Data
Set Time Granularity Millisecond - MILLISECOND
- Year
- YEAR
- Quarter
- QUARTER
- Month
- MONTH
- Week
- WEEK
- Day
- DAY
- Hour
- HOUR
- Minute
- MINUTE
- Second
- SECOND
- Millisecond
- MILLISECOND
- Year
- YEAR
- Quarter
- QUARTER
- Month
- MONTH
- Week
- WEEK
- Day
- DAY
- Hour
- HOUR
- Minute
- MINUTE
- Second
- SECOND
- Millisecond
- MILLISECOND
- YEAR
- YEAR
- QUARTER
- QUARTER
- MONTH
- MONTH
- WEEK
- WEEK
- DAY
- DAY
- HOUR
- HOUR
- MINUTE
- MINUTE
- SECOND
- SECOND
- MILLISECOND
- MILLISECOND
- "YEAR"
- YEAR
- "QUARTER"
- QUARTER
- "MONTH"
- MONTH
- "WEEK"
- WEEK
- "DAY"
- DAY
- "HOUR"
- HOUR
- "MINUTE"
- MINUTE
- "SECOND"
- SECOND
- "MILLISECOND"
- MILLISECOND
DataSetUsageConfiguration
- disable
Use BooleanAs Direct Query Source - disable
Use BooleanAs Imported Source
- disable
Use booleanAs Direct Query Source - disable
Use booleanAs Imported Source
- disable
Use BooleanAs Direct Query Source - disable
Use BooleanAs Imported Source
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0