1. Packages
  2. AWS Native
  3. API Docs
  4. quicksight
  5. DataSet

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

aws-native.quicksight.DataSet

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

    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:

    AwsAccountId string
    ColumnGroups List<Pulumi.AwsNative.QuickSight.Inputs.DataSetColumnGroup>
    ColumnLevelPermissionRules List<Pulumi.AwsNative.QuickSight.Inputs.DataSetColumnLevelPermissionRule>
    DataSetId string
    DataSetRefreshProperties Pulumi.AwsNative.QuickSight.Inputs.DataSetRefreshProperties
    DataSetUsageConfiguration Pulumi.AwsNative.QuickSight.Inputs.DataSetUsageConfiguration
    DatasetParameters List<Pulumi.AwsNative.QuickSight.Inputs.DataSetDatasetParameter>
    FieldFolders Pulumi.AwsNative.QuickSight.Inputs.DataSetFieldFolderMap
    ImportMode Pulumi.AwsNative.QuickSight.DataSetImportMode
    IngestionWaitPolicy Pulumi.AwsNative.QuickSight.Inputs.DataSetIngestionWaitPolicy
    LogicalTableMap Pulumi.AwsNative.QuickSight.Inputs.DataSetLogicalTableMap
    Name string
    Permissions List<Pulumi.AwsNative.QuickSight.Inputs.DataSetResourcePermission>
    PhysicalTableMap Pulumi.AwsNative.QuickSight.Inputs.DataSetPhysicalTableMap
    RowLevelPermissionDataSet Pulumi.AwsNative.QuickSight.Inputs.DataSetRowLevelPermissionDataSet
    RowLevelPermissionTagConfiguration Pulumi.AwsNative.QuickSight.Inputs.DataSetRowLevelPermissionTagConfiguration
    Tags List<Pulumi.AwsNative.QuickSight.Inputs.DataSetTag>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataSet resource produces the following output properties:

    Arn string
    ConsumedSpiceCapacityInBytes double
    CreatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    OutputColumns List<Pulumi.AwsNative.QuickSight.Outputs.DataSetOutputColumn>
    Arn string
    ConsumedSpiceCapacityInBytes float64
    CreatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    OutputColumns []DataSetOutputColumn
    arn String
    consumedSpiceCapacityInBytes Double
    createdTime String
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    outputColumns List<DataSetOutputColumn>
    arn string
    consumedSpiceCapacityInBytes number
    createdTime string
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime string
    outputColumns DataSetOutputColumn[]
    arn str
    consumed_spice_capacity_in_bytes float
    created_time str
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_time str
    output_columns Sequence[DataSetOutputColumn]
    arn String
    consumedSpiceCapacityInBytes Number
    createdTime String
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    outputColumns List<Property Map>

    Supporting Types

    DataSetColumnDataType, DataSetColumnDataTypeArgs

    String
    STRING
    Integer
    INTEGER
    Decimal
    DECIMAL
    Datetime
    DATETIME
    DataSetColumnDataTypeString
    STRING
    DataSetColumnDataTypeInteger
    INTEGER
    DataSetColumnDataTypeDecimal
    DECIMAL
    DataSetColumnDataTypeDatetime
    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, DataSetColumnGroupArgs

    DataSetColumnLevelPermissionRule, DataSetColumnLevelPermissionRuleArgs

    ColumnNames List<string>
    Principals List<string>
    ColumnNames []string
    Principals []string
    columnNames List<String>
    principals List<String>
    columnNames string[]
    principals string[]
    column_names Sequence[str]
    principals Sequence[str]
    columnNames List<String>
    principals List<String>

    DataSetColumnSubDataType, DataSetColumnSubDataTypeArgs

    Fixed
    FIXED
    Float
    FLOAT
    DataSetColumnSubDataTypeFixed
    FIXED
    DataSetColumnSubDataTypeFloat
    FLOAT
    Fixed
    FIXED
    Float
    FLOAT
    Fixed
    FIXED
    Float
    FLOAT
    FIXED
    FIXED
    FLOAT
    FLOAT
    "FIXED"
    FIXED
    "FLOAT"
    FLOAT

    DataSetDatasetParameter, DataSetDatasetParameterArgs

    DataSetDatasetParameterValueType, DataSetDatasetParameterValueTypeArgs

    MultiValued
    MULTI_VALUED
    SingleValued
    SINGLE_VALUED
    DataSetDatasetParameterValueTypeMultiValued
    MULTI_VALUED
    DataSetDatasetParameterValueTypeSingleValued
    SINGLE_VALUED
    MultiValued
    MULTI_VALUED
    SingleValued
    SINGLE_VALUED
    MultiValued
    MULTI_VALUED
    SingleValued
    SINGLE_VALUED
    MULTI_VALUED
    MULTI_VALUED
    SINGLE_VALUED
    SINGLE_VALUED
    "MULTI_VALUED"
    MULTI_VALUED
    "SINGLE_VALUED"
    SINGLE_VALUED

    DataSetDateTimeDatasetParameter, DataSetDateTimeDatasetParameterArgs

    DataSetDateTimeDatasetParameterDefaultValues, DataSetDateTimeDatasetParameterDefaultValuesArgs

    StaticValues List<string>
    StaticValues []string
    staticValues List<String>
    staticValues string[]
    static_values Sequence[str]
    staticValues List<String>

    DataSetDecimalDatasetParameter, DataSetDecimalDatasetParameterArgs

    DataSetDecimalDatasetParameterDefaultValues, DataSetDecimalDatasetParameterDefaultValuesArgs

    StaticValues List<double>
    StaticValues []float64
    staticValues List<Double>
    staticValues number[]
    static_values Sequence[float]
    staticValues List<Number>

    DataSetGeoSpatialColumnGroup, DataSetGeoSpatialColumnGroupArgs

    columns List<String>
    name String
    countryCode "US"

    DataSetGeoSpatialCountryCode, DataSetGeoSpatialCountryCodeArgs

    Us
    US
    DataSetGeoSpatialCountryCodeUs
    US
    Us
    US
    Us
    US
    US
    US
    "US"
    US

    DataSetImportMode, DataSetImportModeArgs

    Spice
    SPICE
    DirectQuery
    DIRECT_QUERY
    DataSetImportModeSpice
    SPICE
    DataSetImportModeDirectQuery
    DIRECT_QUERY
    Spice
    SPICE
    DirectQuery
    DIRECT_QUERY
    Spice
    SPICE
    DirectQuery
    DIRECT_QUERY
    SPICE
    SPICE
    DIRECT_QUERY
    DIRECT_QUERY
    "SPICE"
    SPICE
    "DIRECT_QUERY"
    DIRECT_QUERY

    DataSetIncrementalRefresh, DataSetIncrementalRefreshArgs

    DataSetIngestionWaitPolicy, DataSetIngestionWaitPolicyArgs

    DataSetIntegerDatasetParameter, DataSetIntegerDatasetParameterArgs

    DataSetIntegerDatasetParameterDefaultValues, DataSetIntegerDatasetParameterDefaultValuesArgs

    StaticValues List<double>
    StaticValues []float64
    staticValues List<Double>
    staticValues number[]
    static_values Sequence[float]
    staticValues List<Number>

    DataSetLookbackWindow, DataSetLookbackWindowArgs

    DataSetOutputColumn, DataSetOutputColumnArgs

    DataSetRefreshConfiguration, DataSetRefreshConfigurationArgs

    DataSetRefreshProperties, DataSetRefreshPropertiesArgs

    DataSetResourcePermission, DataSetResourcePermissionArgs

    Actions List<string>
    Principal string
    Actions []string
    Principal string
    actions List<String>
    principal String
    actions string[]
    principal string
    actions Sequence[str]
    principal str
    actions List<String>
    principal String

    DataSetRowLevelPermissionDataSet, DataSetRowLevelPermissionDataSetArgs

    DataSetRowLevelPermissionFormatVersion, DataSetRowLevelPermissionFormatVersionArgs

    Version1
    VERSION_1
    Version2
    VERSION_2
    DataSetRowLevelPermissionFormatVersionVersion1
    VERSION_1
    DataSetRowLevelPermissionFormatVersionVersion2
    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, DataSetRowLevelPermissionPolicyArgs

    GrantAccess
    GRANT_ACCESS
    DenyAccess
    DENY_ACCESS
    DataSetRowLevelPermissionPolicyGrantAccess
    GRANT_ACCESS
    DataSetRowLevelPermissionPolicyDenyAccess
    DENY_ACCESS
    GrantAccess
    GRANT_ACCESS
    DenyAccess
    DENY_ACCESS
    GrantAccess
    GRANT_ACCESS
    DenyAccess
    DENY_ACCESS
    GRANT_ACCESS
    GRANT_ACCESS
    DENY_ACCESS
    DENY_ACCESS
    "GRANT_ACCESS"
    GRANT_ACCESS
    "DENY_ACCESS"
    DENY_ACCESS

    DataSetRowLevelPermissionTagConfiguration, DataSetRowLevelPermissionTagConfigurationArgs

    DataSetRowLevelPermissionTagRule, DataSetRowLevelPermissionTagRuleArgs

    DataSetSizeUnit, DataSetSizeUnitArgs

    Hour
    HOUR
    Day
    DAY
    Week
    WEEK
    DataSetSizeUnitHour
    HOUR
    DataSetSizeUnitDay
    DAY
    DataSetSizeUnitWeek
    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, DataSetStatusArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    DataSetStatusEnabled
    ENABLED
    DataSetStatusDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    DataSetStringDatasetParameter, DataSetStringDatasetParameterArgs

    DataSetStringDatasetParameterDefaultValues, DataSetStringDatasetParameterDefaultValuesArgs

    StaticValues List<string>
    StaticValues []string
    staticValues List<String>
    staticValues string[]
    static_values Sequence[str]
    staticValues List<String>

    DataSetTag, DataSetTagArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    DataSetTimeGranularity, DataSetTimeGranularityArgs

    Year
    YEAR
    Quarter
    QUARTER
    Month
    MONTH
    Week
    WEEK
    Day
    DAY
    Hour
    HOUR
    Minute
    MINUTE
    Second
    SECOND
    Millisecond
    MILLISECOND
    DataSetTimeGranularityYear
    YEAR
    DataSetTimeGranularityQuarter
    QUARTER
    DataSetTimeGranularityMonth
    MONTH
    DataSetTimeGranularityWeek
    WEEK
    DataSetTimeGranularityDay
    DAY
    DataSetTimeGranularityHour
    HOUR
    DataSetTimeGranularityMinute
    MINUTE
    DataSetTimeGranularitySecond
    SECOND
    DataSetTimeGranularityMillisecond
    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, DataSetUsageConfigurationArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi