pulumi-aws-kotlin/com.pulumi.aws.quicksight.kotlin/DataSetArgs

DataSetArgs

data class DataSetArgs(val awsAccountId: Output<String>? = null, val columnGroups: Output<List<DataSetColumnGroupArgs>>? = null, val columnLevelPermissionRules: Output<List<DataSetColumnLevelPermissionRuleArgs>>? = null, val dataSetId: Output<String>? = null, val dataSetUsageConfiguration: Output<DataSetDataSetUsageConfigurationArgs>? = null, val fieldFolders: Output<List<DataSetFieldFolderArgs>>? = null, val importMode: Output<String>? = null, val logicalTableMaps: Output<List<DataSetLogicalTableMapArgs>>? = null, val name: Output<String>? = null, val permissions: Output<List<DataSetPermissionArgs>>? = null, val physicalTableMaps: Output<List<DataSetPhysicalTableMapArgs>>? = null, val refreshProperties: Output<DataSetRefreshPropertiesArgs>? = null, val rowLevelPermissionDataSet: Output<DataSetRowLevelPermissionDataSetArgs>? = null, val rowLevelPermissionTagConfiguration: Output<DataSetRowLevelPermissionTagConfigurationArgs>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<DataSetArgs>

Resource for managing a QuickSight Data Set.

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.DataSet;
import com.pulumi.aws.quicksight.DataSetArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapS3SourceArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new DataSet("example", DataSetArgs.builder()
            .dataSetId("example-id")
            .importMode("SPICE")
            .physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
                .physicalTableMapId("example-id")
                .s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
                    .dataSourceArn(aws_quicksight_data_source.example().arn())
                    .inputColumns(DataSetPhysicalTableMapS3SourceInputColumnArgs.builder()
                        .name("Column1")
                        .type("STRING")
                        .build())
                    .uploadSettings(DataSetPhysicalTableMapS3SourceUploadSettingsArgs.builder()
                        .format("JSON")
                        .build())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

With Column Level Permission Rules

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.DataSet;
import com.pulumi.aws.quicksight.DataSetArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapS3SourceArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs;
import com.pulumi.aws.quicksight.inputs.DataSetColumnLevelPermissionRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new DataSet("example", DataSetArgs.builder()
            .dataSetId("example-id")
            .importMode("SPICE")
            .physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
                .physicalTableMapId("example-id")
                .s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
                    .dataSourceArn(aws_quicksight_data_source.example().arn())
                    .inputColumns(DataSetPhysicalTableMapS3SourceInputColumnArgs.builder()
                        .name("Column1")
                        .type("STRING")
                        .build())
                    .uploadSettings(DataSetPhysicalTableMapS3SourceUploadSettingsArgs.builder()
                        .format("JSON")
                        .build())
                    .build())
                .build())
            .columnLevelPermissionRules(DataSetColumnLevelPermissionRuleArgs.builder()
                .columnNames("Column1")
                .principals(aws_quicksight_user.example().arn())
                .build())
            .build());
    }
}
Content copied to clipboard

With Field Folders

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.DataSet;
import com.pulumi.aws.quicksight.DataSetArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapS3SourceArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs;
import com.pulumi.aws.quicksight.inputs.DataSetFieldFolderArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new DataSet("example", DataSetArgs.builder()
            .dataSetId("example-id")
            .importMode("SPICE")
            .physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
                .physicalTableMapId("example-id")
                .s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
                    .dataSourceArn(aws_quicksight_data_source.example().arn())
                    .inputColumns(DataSetPhysicalTableMapS3SourceInputColumnArgs.builder()
                        .name("Column1")
                        .type("STRING")
                        .build())
                    .uploadSettings(DataSetPhysicalTableMapS3SourceUploadSettingsArgs.builder()
                        .format("JSON")
                        .build())
                    .build())
                .build())
            .fieldFolders(DataSetFieldFolderArgs.builder()
                .fieldFoldersId("example-id")
                .columns("Column1")
                .description("example description")
                .build())
            .build());
    }
}
Content copied to clipboard

With Permissions

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.DataSet;
import com.pulumi.aws.quicksight.DataSetArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapS3SourceArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPermissionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new DataSet("example", DataSetArgs.builder()
            .dataSetId("example-id")
            .importMode("SPICE")
            .physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
                .physicalTableMapId("example-id")
                .s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
                    .dataSourceArn(aws_quicksight_data_source.example().arn())
                    .inputColumns(DataSetPhysicalTableMapS3SourceInputColumnArgs.builder()
                        .name("Column1")
                        .type("STRING")
                        .build())
                    .uploadSettings(DataSetPhysicalTableMapS3SourceUploadSettingsArgs.builder()
                        .format("JSON")
                        .build())
                    .build())
                .build())
            .permissions(DataSetPermissionArgs.builder()
                .actions(
                    "quicksight:DescribeDataSet",
                    "quicksight:DescribeDataSetPermissions",
                    "quicksight:PassDataSet",
                    "quicksight:DescribeIngestion",
                    "quicksight:ListIngestions")
                .principal(aws_quicksight_user.example().arn())
                .build())
            .build());
    }
}
Content copied to clipboard

