1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. quicksight
  5. getDataSet

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.quicksight.getDataSet

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    Definition of the AWS::QuickSight::DataSet Resource Type.

    Using getDataSet

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDataSet(args: GetDataSetArgs, opts?: InvokeOptions): Promise<GetDataSetResult>
    function getDataSetOutput(args: GetDataSetOutputArgs, opts?: InvokeOptions): Output<GetDataSetResult>
    def get_data_set(aws_account_id: Optional[str] = None,
                     data_set_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetDataSetResult
    def get_data_set_output(aws_account_id: Optional[pulumi.Input[str]] = None,
                     data_set_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetDataSetResult]
    func LookupDataSet(ctx *Context, args *LookupDataSetArgs, opts ...InvokeOption) (*LookupDataSetResult, error)
    func LookupDataSetOutput(ctx *Context, args *LookupDataSetOutputArgs, opts ...InvokeOption) LookupDataSetResultOutput

    > Note: This function is named LookupDataSet in the Go SDK.

    public static class GetDataSet 
    {
        public static Task<GetDataSetResult> InvokeAsync(GetDataSetArgs args, InvokeOptions? opts = null)
        public static Output<GetDataSetResult> Invoke(GetDataSetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDataSetResult> getDataSet(GetDataSetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:quicksight:getDataSet
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AwsAccountId string
    The AWS account ID.
    DataSetId string
    An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
    AwsAccountId string
    The AWS account ID.
    DataSetId string
    An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
    awsAccountId String
    The AWS account ID.
    dataSetId String
    An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
    awsAccountId string
    The AWS account ID.
    dataSetId string
    An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
    aws_account_id str
    The AWS account ID.
    data_set_id str
    An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
    awsAccountId String
    The AWS account ID.
    dataSetId String
    An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

    getDataSet Result

    The following output properties are available:

    Arn string
    ColumnGroups List<Pulumi.AwsNative.QuickSight.Outputs.DataSetColumnGroup>
    ColumnLevelPermissionRules List<Pulumi.AwsNative.QuickSight.Outputs.DataSetColumnLevelPermissionRule>
    ConsumedSpiceCapacityInBytes double
    CreatedTime string
    DataSetRefreshProperties Pulumi.AwsNative.QuickSight.Outputs.DataSetRefreshProperties
    The refresh properties of a dataset.
    DataSetUsageConfiguration Pulumi.AwsNative.QuickSight.Outputs.DataSetUsageConfiguration
    The usage configuration to apply to child datasets that reference this dataset as a source.
    DatasetParameters List<Pulumi.AwsNative.QuickSight.Outputs.DataSetDatasetParameter>
    ImportMode Pulumi.AwsNative.QuickSight.DataSetImportMode
    Indicates whether you want to import the data into SPICE.
    LastUpdatedTime string
    LogicalTableMap Dictionary<string, Pulumi.AwsNative.QuickSight.Outputs.DataSetLogicalTable>
    Configures the combination and transformation of the data from the physical tables.
    Name string
    OutputColumns List<Pulumi.AwsNative.QuickSight.Outputs.DataSetOutputColumn>
    Permissions List<Pulumi.AwsNative.QuickSight.Outputs.DataSetResourcePermission>
    PhysicalTableMap Dictionary<string, Pulumi.AwsNative.QuickSight.Outputs.DataSetPhysicalTable>
    Declares the physical tables that are available in the underlying data sources.
    RowLevelPermissionDataSet Pulumi.AwsNative.QuickSight.Outputs.DataSetRowLevelPermissionDataSet
    The row-level security configuration for the data that you want to create.
    RowLevelPermissionTagConfiguration Pulumi.AwsNative.QuickSight.Outputs.DataSetRowLevelPermissionTagConfiguration
    The element you can use to define tags for row-level security.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Arn string
    ColumnGroups []DataSetColumnGroup
    ColumnLevelPermissionRules []DataSetColumnLevelPermissionRule
    ConsumedSpiceCapacityInBytes float64
    CreatedTime string
    DataSetRefreshProperties DataSetRefreshProperties
    The refresh properties of a dataset.
    DataSetUsageConfiguration DataSetUsageConfiguration
    The usage configuration to apply to child datasets that reference this dataset as a source.
    DatasetParameters []DataSetDatasetParameter
    ImportMode DataSetImportMode
    Indicates whether you want to import the data into SPICE.
    LastUpdatedTime string
    LogicalTableMap map[string]DataSetLogicalTable
    Configures the combination and transformation of the data from the physical tables.
    Name string
    OutputColumns []DataSetOutputColumn
    Permissions []DataSetResourcePermission
    PhysicalTableMap map[string]DataSetPhysicalTable
    Declares the physical tables that are available in the underlying data sources.
    RowLevelPermissionDataSet DataSetRowLevelPermissionDataSet
    The row-level security configuration for the data that you want to create.
    RowLevelPermissionTagConfiguration DataSetRowLevelPermissionTagConfiguration
    The element you can use to define tags for row-level security.
    Tags Tag
    arn String
    columnGroups List<DataSetColumnGroup>
    columnLevelPermissionRules List<DataSetColumnLevelPermissionRule>
    consumedSpiceCapacityInBytes Double
    createdTime String
    dataSetRefreshProperties DataSetRefreshProperties
    The refresh properties of a dataset.
    dataSetUsageConfiguration DataSetUsageConfiguration
    The usage configuration to apply to child datasets that reference this dataset as a source.
    datasetParameters List<DataSetDatasetParameter>
    importMode DataSetImportMode
    Indicates whether you want to import the data into SPICE.
    lastUpdatedTime String
    logicalTableMap Map<String,DataSetLogicalTable>
    Configures the combination and transformation of the data from the physical tables.
    name String
    outputColumns List<DataSetOutputColumn>
    permissions List<DataSetResourcePermission>
    physicalTableMap Map<String,DataSetPhysicalTable>
    Declares the physical tables that are available in the underlying data sources.
    rowLevelPermissionDataSet DataSetRowLevelPermissionDataSet
    The row-level security configuration for the data that you want to create.
    rowLevelPermissionTagConfiguration DataSetRowLevelPermissionTagConfiguration
    The element you can use to define tags for row-level security.
    tags List<Tag>
    arn string
    columnGroups DataSetColumnGroup[]
    columnLevelPermissionRules DataSetColumnLevelPermissionRule[]
    consumedSpiceCapacityInBytes number
    createdTime string
    dataSetRefreshProperties DataSetRefreshProperties
    The refresh properties of a dataset.
    dataSetUsageConfiguration DataSetUsageConfiguration
    The usage configuration to apply to child datasets that reference this dataset as a source.
    datasetParameters DataSetDatasetParameter[]
    importMode DataSetImportMode
    Indicates whether you want to import the data into SPICE.
    lastUpdatedTime string
    logicalTableMap {[key: string]: DataSetLogicalTable}
    Configures the combination and transformation of the data from the physical tables.
    name string
    outputColumns DataSetOutputColumn[]
    permissions DataSetResourcePermission[]
    physicalTableMap {[key: string]: DataSetPhysicalTable}
    Declares the physical tables that are available in the underlying data sources.
    rowLevelPermissionDataSet DataSetRowLevelPermissionDataSet
    The row-level security configuration for the data that you want to create.
    rowLevelPermissionTagConfiguration DataSetRowLevelPermissionTagConfiguration
    The element you can use to define tags for row-level security.
    tags Tag[]
    arn str
    column_groups Sequence[DataSetColumnGroup]
    column_level_permission_rules Sequence[DataSetColumnLevelPermissionRule]
    consumed_spice_capacity_in_bytes float
    created_time str
    data_set_refresh_properties DataSetRefreshProperties
    The refresh properties of a dataset.
    data_set_usage_configuration DataSetUsageConfiguration
    The usage configuration to apply to child datasets that reference this dataset as a source.
    dataset_parameters Sequence[DataSetDatasetParameter]
    import_mode DataSetImportMode
    Indicates whether you want to import the data into SPICE.
    last_updated_time str
    logical_table_map Mapping[str, DataSetLogicalTable]
    Configures the combination and transformation of the data from the physical tables.
    name str
    output_columns Sequence[DataSetOutputColumn]
    permissions Sequence[DataSetResourcePermission]
    physical_table_map Mapping[str, DataSetPhysicalTable]
    Declares the physical tables that are available in the underlying data sources.
    row_level_permission_data_set DataSetRowLevelPermissionDataSet
    The row-level security configuration for the data that you want to create.
    row_level_permission_tag_configuration DataSetRowLevelPermissionTagConfiguration
    The element you can use to define tags for row-level security.
    tags Sequence[root_Tag]
    arn String
    columnGroups List<Property Map>
    columnLevelPermissionRules List<Property Map>
    consumedSpiceCapacityInBytes Number
    createdTime String
    dataSetRefreshProperties Property Map
    The refresh properties of a dataset.
    dataSetUsageConfiguration Property Map
    The usage configuration to apply to child datasets that reference this dataset as a source.
    datasetParameters List<Property Map>
    importMode "SPICE" | "DIRECT_QUERY"
    Indicates whether you want to import the data into SPICE.
    lastUpdatedTime String
    logicalTableMap Map<Property Map>
    Configures the combination and transformation of the data from the physical tables.
    name String
    outputColumns List<Property Map>
    permissions List<Property Map>
    physicalTableMap Map<Property Map>
    Declares the physical tables that are available in the underlying data sources.
    rowLevelPermissionDataSet Property Map
    The row-level security configuration for the data that you want to create.
    rowLevelPermissionTagConfiguration Property Map
    The element you can use to define tags for row-level security.
    tags List<Property Map>

    Supporting Types

    DataSetCalculatedColumn

    ColumnId string
    ColumnName string
    Expression string
    ColumnId string
    ColumnName string
    Expression string
    columnId String
    columnName String
    expression String
    columnId string
    columnName string
    expression string
    columnId String
    columnName String
    expression String

    DataSetCastColumnTypeOperation

    ColumnName string
    NewColumnType Pulumi.AwsNative.QuickSight.DataSetColumnDataType
    New column data type.
    Format string
    SubType Pulumi.AwsNative.QuickSight.DataSetColumnDataSubType
    The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
    ColumnName string
    NewColumnType DataSetColumnDataType
    New column data type.
    Format string
    SubType DataSetColumnDataSubType
    The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
    columnName String
    newColumnType DataSetColumnDataType
    New column data type.
    format String
    subType DataSetColumnDataSubType
    The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
    columnName string
    newColumnType DataSetColumnDataType
    New column data type.
    format string
    subType DataSetColumnDataSubType
    The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
    column_name str
    new_column_type DataSetColumnDataType
    New column data type.
    format str
    sub_type DataSetColumnDataSubType
    The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
    columnName String
    newColumnType "STRING" | "INTEGER" | "DECIMAL" | "DATETIME"
    New column data type.
    format String
    subType "FLOAT" | "FIXED"
    The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

    DataSetColumnDataSubType

    DataSetColumnDataType

    DataSetColumnDescription

    Text string
    Text string
    text String
    text string
    text str
    text String

    DataSetColumnGroup

    GeoSpatialColumnGroup DataSetGeoSpatialColumnGroup
    Geospatial column group that denotes a hierarchy.
    geoSpatialColumnGroup DataSetGeoSpatialColumnGroup
    Geospatial column group that denotes a hierarchy.
    geoSpatialColumnGroup DataSetGeoSpatialColumnGroup
    Geospatial column group that denotes a hierarchy.
    geo_spatial_column_group DataSetGeoSpatialColumnGroup
    Geospatial column group that denotes a hierarchy.
    geoSpatialColumnGroup Property Map
    Geospatial column group that denotes a hierarchy.

    DataSetColumnLevelPermissionRule

    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>

    DataSetColumnTag

    ColumnDescription DataSetColumnDescription
    A description for a column.
    ColumnGeographicRole DataSetGeoSpatialDataRole
    A geospatial role for a column.
    columnDescription DataSetColumnDescription
    A description for a column.
    columnGeographicRole DataSetGeoSpatialDataRole
    A geospatial role for a column.
    columnDescription DataSetColumnDescription
    A description for a column.
    columnGeographicRole DataSetGeoSpatialDataRole
    A geospatial role for a column.
    column_description DataSetColumnDescription
    A description for a column.
    column_geographic_role DataSetGeoSpatialDataRole
    A geospatial role for a column.

    DataSetColumnTagName

    DataSetCreateColumnsOperation

    DataSetCustomSql

    DataSetDatasetParameter

    DateTimeDatasetParameter DataSetDateTimeDatasetParameter
    A date time parameter that is created in the dataset.
    DecimalDatasetParameter DataSetDecimalDatasetParameter
    A decimal parameter that is created in the dataset.
    IntegerDatasetParameter DataSetIntegerDatasetParameter
    An integer parameter that is created in the dataset.
    StringDatasetParameter DataSetStringDatasetParameter
    A string parameter that is created in the dataset.
    dateTimeDatasetParameter DataSetDateTimeDatasetParameter
    A date time parameter that is created in the dataset.
    decimalDatasetParameter DataSetDecimalDatasetParameter
    A decimal parameter that is created in the dataset.
    integerDatasetParameter DataSetIntegerDatasetParameter
    An integer parameter that is created in the dataset.
    stringDatasetParameter DataSetStringDatasetParameter
    A string parameter that is created in the dataset.
    dateTimeDatasetParameter DataSetDateTimeDatasetParameter
    A date time parameter that is created in the dataset.
    decimalDatasetParameter DataSetDecimalDatasetParameter
    A decimal parameter that is created in the dataset.
    integerDatasetParameter DataSetIntegerDatasetParameter
    An integer parameter that is created in the dataset.
    stringDatasetParameter DataSetStringDatasetParameter
    A string parameter that is created in the dataset.
    date_time_dataset_parameter DataSetDateTimeDatasetParameter
    A date time parameter that is created in the dataset.
    decimal_dataset_parameter DataSetDecimalDatasetParameter
    A decimal parameter that is created in the dataset.
    integer_dataset_parameter DataSetIntegerDatasetParameter
    An integer parameter that is created in the dataset.
    string_dataset_parameter DataSetStringDatasetParameter
    A string parameter that is created in the dataset.
    dateTimeDatasetParameter Property Map
    A date time parameter that is created in the dataset.
    decimalDatasetParameter Property Map
    A decimal parameter that is created in the dataset.
    integerDatasetParameter Property Map
    An integer parameter that is created in the dataset.
    stringDatasetParameter Property Map
    A string parameter that is created in the dataset.

    DataSetDatasetParameterValueType

    DataSetDateTimeDatasetParameter

    Id string
    Name string
    ValueType Pulumi.AwsNative.QuickSight.DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    DefaultValues Pulumi.AwsNative.QuickSight.Inputs.DataSetDateTimeDatasetParameterDefaultValues
    A list of default values for a given date time parameter. This structure only accepts static values.
    TimeGranularity Pulumi.AwsNative.QuickSight.DataSetTimeGranularity
    The time granularity of the date time parameter.
    Id string
    Name string
    ValueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    DefaultValues DataSetDateTimeDatasetParameterDefaultValues
    A list of default values for a given date time parameter. This structure only accepts static values.
    TimeGranularity DataSetTimeGranularity
    The time granularity of the date time parameter.
    id String
    name String
    valueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues DataSetDateTimeDatasetParameterDefaultValues
    A list of default values for a given date time parameter. This structure only accepts static values.
    timeGranularity DataSetTimeGranularity
    The time granularity of the date time parameter.
    id string
    name string
    valueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues DataSetDateTimeDatasetParameterDefaultValues
    A list of default values for a given date time parameter. This structure only accepts static values.
    timeGranularity DataSetTimeGranularity
    The time granularity of the date time parameter.
    id str
    name str
    value_type DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    default_values DataSetDateTimeDatasetParameterDefaultValues
    A list of default values for a given date time parameter. This structure only accepts static values.
    time_granularity DataSetTimeGranularity
    The time granularity of the date time parameter.
    id String
    name String
    valueType "MULTI_VALUED" | "SINGLE_VALUED"
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues Property Map
    A list of default values for a given date time parameter. This structure only accepts static values.
    timeGranularity "YEAR" | "QUARTER" | "MONTH" | "WEEK" | "DAY" | "HOUR" | "MINUTE" | "SECOND" | "MILLISECOND"
    The time granularity of the date time parameter.

    DataSetDateTimeDatasetParameterDefaultValues

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

    DataSetDecimalDatasetParameter

    Id string
    Name string
    ValueType Pulumi.AwsNative.QuickSight.DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    DefaultValues Pulumi.AwsNative.QuickSight.Inputs.DataSetDecimalDatasetParameterDefaultValues
    A list of default values for a given decimal parameter. This structure only accepts static values.
    Id string
    Name string
    ValueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    DefaultValues DataSetDecimalDatasetParameterDefaultValues
    A list of default values for a given decimal parameter. This structure only accepts static values.
    id String
    name String
    valueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues DataSetDecimalDatasetParameterDefaultValues
    A list of default values for a given decimal parameter. This structure only accepts static values.
    id string
    name string
    valueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues DataSetDecimalDatasetParameterDefaultValues
    A list of default values for a given decimal parameter. This structure only accepts static values.
    id str
    name str
    value_type DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    default_values DataSetDecimalDatasetParameterDefaultValues
    A list of default values for a given decimal parameter. This structure only accepts static values.
    id String
    name String
    valueType "MULTI_VALUED" | "SINGLE_VALUED"
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues Property Map
    A list of default values for a given decimal parameter. This structure only accepts static values.

    DataSetDecimalDatasetParameterDefaultValues

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

    DataSetFileFormat

    DataSetFilterOperation

    DataSetGeoSpatialColumnGroup

    columns List<String>
    name String
    countryCode DataSetGeoSpatialCountryCode
    Country code.
    columns List<String>
    name String
    countryCode "US"
    Country code.

    DataSetGeoSpatialCountryCode

    DataSetGeoSpatialDataRole

    DataSetImportMode

    DataSetIncrementalRefresh

    LookbackWindow Pulumi.AwsNative.QuickSight.Inputs.DataSetLookbackWindow
    The lookback window setup for an incremental refresh configuration.
    LookbackWindow DataSetLookbackWindow
    The lookback window setup for an incremental refresh configuration.
    lookbackWindow DataSetLookbackWindow
    The lookback window setup for an incremental refresh configuration.
    lookbackWindow DataSetLookbackWindow
    The lookback window setup for an incremental refresh configuration.
    lookback_window DataSetLookbackWindow
    The lookback window setup for an incremental refresh configuration.
    lookbackWindow Property Map
    The lookback window setup for an incremental refresh configuration.

    DataSetInputColumn

    Name string
    Type Pulumi.AwsNative.QuickSight.DataSetInputColumnDataType
    The data type of the column.
    SubType Pulumi.AwsNative.QuickSight.DataSetColumnDataSubType
    The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
    Name string
    Type DataSetInputColumnDataType
    The data type of the column.
    SubType DataSetColumnDataSubType
    The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
    name String
    type DataSetInputColumnDataType
    The data type of the column.
    subType DataSetColumnDataSubType
    The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
    name string
    type DataSetInputColumnDataType
    The data type of the column.
    subType DataSetColumnDataSubType
    The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
    name str
    type DataSetInputColumnDataType
    The data type of the column.
    sub_type DataSetColumnDataSubType
    The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
    name String
    type "STRING" | "INTEGER" | "DECIMAL" | "DATETIME" | "BIT" | "BOOLEAN" | "JSON"
    The data type of the column.
    subType "FLOAT" | "FIXED"
    The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

    DataSetInputColumnDataType

    DataSetIntegerDatasetParameter

    Id string
    Name string
    ValueType Pulumi.AwsNative.QuickSight.DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    DefaultValues Pulumi.AwsNative.QuickSight.Inputs.DataSetIntegerDatasetParameterDefaultValues
    A list of default values for a given integer parameter. This structure only accepts static values.
    Id string
    Name string
    ValueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    DefaultValues DataSetIntegerDatasetParameterDefaultValues
    A list of default values for a given integer parameter. This structure only accepts static values.
    id String
    name String
    valueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues DataSetIntegerDatasetParameterDefaultValues
    A list of default values for a given integer parameter. This structure only accepts static values.
    id string
    name string
    valueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues DataSetIntegerDatasetParameterDefaultValues
    A list of default values for a given integer parameter. This structure only accepts static values.
    id str
    name str
    value_type DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    default_values DataSetIntegerDatasetParameterDefaultValues
    A list of default values for a given integer parameter. This structure only accepts static values.
    id String
    name String
    valueType "MULTI_VALUED" | "SINGLE_VALUED"
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues Property Map
    A list of default values for a given integer parameter. This structure only accepts static values.

    DataSetIntegerDatasetParameterDefaultValues

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

    DataSetJoinInstruction

    LeftOperand string
    OnClause string
    RightOperand string
    Type DataSetJoinType
    The type of join that it is.
    LeftJoinKeyProperties DataSetJoinKeyProperties
    Join key properties of the left operand.
    RightJoinKeyProperties DataSetJoinKeyProperties
    Join key properties of the right operand.
    leftOperand String
    onClause String
    rightOperand String
    type DataSetJoinType
    The type of join that it is.
    leftJoinKeyProperties DataSetJoinKeyProperties
    Join key properties of the left operand.
    rightJoinKeyProperties DataSetJoinKeyProperties
    Join key properties of the right operand.
    leftOperand string
    onClause string
    rightOperand string
    type DataSetJoinType
    The type of join that it is.
    leftJoinKeyProperties DataSetJoinKeyProperties
    Join key properties of the left operand.
    rightJoinKeyProperties DataSetJoinKeyProperties
    Join key properties of the right operand.
    left_operand str
    on_clause str
    right_operand str
    type DataSetJoinType
    The type of join that it is.
    left_join_key_properties DataSetJoinKeyProperties
    Join key properties of the left operand.
    right_join_key_properties DataSetJoinKeyProperties
    Join key properties of the right operand.
    leftOperand String
    onClause String
    rightOperand String
    type "INNER" | "OUTER" | "LEFT" | "RIGHT"
    The type of join that it is.
    leftJoinKeyProperties Property Map
    Join key properties of the left operand.
    rightJoinKeyProperties Property Map
    Join key properties of the right operand.

    DataSetJoinKeyProperties

    uniqueKey Boolean
    uniqueKey boolean
    uniqueKey Boolean

    DataSetJoinType

    DataSetLogicalTable

    alias String
    dataTransforms List<Property Map>
    source Property Map
    Source of this logical table.

    DataSetLogicalTableSource

    DataSetArn string
    JoinInstruction Pulumi.AwsNative.QuickSight.Inputs.DataSetJoinInstruction
    Specifies the result of a join of two logical tables.
    PhysicalTableId string
    DataSetArn string
    JoinInstruction DataSetJoinInstruction
    Specifies the result of a join of two logical tables.
    PhysicalTableId string
    dataSetArn String
    joinInstruction DataSetJoinInstruction
    Specifies the result of a join of two logical tables.
    physicalTableId String
    dataSetArn string
    joinInstruction DataSetJoinInstruction
    Specifies the result of a join of two logical tables.
    physicalTableId string
    data_set_arn str
    join_instruction DataSetJoinInstruction
    Specifies the result of a join of two logical tables.
    physical_table_id str
    dataSetArn String
    joinInstruction Property Map
    Specifies the result of a join of two logical tables.
    physicalTableId String

    DataSetLookbackWindow

    ColumnName string
    Size double
    SizeUnit Pulumi.AwsNative.QuickSight.DataSetLookbackWindowSizeUnit
    The size unit that is used for the lookback window column. Valid values for this structure are HOUR , DAY , and WEEK .
    ColumnName string
    Size float64
    SizeUnit DataSetLookbackWindowSizeUnit
    The size unit that is used for the lookback window column. Valid values for this structure are HOUR , DAY , and WEEK .
    columnName String
    size Double
    sizeUnit DataSetLookbackWindowSizeUnit
    The size unit that is used for the lookback window column. Valid values for this structure are HOUR , DAY , and WEEK .
    columnName string
    size number
    sizeUnit DataSetLookbackWindowSizeUnit
    The size unit that is used for the lookback window column. Valid values for this structure are HOUR , DAY , and WEEK .
    column_name str
    size float
    size_unit DataSetLookbackWindowSizeUnit
    The size unit that is used for the lookback window column. Valid values for this structure are HOUR , DAY , and WEEK .
    columnName String
    size Number
    sizeUnit "HOUR" | "DAY" | "WEEK"
    The size unit that is used for the lookback window column. Valid values for this structure are HOUR , DAY , and WEEK .

    DataSetLookbackWindowSizeUnit

    DataSetNewDefaultValues

    DateTimeStaticValues List<string>
    DecimalStaticValues List<double>
    IntegerStaticValues List<double>
    StringStaticValues List<string>
    dateTimeStaticValues List<String>
    decimalStaticValues List<Double>
    integerStaticValues List<Double>
    stringStaticValues List<String>
    date_time_static_values Sequence[str]
    decimal_static_values Sequence[float]
    integer_static_values Sequence[float]
    string_static_values Sequence[str]
    dateTimeStaticValues List<String>
    decimalStaticValues List<Number>
    integerStaticValues List<Number>
    stringStaticValues List<String>

    DataSetOutputColumn

    Description string
    Name string
    SubType DataSetColumnDataSubType
    The sub data type of the column.
    Type DataSetColumnDataType
    The data type of the column.
    description String
    name String
    subType DataSetColumnDataSubType
    The sub data type of the column.
    type DataSetColumnDataType
    The data type of the column.
    description string
    name string
    subType DataSetColumnDataSubType
    The sub data type of the column.
    type DataSetColumnDataType
    The data type of the column.
    description str
    name str
    sub_type DataSetColumnDataSubType
    The sub data type of the column.
    type DataSetColumnDataType
    The data type of the column.
    description String
    name String
    subType "FLOAT" | "FIXED"
    The sub data type of the column.
    type "STRING" | "INTEGER" | "DECIMAL" | "DATETIME"
    The data type of the column.

    DataSetOverrideDatasetParameterOperation

    ParameterName string
    NewDefaultValues DataSetNewDefaultValues
    The new default values for the parameter.
    NewParameterName string
    parameterName String
    newDefaultValues DataSetNewDefaultValues
    The new default values for the parameter.
    newParameterName String
    parameterName string
    newDefaultValues DataSetNewDefaultValues
    The new default values for the parameter.
    newParameterName string
    parameter_name str
    new_default_values DataSetNewDefaultValues
    The new default values for the parameter.
    new_parameter_name str
    parameterName String
    newDefaultValues Property Map
    The new default values for the parameter.
    newParameterName String

    DataSetPhysicalTable

    CustomSql Pulumi.AwsNative.QuickSight.Inputs.DataSetCustomSql
    A physical table type built from the results of the custom SQL query.
    RelationalTable Pulumi.AwsNative.QuickSight.Inputs.DataSetRelationalTable
    A physical table type for relational data sources.
    S3Source Pulumi.AwsNative.QuickSight.Inputs.DataSetS3Source
    A physical table type for as S3 data source.
    CustomSql DataSetCustomSql
    A physical table type built from the results of the custom SQL query.
    RelationalTable DataSetRelationalTable
    A physical table type for relational data sources.
    S3Source DataSetS3Source
    A physical table type for as S3 data source.
    customSql DataSetCustomSql
    A physical table type built from the results of the custom SQL query.
    relationalTable DataSetRelationalTable
    A physical table type for relational data sources.
    s3Source DataSetS3Source
    A physical table type for as S3 data source.
    customSql DataSetCustomSql
    A physical table type built from the results of the custom SQL query.
    relationalTable DataSetRelationalTable
    A physical table type for relational data sources.
    s3Source DataSetS3Source
    A physical table type for as S3 data source.
    custom_sql DataSetCustomSql
    A physical table type built from the results of the custom SQL query.
    relational_table DataSetRelationalTable
    A physical table type for relational data sources.
    s3_source DataSetS3Source
    A physical table type for as S3 data source.
    customSql Property Map
    A physical table type built from the results of the custom SQL query.
    relationalTable Property Map
    A physical table type for relational data sources.
    s3Source Property Map
    A physical table type for as S3 data source.

    DataSetProjectOperation

    ProjectedColumns List<string>
    projectedColumns List<String>
    projected_columns Sequence[str]
    projectedColumns List<String>

    DataSetRefreshConfiguration

    IncrementalRefresh DataSetIncrementalRefresh
    The incremental refresh for the dataset.
    incrementalRefresh DataSetIncrementalRefresh
    The incremental refresh for the dataset.
    incrementalRefresh DataSetIncrementalRefresh
    The incremental refresh for the dataset.
    incremental_refresh DataSetIncrementalRefresh
    The incremental refresh for the dataset.
    incrementalRefresh Property Map
    The incremental refresh for the dataset.

    DataSetRefreshProperties

    RefreshConfiguration DataSetRefreshConfiguration
    The refresh configuration for a dataset.
    refreshConfiguration DataSetRefreshConfiguration
    The refresh configuration for a dataset.
    refreshConfiguration DataSetRefreshConfiguration
    The refresh configuration for a dataset.
    refresh_configuration DataSetRefreshConfiguration
    The refresh configuration for a dataset.
    refreshConfiguration Property Map
    The refresh configuration for a dataset.

    DataSetRelationalTable

    DataSetRenameColumnOperation

    DataSetResourcePermission

    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

    Arn string
    PermissionPolicy Pulumi.AwsNative.QuickSight.DataSetRowLevelPermissionPolicy
    The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    FormatVersion Pulumi.AwsNative.QuickSight.DataSetRowLevelPermissionFormatVersion

    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.

    Namespace string
    Status Pulumi.AwsNative.QuickSight.DataSetStatus
    The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    Arn string
    PermissionPolicy DataSetRowLevelPermissionPolicy
    The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    FormatVersion DataSetRowLevelPermissionFormatVersion

    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.

    Namespace string
    Status DataSetStatus
    The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    arn String
    permissionPolicy DataSetRowLevelPermissionPolicy
    The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    formatVersion DataSetRowLevelPermissionFormatVersion

    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.

    namespace String
    status DataSetStatus
    The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    arn string
    permissionPolicy DataSetRowLevelPermissionPolicy
    The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    formatVersion DataSetRowLevelPermissionFormatVersion

    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.

    namespace string
    status DataSetStatus
    The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    arn str
    permission_policy DataSetRowLevelPermissionPolicy
    The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    format_version DataSetRowLevelPermissionFormatVersion

    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.

    namespace str
    status DataSetStatus
    The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    arn String
    permissionPolicy "GRANT_ACCESS" | "DENY_ACCESS"
    The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    formatVersion "VERSION_1" | "VERSION_2"

    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.

    namespace String
    status "ENABLED" | "DISABLED"
    The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .

    DataSetRowLevelPermissionFormatVersion

    DataSetRowLevelPermissionPolicy

    DataSetRowLevelPermissionTagConfiguration

    TagRules List<Pulumi.AwsNative.QuickSight.Inputs.DataSetRowLevelPermissionTagRule>
    Status Pulumi.AwsNative.QuickSight.DataSetStatus
    The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    TagRuleConfigurations List<ImmutableArray<string>>
    TagRules []DataSetRowLevelPermissionTagRule
    Status DataSetStatus
    The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    TagRuleConfigurations [][]string
    tagRules List<DataSetRowLevelPermissionTagRule>
    status DataSetStatus
    The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    tagRuleConfigurations List<List<String>>
    tagRules DataSetRowLevelPermissionTagRule[]
    status DataSetStatus
    The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    tagRuleConfigurations string[][]
    tag_rules Sequence[DataSetRowLevelPermissionTagRule]
    status DataSetStatus
    The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    tag_rule_configurations Sequence[Sequence[str]]
    tagRules List<Property Map>
    status "ENABLED" | "DISABLED"
    The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
    tagRuleConfigurations List<List<String>>

    DataSetRowLevelPermissionTagRule

    DataSetS3Source

    DataSourceArn string
    InputColumns []DataSetInputColumn
    UploadSettings DataSetUploadSettings
    Information about the format for the S3 source file or files.
    dataSourceArn String
    inputColumns List<DataSetInputColumn>
    uploadSettings DataSetUploadSettings
    Information about the format for the S3 source file or files.
    dataSourceArn string
    inputColumns DataSetInputColumn[]
    uploadSettings DataSetUploadSettings
    Information about the format for the S3 source file or files.
    data_source_arn str
    input_columns Sequence[DataSetInputColumn]
    upload_settings DataSetUploadSettings
    Information about the format for the S3 source file or files.
    dataSourceArn String
    inputColumns List<Property Map>
    uploadSettings Property Map
    Information about the format for the S3 source file or files.

    DataSetStatus

    DataSetStringDatasetParameter

    Id string
    Name string
    ValueType Pulumi.AwsNative.QuickSight.DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    DefaultValues Pulumi.AwsNative.QuickSight.Inputs.DataSetStringDatasetParameterDefaultValues
    A list of default values for a given string dataset parameter type. This structure only accepts static values.
    Id string
    Name string
    ValueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    DefaultValues DataSetStringDatasetParameterDefaultValues
    A list of default values for a given string dataset parameter type. This structure only accepts static values.
    id String
    name String
    valueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues DataSetStringDatasetParameterDefaultValues
    A list of default values for a given string dataset parameter type. This structure only accepts static values.
    id string
    name string
    valueType DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues DataSetStringDatasetParameterDefaultValues
    A list of default values for a given string dataset parameter type. This structure only accepts static values.
    id str
    name str
    value_type DataSetDatasetParameterValueType
    The value type of the dataset parameter. Valid values are single value or multi value .
    default_values DataSetStringDatasetParameterDefaultValues
    A list of default values for a given string dataset parameter type. This structure only accepts static values.
    id String
    name String
    valueType "MULTI_VALUED" | "SINGLE_VALUED"
    The value type of the dataset parameter. Valid values are single value or multi value .
    defaultValues Property Map
    A list of default values for a given string dataset parameter type. This structure only accepts static values.

    DataSetStringDatasetParameterDefaultValues

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

    DataSetTagColumnOperation

    DataSetTextQualifier

    DataSetTimeGranularity

    DataSetTransformOperation

    CastColumnTypeOperation Pulumi.AwsNative.QuickSight.Inputs.DataSetCastColumnTypeOperation
    A transform operation that casts a column to a different type.
    CreateColumnsOperation Pulumi.AwsNative.QuickSight.Inputs.DataSetCreateColumnsOperation
    An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
    FilterOperation Pulumi.AwsNative.QuickSight.Inputs.DataSetFilterOperation
    An operation that filters rows based on some condition.
    OverrideDatasetParameterOperation Pulumi.AwsNative.QuickSight.Inputs.DataSetOverrideDatasetParameterOperation
    A transform operation that overrides the dataset parameter values that are defined in another dataset.
    ProjectOperation Pulumi.AwsNative.QuickSight.Inputs.DataSetProjectOperation
    An operation that projects columns. Operations that come after a projection can only refer to projected columns.
    RenameColumnOperation Pulumi.AwsNative.QuickSight.Inputs.DataSetRenameColumnOperation
    An operation that renames a column.
    TagColumnOperation Pulumi.AwsNative.QuickSight.Inputs.DataSetTagColumnOperation
    An operation that tags a column with additional information.
    UntagColumnOperation Pulumi.AwsNative.QuickSight.Inputs.DataSetUntagColumnOperation
    CastColumnTypeOperation DataSetCastColumnTypeOperation
    A transform operation that casts a column to a different type.
    CreateColumnsOperation DataSetCreateColumnsOperation
    An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
    FilterOperation DataSetFilterOperation
    An operation that filters rows based on some condition.
    OverrideDatasetParameterOperation DataSetOverrideDatasetParameterOperation
    A transform operation that overrides the dataset parameter values that are defined in another dataset.
    ProjectOperation DataSetProjectOperation
    An operation that projects columns. Operations that come after a projection can only refer to projected columns.
    RenameColumnOperation DataSetRenameColumnOperation
    An operation that renames a column.
    TagColumnOperation DataSetTagColumnOperation
    An operation that tags a column with additional information.
    UntagColumnOperation DataSetUntagColumnOperation
    castColumnTypeOperation DataSetCastColumnTypeOperation
    A transform operation that casts a column to a different type.
    createColumnsOperation DataSetCreateColumnsOperation
    An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
    filterOperation DataSetFilterOperation
    An operation that filters rows based on some condition.
    overrideDatasetParameterOperation DataSetOverrideDatasetParameterOperation
    A transform operation that overrides the dataset parameter values that are defined in another dataset.
    projectOperation DataSetProjectOperation
    An operation that projects columns. Operations that come after a projection can only refer to projected columns.
    renameColumnOperation DataSetRenameColumnOperation
    An operation that renames a column.
    tagColumnOperation DataSetTagColumnOperation
    An operation that tags a column with additional information.
    untagColumnOperation DataSetUntagColumnOperation
    castColumnTypeOperation DataSetCastColumnTypeOperation
    A transform operation that casts a column to a different type.
    createColumnsOperation DataSetCreateColumnsOperation
    An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
    filterOperation DataSetFilterOperation
    An operation that filters rows based on some condition.
    overrideDatasetParameterOperation DataSetOverrideDatasetParameterOperation
    A transform operation that overrides the dataset parameter values that are defined in another dataset.
    projectOperation DataSetProjectOperation
    An operation that projects columns. Operations that come after a projection can only refer to projected columns.
    renameColumnOperation DataSetRenameColumnOperation
    An operation that renames a column.
    tagColumnOperation DataSetTagColumnOperation
    An operation that tags a column with additional information.
    untagColumnOperation DataSetUntagColumnOperation
    cast_column_type_operation DataSetCastColumnTypeOperation
    A transform operation that casts a column to a different type.
    create_columns_operation DataSetCreateColumnsOperation
    An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
    filter_operation DataSetFilterOperation
    An operation that filters rows based on some condition.
    override_dataset_parameter_operation DataSetOverrideDatasetParameterOperation
    A transform operation that overrides the dataset parameter values that are defined in another dataset.
    project_operation DataSetProjectOperation
    An operation that projects columns. Operations that come after a projection can only refer to projected columns.
    rename_column_operation DataSetRenameColumnOperation
    An operation that renames a column.
    tag_column_operation DataSetTagColumnOperation
    An operation that tags a column with additional information.
    untag_column_operation DataSetUntagColumnOperation
    castColumnTypeOperation Property Map
    A transform operation that casts a column to a different type.
    createColumnsOperation Property Map
    An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
    filterOperation Property Map
    An operation that filters rows based on some condition.
    overrideDatasetParameterOperation Property Map
    A transform operation that overrides the dataset parameter values that are defined in another dataset.
    projectOperation Property Map
    An operation that projects columns. Operations that come after a projection can only refer to projected columns.
    renameColumnOperation Property Map
    An operation that renames a column.
    tagColumnOperation Property Map
    An operation that tags a column with additional information.
    untagColumnOperation Property Map

    DataSetUntagColumnOperation

    DataSetUploadSettings

    DataSetUsageConfiguration

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi