aws-native.quicksight.DataSet

Explore with Pulumi AI

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

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

Create DataSet Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DataSet(name: string, args?: DataSetArgs, opts?: CustomResourceOptions);

@overload
def DataSet(resource_name: str,
            args: Optional[DataSetArgs] = None,
            opts: Optional[ResourceOptions] = None)

@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[Mapping[str, DataSetFieldFolderArgs]] = None,
            import_mode: Optional[DataSetImportMode] = None,
            ingestion_wait_policy: Optional[DataSetIngestionWaitPolicyArgs] = None,
            logical_table_map: Optional[Mapping[str, DataSetLogicalTableArgs]] = None,
            name: Optional[str] = None,
            permissions: Optional[Sequence[DataSetResourcePermissionArgs]] = None,
            physical_table_map: Optional[Mapping[str, DataSetPhysicalTableArgs]] = None,
            row_level_permission_data_set: Optional[DataSetRowLevelPermissionDataSetArgs] = None,
            row_level_permission_tag_configuration: Optional[DataSetRowLevelPermissionTagConfigurationArgs] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = 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.

Parameters

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.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const dataSetResource = new aws_native.quicksight.DataSet("dataSetResource", {
    awsAccountId: "string",
    columnGroups: [{
        geoSpatialColumnGroup: {
            columns: ["string"],
            name: "string",
            countryCode: aws_native.quicksight.DataSetGeoSpatialCountryCode.Us,
        },
    }],
    columnLevelPermissionRules: [{
        columnNames: ["string"],
        principals: ["string"],
    }],
    dataSetId: "string",
    dataSetRefreshProperties: {
        refreshConfiguration: {
            incrementalRefresh: {
                lookbackWindow: {
                    columnName: "string",
                    size: 0,
                    sizeUnit: aws_native.quicksight.DataSetSizeUnit.Hour,
                },
            },
        },
    },
    dataSetUsageConfiguration: {
        disableUseAsDirectQuerySource: false,
        disableUseAsImportedSource: false,
    },
    datasetParameters: [{
        dateTimeDatasetParameter: {
            id: "string",
            name: "string",
            valueType: aws_native.quicksight.DataSetDatasetParameterValueType.MultiValued,
            defaultValues: {
                staticValues: ["string"],
            },
            timeGranularity: aws_native.quicksight.DataSetTimeGranularity.Year,
        },
        decimalDatasetParameter: {
            id: "string",
            name: "string",
            valueType: aws_native.quicksight.DataSetDatasetParameterValueType.MultiValued,
            defaultValues: {
                staticValues: [0],
            },
        },
        integerDatasetParameter: {
            id: "string",
            name: "string",
            valueType: aws_native.quicksight.DataSetDatasetParameterValueType.MultiValued,
            defaultValues: {
                staticValues: [0],
            },
        },
        stringDatasetParameter: {
            id: "string",
            name: "string",
            valueType: aws_native.quicksight.DataSetDatasetParameterValueType.MultiValued,
            defaultValues: {
                staticValues: ["string"],
            },
        },
    }],
    fieldFolders: {
        string: {
            columns: ["string"],
            description: "string",
        },
    },
    importMode: aws_native.quicksight.DataSetImportMode.Spice,
    ingestionWaitPolicy: {
        ingestionWaitTimeInHours: 0,
        waitForSpiceIngestion: false,
    },
    logicalTableMap: {
        string: {
            alias: "string",
            source: {
                dataSetArn: "string",
                joinInstruction: {
                    leftOperand: "string",
                    onClause: "string",
                    rightOperand: "string",
                    type: aws_native.quicksight.DataSetJoinType.Inner,
                    leftJoinKeyProperties: {
                        uniqueKey: false,
                    },
                    rightJoinKeyProperties: {
                        uniqueKey: false,
                    },
                },
                physicalTableId: "string",
            },
            dataTransforms: [{
                castColumnTypeOperation: {
                    columnName: "string",
                    newColumnType: aws_native.quicksight.DataSetColumnDataType.String,
                    format: "string",
                    subType: aws_native.quicksight.DataSetColumnSubDataType.Fixed,
                },
                createColumnsOperation: {
                    columns: [{
                        columnId: "string",
                        columnName: "string",
                        expression: "string",
                    }],
                },
                filterOperation: {
                    conditionExpression: "string",
                },
                overrideDatasetParameterOperation: {
                    parameterName: "string",
                    newDefaultValues: {
                        dateTimeStaticValues: ["string"],
                        decimalStaticValues: [0],
                        integerStaticValues: [0],
                        stringStaticValues: ["string"],
                    },
                    newParameterName: "string",
                },
                projectOperation: {
                    projectedColumns: ["string"],
                },
                renameColumnOperation: {
                    columnName: "string",
                    newColumnName: "string",
                },
                tagColumnOperation: {
                    columnName: "string",
                    tags: [{
                        columnDescription: {
                            text: "string",
                        },
                        columnGeographicRole: aws_native.quicksight.DataSetGeoSpatialDataRole.Country,
                    }],
                },
            }],
        },
    },
    name: "string",
    permissions: [{
        actions: ["string"],
        principal: "string",
    }],
    physicalTableMap: {
        string: {
            customSql: {
                columns: [{
                    name: "string",
                    type: aws_native.quicksight.DataSetInputColumnDataType.String,
                    subType: aws_native.quicksight.DataSetColumnSubDataType.Fixed,
                }],
                dataSourceArn: "string",
                name: "string",
                sqlQuery: "string",
            },
            relationalTable: {
                dataSourceArn: "string",
                inputColumns: [{
                    name: "string",
                    type: aws_native.quicksight.DataSetInputColumnDataType.String,
                    subType: aws_native.quicksight.DataSetColumnSubDataType.Fixed,
                }],
                name: "string",
                catalog: "string",
                schema: "string",
            },
            s3Source: {
                dataSourceArn: "string",
                inputColumns: [{
                    name: "string",
                    type: aws_native.quicksight.DataSetInputColumnDataType.String,
                    subType: aws_native.quicksight.DataSetColumnSubDataType.Fixed,
                }],
                uploadSettings: {
                    containsHeader: false,
                    delimiter: "string",
                    format: aws_native.quicksight.DataSetFileFormat.Csv,
                    startFromRow: 0,
                    textQualifier: aws_native.quicksight.DataSetTextQualifier.DoubleQuote,
                },
            },
        },
    },
    rowLevelPermissionDataSet: {
        arn: "string",
        permissionPolicy: aws_native.quicksight.DataSetRowLevelPermissionPolicy.GrantAccess,
        formatVersion: aws_native.quicksight.DataSetRowLevelPermissionFormatVersion.Version1,
        namespace: "string",
        status: aws_native.quicksight.DataSetStatus.Enabled,
    },
    rowLevelPermissionTagConfiguration: {
        tagRules: [{
            columnName: "string",
            tagKey: "string",
            matchAllValue: "string",
            tagMultiValueDelimiter: "string",
        }],
        status: aws_native.quicksight.DataSetStatus.Enabled,
        tagRuleConfigurations: [["string"]],
    },
    tags: [{
        key: "string",
        value: "string",
    }],
});