With Row Level Permission Tag Configuration

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.DataSet;
import com.pulumi.aws.quicksight.DataSetArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapS3SourceArgs;
import com.pulumi.aws.quicksight.inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs;
import com.pulumi.aws.quicksight.inputs.DataSetRowLevelPermissionTagConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new DataSet("example", DataSetArgs.builder()
            .dataSetId("example-id")
            .importMode("SPICE")
            .physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
                .physicalTableMapId("example-id")
                .s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
                    .dataSourceArn(aws_quicksight_data_source.example().arn())
                    .inputColumns(DataSetPhysicalTableMapS3SourceInputColumnArgs.builder()
                        .name("Column1")
                        .type("STRING")
                        .build())
                    .uploadSettings(DataSetPhysicalTableMapS3SourceUploadSettingsArgs.builder()
                        .format("JSON")
                        .build())
                    .build())
                .build())
            .rowLevelPermissionTagConfiguration(DataSetRowLevelPermissionTagConfigurationArgs.builder()
                .status("ENABLED")
                .tagRules(DataSetRowLevelPermissionTagConfigurationTagRuleArgs.builder()
                    .columnName("Column1")
                    .tagKey("tagkey")
                    .matchAllValue("*")
                    .tagMultiValueDelimiter(",")
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Import

Using pulumi import, import a QuickSight Data Set using the AWS account ID and data set ID separated by a comma (,). For example:

$ pulumi import aws:quicksight/dataSet:DataSet example 123456789012,example-id
Content copied to clipboard

Constructors

Link copied to clipboard
fun DataSetArgs(awsAccountId: Output<String>? = null, columnGroups: Output<List<DataSetColumnGroupArgs>>? = null, columnLevelPermissionRules: Output<List<DataSetColumnLevelPermissionRuleArgs>>? = null, dataSetId: Output<String>? = null, dataSetUsageConfiguration: Output<DataSetDataSetUsageConfigurationArgs>? = null, fieldFolders: Output<List<DataSetFieldFolderArgs>>? = null, importMode: Output<String>? = null, logicalTableMaps: Output<List<DataSetLogicalTableMapArgs>>? = null, name: Output<String>? = null, permissions: Output<List<DataSetPermissionArgs>>? = null, physicalTableMaps: Output<List<DataSetPhysicalTableMapArgs>>? = null, refreshProperties: Output<DataSetRefreshPropertiesArgs>? = null, rowLevelPermissionDataSet: Output<DataSetRowLevelPermissionDataSetArgs>? = null, rowLevelPermissionTagConfiguration: Output<DataSetRowLevelPermissionTagConfigurationArgs>? = null, tags: Output<Map<String, String>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): DataSetArgs

Properties

Link copied to clipboard
val awsAccountId: Output<String>? = null

AWS account ID.

Link copied to clipboard
val columnGroups: Output<List<DataSetColumnGroupArgs>>? = null

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.

Link copied to clipboard
val columnLevelPermissionRules: Output<List<DataSetColumnLevelPermissionRuleArgs>>? = null

A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.

Link copied to clipboard
val dataSetId: Output<String>? = null

Identifier for the data set.

Link copied to clipboard
val dataSetUsageConfiguration: Output<DataSetDataSetUsageConfigurationArgs>? = null

The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.

Link copied to clipboard
val fieldFolders: Output<List<DataSetFieldFolderArgs>>? = null

The folder that contains fields and nested subfolders for your dataset. See field_folders.

Link copied to clipboard
val importMode: Output<String>? = null

Indicates whether you want to import the data into SPICE. Valid values are SPICE and DIRECT_QUERY.

Link copied to clipboard
val logicalTableMaps: Output<List<DataSetLogicalTableMapArgs>>? = null

Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.

Link copied to clipboard
val name: Output<String>? = null

Display name for the dataset.

Link copied to clipboard
val permissions: Output<List<DataSetPermissionArgs>>? = null

A set of resource permissions on the data source. Maximum of 64 items. See permissions.

Link copied to clipboard
val physicalTableMaps: Output<List<DataSetPhysicalTableMapArgs>>? = null

Declares the physical tables that are available in the underlying data sources. See physical_table_map. The following arguments are optional:

Link copied to clipboard
val refreshProperties: Output<DataSetRefreshPropertiesArgs>? = null

The refresh properties for the data set. NOTE: Only valid when import_mode is set to SPICE. See refresh_properties.

Link copied to clipboard
val rowLevelPermissionDataSet: Output<DataSetRowLevelPermissionDataSetArgs>? = null

The row-level security configuration for the data that you want to create. See row_level_permission_data_set.

Link copied to clipboard
val rowLevelPermissionTagConfiguration: Output<DataSetRowLevelPermissionTagConfigurationArgs>? = null

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. See row_level_permission_tag_configuration.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.