Docs Home
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
aws.quicksight.DataSet
Explore with Pulumi AI
Resource for managing a QuickSight Data Set.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.DataSet("example", {
dataSetId: "example-id",
name: "example-name",
importMode: "SPICE",
physicalTableMaps: [{
physicalTableMapId: "example-id",
s3Source: {
dataSourceArn: exampleAwsQuicksightDataSource.arn,
inputColumns: [{
name: "Column1",
type: "STRING",
}],
uploadSettings: {
format: "JSON",
},
},
}],
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.DataSet("example",
data_set_id="example-id",
name="example-name",
import_mode="SPICE",
physical_table_maps=[{
"physical_table_map_id": "example-id",
"s3_source": {
"data_source_arn": example_aws_quicksight_data_source["arn"],
"input_columns": [{
"name": "Column1",
"type": "STRING",
}],
"upload_settings": {
"format": "JSON",
},
},
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewDataSet(ctx, "example", &quicksight.DataSetArgs{
DataSetId: pulumi.String("example-id"),
Name: pulumi.String("example-name"),
ImportMode: pulumi.String("SPICE"),
PhysicalTableMaps: quicksight.DataSetPhysicalTableMapArray{
&quicksight.DataSetPhysicalTableMapArgs{
PhysicalTableMapId: pulumi.String("example-id"),
S3Source: &quicksight.DataSetPhysicalTableMapS3SourceArgs{
DataSourceArn: pulumi.Any(exampleAwsQuicksightDataSource.Arn),
InputColumns: quicksight.DataSetPhysicalTableMapS3SourceInputColumnArray{
&quicksight.DataSetPhysicalTableMapS3SourceInputColumnArgs{
Name: pulumi.String("Column1"),
Type: pulumi.String("STRING"),
},
},
UploadSettings: &quicksight.DataSetPhysicalTableMapS3SourceUploadSettingsArgs{
Format: pulumi.String("JSON"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.DataSet("example", new()
{
DataSetId = "example-id",
Name = "example-name",
ImportMode = "SPICE",
PhysicalTableMaps = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapArgs
{
PhysicalTableMapId = "example-id",
S3Source = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceArgs
{
DataSourceArn = exampleAwsQuicksightDataSource.Arn,
InputColumns = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceInputColumnArgs
{
Name = "Column1",
Type = "STRING",
},
},
UploadSettings = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs
{
Format = "JSON",
},
},
},
},
});
});
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")
.name("example-name")
.importMode("SPICE")
.physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
.physicalTableMapId("example-id")
.s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
.dataSourceArn(exampleAwsQuicksightDataSource.arn())
.inputColumns(DataSetPhysicalTableMapS3SourceInputColumnArgs.builder()
.name("Column1")
.type("STRING")
.build())
.uploadSettings(DataSetPhysicalTableMapS3SourceUploadSettingsArgs.builder()
.format("JSON")
.build())
.build())
.build())
.build());
}
}
resources:
example:
type: aws:quicksight:DataSet
properties:
dataSetId: example-id
name: example-name
importMode: SPICE
physicalTableMaps:
- physicalTableMapId: example-id
s3Source:
dataSourceArn: ${exampleAwsQuicksightDataSource.arn}
inputColumns:
- name: Column1
type: STRING
uploadSettings:
format: JSON
With Column Level Permission Rules
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.DataSet("example", {
dataSetId: "example-id",
name: "example-name",
importMode: "SPICE",
physicalTableMaps: [{
physicalTableMapId: "example-id",
s3Source: {
dataSourceArn: exampleAwsQuicksightDataSource.arn,
inputColumns: [{
name: "Column1",
type: "STRING",
}],
uploadSettings: {
format: "JSON",
},
},
}],
columnLevelPermissionRules: [{
columnNames: ["Column1"],
principals: [exampleAwsQuicksightUser.arn],
}],
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.DataSet("example",
data_set_id="example-id",
name="example-name",
import_mode="SPICE",
physical_table_maps=[{
"physical_table_map_id": "example-id",
"s3_source": {
"data_source_arn": example_aws_quicksight_data_source["arn"],
"input_columns": [{
"name": "Column1",
"type": "STRING",
}],
"upload_settings": {
"format": "JSON",
},
},
}],
column_level_permission_rules=[{
"column_names": ["Column1"],
"principals": [example_aws_quicksight_user["arn"]],
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewDataSet(ctx, "example", &quicksight.DataSetArgs{
DataSetId: pulumi.String("example-id"),
Name: pulumi.String("example-name"),
ImportMode: pulumi.String("SPICE"),
PhysicalTableMaps: quicksight.DataSetPhysicalTableMapArray{
&quicksight.DataSetPhysicalTableMapArgs{
PhysicalTableMapId: pulumi.String("example-id"),
S3Source: &quicksight.DataSetPhysicalTableMapS3SourceArgs{
DataSourceArn: pulumi.Any(exampleAwsQuicksightDataSource.Arn),
InputColumns: quicksight.DataSetPhysicalTableMapS3SourceInputColumnArray{
&quicksight.DataSetPhysicalTableMapS3SourceInputColumnArgs{
Name: pulumi.String("Column1"),
Type: pulumi.String("STRING"),
},
},
UploadSettings: &quicksight.DataSetPhysicalTableMapS3SourceUploadSettingsArgs{
Format: pulumi.String("JSON"),
},
},
},
},
ColumnLevelPermissionRules: quicksight.DataSetColumnLevelPermissionRuleArray{
&quicksight.DataSetColumnLevelPermissionRuleArgs{
ColumnNames: pulumi.StringArray{
pulumi.String("Column1"),
},
Principals: pulumi.StringArray{
exampleAwsQuicksightUser.Arn,
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.DataSet("example", new()
{
DataSetId = "example-id",
Name = "example-name",
ImportMode = "SPICE",
PhysicalTableMaps = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapArgs
{
PhysicalTableMapId = "example-id",
S3Source = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceArgs
{
DataSourceArn = exampleAwsQuicksightDataSource.Arn,
InputColumns = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceInputColumnArgs
{
Name = "Column1",
Type = "STRING",
},
},
UploadSettings = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs
{
Format = "JSON",
},
},
},
},
ColumnLevelPermissionRules = new[]
{
new Aws.Quicksight.Inputs.DataSetColumnLevelPermissionRuleArgs
{
ColumnNames = new[]
{
"Column1",
},
Principals = new[]
{
exampleAwsQuicksightUser.Arn,
},
},
},
});
});
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")
.name("example-name")
.importMode("SPICE")
.physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
.physicalTableMapId("example-id")
.s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
.dataSourceArn(exampleAwsQuicksightDataSource.arn())
.inputColumns(DataSetPhysicalTableMapS3SourceInputColumnArgs.builder()
.name("Column1")
.type("STRING")
.build())
.uploadSettings(DataSetPhysicalTableMapS3SourceUploadSettingsArgs.builder()
.format("JSON")
.build())
.build())
.build())
.columnLevelPermissionRules(DataSetColumnLevelPermissionRuleArgs.builder()
.columnNames("Column1")
.principals(exampleAwsQuicksightUser.arn())
.build())
.build());
}
}
resources:
example:
type: aws:quicksight:DataSet
properties:
dataSetId: example-id
name: example-name
importMode: SPICE
physicalTableMaps:
- physicalTableMapId: example-id
s3Source:
dataSourceArn: ${exampleAwsQuicksightDataSource.arn}
inputColumns:
- name: Column1
type: STRING
uploadSettings:
format: JSON
columnLevelPermissionRules:
- columnNames:
- Column1
principals:
- ${exampleAwsQuicksightUser.arn}
With Field Folders
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.DataSet("example", {
dataSetId: "example-id",
name: "example-name",
importMode: "SPICE",
physicalTableMaps: [{
physicalTableMapId: "example-id",
s3Source: {
dataSourceArn: exampleAwsQuicksightDataSource.arn,
inputColumns: [{
name: "Column1",
type: "STRING",
}],
uploadSettings: {
format: "JSON",
},
},
}],
fieldFolders: [{
fieldFoldersId: "example-id",
columns: ["Column1"],
description: "example description",
}],
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.DataSet("example",
data_set_id="example-id",
name="example-name",
import_mode="SPICE",
physical_table_maps=[{
"physical_table_map_id": "example-id",
"s3_source": {
"data_source_arn": example_aws_quicksight_data_source["arn"],
"input_columns": [{
"name": "Column1",
"type": "STRING",
}],
"upload_settings": {
"format": "JSON",
},
},
}],
field_folders=[{
"field_folders_id": "example-id",
"columns": ["Column1"],
"description": "example description",
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewDataSet(ctx, "example", &quicksight.DataSetArgs{
DataSetId: pulumi.String("example-id"),
Name: pulumi.String("example-name"),
ImportMode: pulumi.String("SPICE"),
PhysicalTableMaps: quicksight.DataSetPhysicalTableMapArray{
&quicksight.DataSetPhysicalTableMapArgs{
PhysicalTableMapId: pulumi.String("example-id"),
S3Source: &quicksight.DataSetPhysicalTableMapS3SourceArgs{
DataSourceArn: pulumi.Any(exampleAwsQuicksightDataSource.Arn),
InputColumns: quicksight.DataSetPhysicalTableMapS3SourceInputColumnArray{
&quicksight.DataSetPhysicalTableMapS3SourceInputColumnArgs{
Name: pulumi.String("Column1"),
Type: pulumi.String("STRING"),
},
},
UploadSettings: &quicksight.DataSetPhysicalTableMapS3SourceUploadSettingsArgs{
Format: pulumi.String("JSON"),
},
},
},
},
FieldFolders: quicksight.DataSetFieldFolderArray{
&quicksight.DataSetFieldFolderArgs{
FieldFoldersId: pulumi.String("example-id"),
Columns: pulumi.StringArray{
pulumi.String("Column1"),
},
Description: pulumi.String("example description"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.DataSet("example", new()
{
DataSetId = "example-id",
Name = "example-name",
ImportMode = "SPICE",
PhysicalTableMaps = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapArgs
{
PhysicalTableMapId = "example-id",
S3Source = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceArgs
{
DataSourceArn = exampleAwsQuicksightDataSource.Arn,
InputColumns = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceInputColumnArgs
{
Name = "Column1",
Type = "STRING",
},
},
UploadSettings = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs
{
Format = "JSON",
},
},
},
},
FieldFolders = new[]
{
new Aws.Quicksight.Inputs.DataSetFieldFolderArgs
{
FieldFoldersId = "example-id",
Columns = new[]
{
"Column1",
},
Description = "example description",
},
},
});
});
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")
.name("example-name")
.importMode("SPICE")
.physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
.physicalTableMapId("example-id")
.s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
.dataSourceArn(exampleAwsQuicksightDataSource.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());
}
}
resources:
example:
type: aws:quicksight:DataSet
properties:
dataSetId: example-id
name: example-name
importMode: SPICE
physicalTableMaps:
- physicalTableMapId: example-id
s3Source:
dataSourceArn: ${exampleAwsQuicksightDataSource.arn}
inputColumns:
- name: Column1
type: STRING
uploadSettings:
format: JSON
fieldFolders:
- fieldFoldersId: example-id
columns:
- Column1
description: example description
With Permissions
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.DataSet("example", {
dataSetId: "example-id",
name: "example-name",
importMode: "SPICE",
physicalTableMaps: [{
physicalTableMapId: "example-id",
s3Source: {
dataSourceArn: exampleAwsQuicksightDataSource.arn,
inputColumns: [{
name: "Column1",
type: "STRING",
}],
uploadSettings: {
format: "JSON",
},
},
}],
permissions: [{
actions: [
"quicksight:DescribeDataSet",
"quicksight:DescribeDataSetPermissions",
"quicksight:PassDataSet",
"quicksight:DescribeIngestion",
"quicksight:ListIngestions",
],
principal: exampleAwsQuicksightUser.arn,
}],
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.DataSet("example",
data_set_id="example-id",
name="example-name",
import_mode="SPICE",
physical_table_maps=[{
"physical_table_map_id": "example-id",
"s3_source": {
"data_source_arn": example_aws_quicksight_data_source["arn"],
"input_columns": [{
"name": "Column1",
"type": "STRING",
}],
"upload_settings": {
"format": "JSON",
},
},
}],
permissions=[{
"actions": [
"quicksight:DescribeDataSet",
"quicksight:DescribeDataSetPermissions",
"quicksight:PassDataSet",
"quicksight:DescribeIngestion",
"quicksight:ListIngestions",
],
"principal": example_aws_quicksight_user["arn"],
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewDataSet(ctx, "example", &quicksight.DataSetArgs{
DataSetId: pulumi.String("example-id"),
Name: pulumi.String("example-name"),
ImportMode: pulumi.String("SPICE"),
PhysicalTableMaps: quicksight.DataSetPhysicalTableMapArray{
&quicksight.DataSetPhysicalTableMapArgs{
PhysicalTableMapId: pulumi.String("example-id"),
S3Source: &quicksight.DataSetPhysicalTableMapS3SourceArgs{
DataSourceArn: pulumi.Any(exampleAwsQuicksightDataSource.Arn),
InputColumns: quicksight.DataSetPhysicalTableMapS3SourceInputColumnArray{
&quicksight.DataSetPhysicalTableMapS3SourceInputColumnArgs{
Name: pulumi.String("Column1"),
Type: pulumi.String("STRING"),
},
},
UploadSettings: &quicksight.DataSetPhysicalTableMapS3SourceUploadSettingsArgs{
Format: pulumi.String("JSON"),
},
},
},
},
Permissions: quicksight.DataSetPermissionArray{
&quicksight.DataSetPermissionArgs{
Actions: pulumi.StringArray{
pulumi.String("quicksight:DescribeDataSet"),
pulumi.String("quicksight:DescribeDataSetPermissions"),
pulumi.String("quicksight:PassDataSet"),
pulumi.String("quicksight:DescribeIngestion"),
pulumi.String("quicksight:ListIngestions"),
},
Principal: pulumi.Any(exampleAwsQuicksightUser.Arn),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.DataSet("example", new()
{
DataSetId = "example-id",
Name = "example-name",
ImportMode = "SPICE",
PhysicalTableMaps = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapArgs
{
PhysicalTableMapId = "example-id",
S3Source = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceArgs
{
DataSourceArn = exampleAwsQuicksightDataSource.Arn,
InputColumns = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceInputColumnArgs
{
Name = "Column1",
Type = "STRING",
},
},
UploadSettings = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs
{
Format = "JSON",
},
},
},
},
Permissions = new[]
{
new Aws.Quicksight.Inputs.DataSetPermissionArgs
{
Actions = new[]
{
"quicksight:DescribeDataSet",
"quicksight:DescribeDataSetPermissions",
"quicksight:PassDataSet",
"quicksight:DescribeIngestion",
"quicksight:ListIngestions",
},
Principal = exampleAwsQuicksightUser.Arn,
},
},
});
});
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")
.name("example-name")
.importMode("SPICE")
.physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
.physicalTableMapId("example-id")
.s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
.dataSourceArn(exampleAwsQuicksightDataSource.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(exampleAwsQuicksightUser.arn())
.build())
.build());
}
}
resources:
example:
type: aws:quicksight:DataSet
properties:
dataSetId: example-id
name: example-name
importMode: SPICE
physicalTableMaps:
- physicalTableMapId: example-id
s3Source:
dataSourceArn: ${exampleAwsQuicksightDataSource.arn}
inputColumns:
- name: Column1
type: STRING
uploadSettings:
format: JSON
permissions:
- actions:
- quicksight:DescribeDataSet
- quicksight:DescribeDataSetPermissions
- quicksight:PassDataSet
- quicksight:DescribeIngestion
- quicksight:ListIngestions
principal: ${exampleAwsQuicksightUser.arn}
With Row Level Permission Tag Configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.DataSet("example", {
dataSetId: "example-id",
name: "example-name",
importMode: "SPICE",
physicalTableMaps: [{
physicalTableMapId: "example-id",
s3Source: {
dataSourceArn: exampleAwsQuicksightDataSource.arn,
inputColumns: [{
name: "Column1",
type: "STRING",
}],
uploadSettings: {
format: "JSON",
},
},
}],
rowLevelPermissionTagConfiguration: {
status: "ENABLED",
tagRules: [{
columnName: "Column1",
tagKey: "tagkey",
matchAllValue: "*",
tagMultiValueDelimiter: ",",
}],
},
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.DataSet("example",
data_set_id="example-id",
name="example-name",
import_mode="SPICE",
physical_table_maps=[{
"physical_table_map_id": "example-id",
"s3_source": {
"data_source_arn": example_aws_quicksight_data_source["arn"],
"input_columns": [{
"name": "Column1",
"type": "STRING",
}],
"upload_settings": {
"format": "JSON",
},
},
}],
row_level_permission_tag_configuration={
"status": "ENABLED",
"tag_rules": [{
"column_name": "Column1",
"tag_key": "tagkey",
"match_all_value": "*",
"tag_multi_value_delimiter": ",",
}],
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewDataSet(ctx, "example", &quicksight.DataSetArgs{
DataSetId: pulumi.String("example-id"),
Name: pulumi.String("example-name"),
ImportMode: pulumi.String("SPICE"),
PhysicalTableMaps: quicksight.DataSetPhysicalTableMapArray{
&quicksight.DataSetPhysicalTableMapArgs{
PhysicalTableMapId: pulumi.String("example-id"),
S3Source: &quicksight.DataSetPhysicalTableMapS3SourceArgs{
DataSourceArn: pulumi.Any(exampleAwsQuicksightDataSource.Arn),
InputColumns: quicksight.DataSetPhysicalTableMapS3SourceInputColumnArray{
&quicksight.DataSetPhysicalTableMapS3SourceInputColumnArgs{
Name: pulumi.String("Column1"),
Type: pulumi.String("STRING"),
},
},
UploadSettings: &quicksight.DataSetPhysicalTableMapS3SourceUploadSettingsArgs{
Format: pulumi.String("JSON"),
},
},
},
},
RowLevelPermissionTagConfiguration: &quicksight.DataSetRowLevelPermissionTagConfigurationArgs{
Status: pulumi.String("ENABLED"),
TagRules: quicksight.DataSetRowLevelPermissionTagConfigurationTagRuleArray{
&quicksight.DataSetRowLevelPermissionTagConfigurationTagRuleArgs{
ColumnName: pulumi.String("Column1"),
TagKey: pulumi.String("tagkey"),
MatchAllValue: pulumi.String("*"),
TagMultiValueDelimiter: pulumi.String(","),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.DataSet("example", new()
{
DataSetId = "example-id",
Name = "example-name",
ImportMode = "SPICE",
PhysicalTableMaps = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapArgs
{
PhysicalTableMapId = "example-id",
S3Source = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceArgs
{
DataSourceArn = exampleAwsQuicksightDataSource.Arn,
InputColumns = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceInputColumnArgs
{
Name = "Column1",
Type = "STRING",
},
},
UploadSettings = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs
{
Format = "JSON",
},
},
},
},
RowLevelPermissionTagConfiguration = new Aws.Quicksight.Inputs.DataSetRowLevelPermissionTagConfigurationArgs
{
Status = "ENABLED",
TagRules = new[]
{
new Aws.Quicksight.Inputs.DataSetRowLevelPermissionTagConfigurationTagRuleArgs
{
ColumnName = "Column1",
TagKey = "tagkey",
MatchAllValue = "*",
TagMultiValueDelimiter = ",",
},
},
},
});
});
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")
.name("example-name")
.importMode("SPICE")
.physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
.physicalTableMapId("example-id")
.s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
.dataSourceArn(exampleAwsQuicksightDataSource.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());
}
}
resources:
example:
type: aws:quicksight:DataSet
properties:
dataSetId: example-id
name: example-name
importMode: SPICE
physicalTableMaps:
- physicalTableMapId: example-id
s3Source:
dataSourceArn: ${exampleAwsQuicksightDataSource.arn}
inputColumns:
- name: Column1
type: STRING
uploadSettings:
format: JSON
rowLevelPermissionTagConfiguration:
status: ENABLED
tagRules:
- columnName: Column1
tagKey: tagkey
matchAllValue: '*'
tagMultiValueDelimiter: ','
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: DataSetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DataSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
import_mode: Optional[str] = None,
data_set_id: Optional[str] = None,
name: Optional[str] = None,
column_level_permission_rules: Optional[Sequence[DataSetColumnLevelPermissionRuleArgs]] = None,
data_set_usage_configuration: Optional[DataSetDataSetUsageConfigurationArgs] = None,
field_folders: Optional[Sequence[DataSetFieldFolderArgs]] = None,
column_groups: Optional[Sequence[DataSetColumnGroupArgs]] = None,
logical_table_maps: Optional[Sequence[DataSetLogicalTableMapArgs]] = None,
aws_account_id: Optional[str] = None,
permissions: Optional[Sequence[DataSetPermissionArgs]] = None,
physical_table_maps: Optional[Sequence[DataSetPhysicalTableMapArgs]] = None,
refresh_properties: Optional[DataSetRefreshPropertiesArgs] = None,
row_level_permission_data_set: Optional[DataSetRowLevelPermissionDataSetArgs] = None,
row_level_permission_tag_configuration: Optional[DataSetRowLevelPermissionTagConfigurationArgs] = None,
tags: Optional[Mapping[str, str]] = None)func NewDataSet(ctx *Context, name string, args DataSetArgs, opts ...ResourceOption) (*DataSet, error)public DataSet(string name, DataSetArgs args, CustomResourceOptions? opts = null)
public DataSet(String name, DataSetArgs args)
public DataSet(String name, DataSetArgs args, CustomResourceOptions options)
type: aws: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.
Constructor example
The following reference example uses placeholder values for all input properties.
var awsDataSetResource = new Aws.Quicksight.DataSet("awsDataSetResource", new()
{
ImportMode = "string",
DataSetId = "string",
Name = "string",
ColumnLevelPermissionRules = new[]
{
new Aws.Quicksight.Inputs.DataSetColumnLevelPermissionRuleArgs
{
ColumnNames = new[]
{
"string",
},
Principals = new[]
{
"string",
},
},
},
DataSetUsageConfiguration = new Aws.Quicksight.Inputs.DataSetDataSetUsageConfigurationArgs
{
DisableUseAsDirectQuerySource = false,
DisableUseAsImportedSource = false,
},
FieldFolders = new[]
{
new Aws.Quicksight.Inputs.DataSetFieldFolderArgs
{
FieldFoldersId = "string",
Columns = new[]
{
"string",
},
Description = "string",
},
},
ColumnGroups = new[]
{
new Aws.Quicksight.Inputs.DataSetColumnGroupArgs
{
GeoSpatialColumnGroup = new Aws.Quicksight.Inputs.DataSetColumnGroupGeoSpatialColumnGroupArgs
{
Columns = new[]
{
"string",
},
CountryCode = "string",
Name = "string",
},
},
},
LogicalTableMaps = new[]
{
new Aws.Quicksight.Inputs.DataSetLogicalTableMapArgs
{
Alias = "string",
LogicalTableMapId = "string",
Source = new Aws.Quicksight.Inputs.DataSetLogicalTableMapSourceArgs
{
DataSetArn = "string",
JoinInstruction = new Aws.Quicksight.Inputs.DataSetLogicalTableMapSourceJoinInstructionArgs
{
LeftOperand = "string",
OnClause = "string",
RightOperand = "string",
Type = "string",
LeftJoinKeyProperties = new Aws.Quicksight.Inputs.DataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyPropertiesArgs
{
UniqueKey = false,
},
RightJoinKeyProperties = new Aws.Quicksight.Inputs.DataSetLogicalTableMapSourceJoinInstructionRightJoinKeyPropertiesArgs
{
UniqueKey = false,
},
},
PhysicalTableId = "string",
},
DataTransforms = new[]
{
new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformArgs
{
CastColumnTypeOperation = new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformCastColumnTypeOperationArgs
{
ColumnName = "string",
NewColumnType = "string",
Format = "string",
},
CreateColumnsOperation = new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformCreateColumnsOperationArgs
{
Columns = new[]
{
new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformCreateColumnsOperationColumnArgs
{
ColumnId = "string",
ColumnName = "string",
Expression = "string",
},
},
},
FilterOperation = new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformFilterOperationArgs
{
ConditionExpression = "string",
},
ProjectOperation = new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformProjectOperationArgs
{
ProjectedColumns = new[]
{
"string",
},
},
RenameColumnOperation = new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformRenameColumnOperationArgs
{
ColumnName = "string",
NewColumnName = "string",
},
TagColumnOperation = new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformTagColumnOperationArgs
{
ColumnName = "string",
Tags = new[]
{
new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformTagColumnOperationTagArgs
{
ColumnDescription = new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformTagColumnOperationTagColumnDescriptionArgs
{
Text = "string",
},
ColumnGeographicRole = "string",
},
},
},
UntagColumnOperation = new Aws.Quicksight.Inputs.DataSetLogicalTableMapDataTransformUntagColumnOperationArgs
{
ColumnName = "string",
TagNames = new[]
{
"string",
},
},
},
},
},
},
AwsAccountId = "string",
Permissions = new[]
{
new Aws.Quicksight.Inputs.DataSetPermissionArgs
{
Actions = new[]
{
"string",
},
Principal = "string",
},
},
PhysicalTableMaps = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapArgs
{
PhysicalTableMapId = "string",
CustomSql = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapCustomSqlArgs
{
DataSourceArn = "string",
Name = "string",
SqlQuery = "string",
Columns = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapCustomSqlColumnArgs
{
Name = "string",
Type = "string",
},
},
},
RelationalTable = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapRelationalTableArgs
{
DataSourceArn = "string",
InputColumns = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapRelationalTableInputColumnArgs
{
Name = "string",
Type = "string",
},
},
Name = "string",
Catalog = "string",
Schema = "string",
},
S3Source = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceArgs
{
DataSourceArn = "string",
InputColumns = new[]
{
new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceInputColumnArgs
{
Name = "string",
Type = "string",
},
},
UploadSettings = new Aws.Quicksight.Inputs.DataSetPhysicalTableMapS3SourceUploadSettingsArgs
{
ContainsHeader = false,
Delimiter = "string",
Format = "string",
StartFromRow = 0,
TextQualifier = "string",
},
},
},
},
RefreshProperties = new Aws.Quicksight.Inputs.DataSetRefreshPropertiesArgs
{
RefreshConfiguration = new Aws.Quicksight.Inputs.DataSetRefreshPropertiesRefreshConfigurationArgs
{
IncrementalRefresh = new Aws.Quicksight.Inputs.DataSetRefreshPropertiesRefreshConfigurationIncrementalRefreshArgs
{
LookbackWindow = new Aws.Quicksight.Inputs.DataSetRefreshPropertiesRefreshConfigurationIncrementalRefreshLookbackWindowArgs
{
ColumnName = "string",
Size = 0,
SizeUnit = "string",
},
},
},
},
RowLevelPermissionDataSet = new Aws.Quicksight.Inputs.DataSetRowLevelPermissionDataSetArgs
{
Arn = "string",
PermissionPolicy = "string",
FormatVersion = "string",
Namespace = "string",
Status = "string",
},
RowLevelPermissionTagConfiguration = new Aws.Quicksight.Inputs.DataSetRowLevelPermissionTagConfigurationArgs
{
TagRules = new[]
{
new Aws.Quicksight.Inputs.DataSetRowLevelPermissionTagConfigurationTagRuleArgs
{
ColumnName = "string",
TagKey = "string",
MatchAllValue = "string",
TagMultiValueDelimiter = "string",
},
},
Status = "string",
},
Tags =
{
{ "string", "string" },
},
});
example, err := quicksight.NewDataSet(ctx, "awsDataSetResource", &quicksight.DataSetArgs{
ImportMode: pulumi.String("string"),
DataSetId: pulumi.String("string"),
Name: pulumi.String("string"),
ColumnLevelPermissionRules: quicksight.DataSetColumnLevelPermissionRuleArray{
&quicksight.DataSetColumnLevelPermissionRuleArgs{
ColumnNames: pulumi.StringArray{
pulumi.String("string"),
},
Principals: pulumi.StringArray{
pulumi.String("string"),
},
},
},
DataSetUsageConfiguration: &quicksight.DataSetDataSetUsageConfigurationArgs{
DisableUseAsDirectQuerySource: pulumi.Bool(false),
DisableUseAsImportedSource: pulumi.Bool(false),
},
FieldFolders: quicksight.DataSetFieldFolderArray{
&quicksight.DataSetFieldFolderArgs{
FieldFoldersId: pulumi.String("string"),
Columns: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
},
},
ColumnGroups: quicksight.DataSetColumnGroupArray{
&quicksight.DataSetColumnGroupArgs{
GeoSpatialColumnGroup: &quicksight.DataSetColumnGroupGeoSpatialColumnGroupArgs{
Columns: pulumi.StringArray{
pulumi.String("string"),
},
CountryCode: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
},
LogicalTableMaps: quicksight.DataSetLogicalTableMapArray{
&quicksight.DataSetLogicalTableMapArgs{
Alias: pulumi.String("string"),
LogicalTableMapId: pulumi.String("string"),
Source: &quicksight.DataSetLogicalTableMapSourceArgs{
DataSetArn: pulumi.String("string"),
JoinInstruction: &quicksight.DataSetLogicalTableMapSourceJoinInstructionArgs{
LeftOperand: pulumi.String("string"),
OnClause: pulumi.String("string"),
RightOperand: pulumi.String("string"),
Type: pulumi.String("string"),
LeftJoinKeyProperties: &quicksight.DataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyPropertiesArgs{
UniqueKey: pulumi.Bool(false),
},
RightJoinKeyProperties: &quicksight.DataSetLogicalTableMapSourceJoinInstructionRightJoinKeyPropertiesArgs{
UniqueKey: pulumi.Bool(false),
},
},
PhysicalTableId: pulumi.String("string"),
},
DataTransforms: quicksight.DataSetLogicalTableMapDataTransformArray{
&quicksight.DataSetLogicalTableMapDataTransformArgs{
CastColumnTypeOperation: &quicksight.DataSetLogicalTableMapDataTransformCastColumnTypeOperationArgs{
ColumnName: pulumi.String("string"),
NewColumnType: pulumi.String("string"),
Format: pulumi.String("string"),
},
CreateColumnsOperation: &quicksight.DataSetLogicalTableMapDataTransformCreateColumnsOperationArgs{
Columns: quicksight.DataSetLogicalTableMapDataTransformCreateColumnsOperationColumnArray{
&quicksight.DataSetLogicalTableMapDataTransformCreateColumnsOperationColumnArgs{
ColumnId: pulumi.String("string"),
ColumnName: pulumi.String("string"),
Expression: pulumi.String("string"),
},
},
},
FilterOperation: &quicksight.DataSetLogicalTableMapDataTransformFilterOperationArgs{
ConditionExpression: pulumi.String("string"),
},
ProjectOperation: &quicksight.DataSetLogicalTableMapDataTransformProjectOperationArgs{
ProjectedColumns: pulumi.StringArray{
pulumi.String("string"),
},
},
RenameColumnOperation: &quicksight.DataSetLogicalTableMapDataTransformRenameColumnOperationArgs{
ColumnName: pulumi.String("string"),
NewColumnName: pulumi.String("string"),
},
TagColumnOperation: &quicksight.DataSetLogicalTableMapDataTransformTagColumnOperationArgs{
ColumnName: pulumi.String("string"),
Tags: quicksight.DataSetLogicalTableMapDataTransformTagColumnOperationTagArray{
&quicksight.DataSetLogicalTableMapDataTransformTagColumnOperationTagArgs{
ColumnDescription: &quicksight.DataSetLogicalTableMapDataTransformTagColumnOperationTagColumnDescriptionArgs{
Text: pulumi.String("string"),
},
ColumnGeographicRole: pulumi.String("string"),
},
},
},
UntagColumnOperation: &quicksight.DataSetLogicalTableMapDataTransformUntagColumnOperationArgs{
ColumnName: pulumi.String("string"),
TagNames: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
},
},
AwsAccountId: pulumi.String("string"),
Permissions: quicksight.DataSetPermissionArray{
&quicksight.DataSetPermissionArgs{
Actions: pulumi.StringArray{
pulumi.String("string"),
},
Principal: pulumi.String("string"),
},
},
PhysicalTableMaps: quicksight.DataSetPhysicalTableMapArray{
&quicksight.DataSetPhysicalTableMapArgs{
PhysicalTableMapId: pulumi.String("string"),
CustomSql: &quicksight.DataSetPhysicalTableMapCustomSqlArgs{
DataSourceArn: pulumi.String("string"),
Name: pulumi.String("string"),
SqlQuery: pulumi.String("string"),
Columns: quicksight.DataSetPhysicalTableMapCustomSqlColumnArray{
&quicksight.DataSetPhysicalTableMapCustomSqlColumnArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
RelationalTable: &quicksight.DataSetPhysicalTableMapRelationalTableArgs{
DataSourceArn: pulumi.String("string"),
InputColumns: quicksight.DataSetPhysicalTableMapRelationalTableInputColumnArray{
&quicksight.DataSetPhysicalTableMapRelationalTableInputColumnArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Catalog: pulumi.String("string"),
Schema: pulumi.String("string"),
},
S3Source: &quicksight.DataSetPhysicalTableMapS3SourceArgs{
DataSourceArn: pulumi.String("string"),
InputColumns: quicksight.DataSetPhysicalTableMapS3SourceInputColumnArray{
&quicksight.DataSetPhysicalTableMapS3SourceInputColumnArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
UploadSettings: &quicksight.DataSetPhysicalTableMapS3SourceUploadSettingsArgs{
ContainsHeader: pulumi.Bool(false),
Delimiter: pulumi.String("string"),
Format: pulumi.String("string"),
StartFromRow: pulumi.Int(0),
TextQualifier: pulumi.String("string"),
},
},
},
},
RefreshProperties: &quicksight.DataSetRefreshPropertiesArgs{
RefreshConfiguration: &quicksight.DataSetRefreshPropertiesRefreshConfigurationArgs{
IncrementalRefresh: &quicksight.DataSetRefreshPropertiesRefreshConfigurationIncrementalRefreshArgs{
LookbackWindow: &quicksight.DataSetRefreshPropertiesRefreshConfigurationIncrementalRefreshLookbackWindowArgs{
ColumnName: pulumi.String("string"),
Size: pulumi.Int(0),
SizeUnit: pulumi.String("string"),
},
},
},
},
RowLevelPermissionDataSet: &quicksight.DataSetRowLevelPermissionDataSetArgs{
Arn: pulumi.String("string"),
PermissionPolicy: pulumi.String("string"),
FormatVersion: pulumi.String("string"),
Namespace: pulumi.String("string"),
Status: pulumi.String("string"),
},
RowLevelPermissionTagConfiguration: &quicksight.DataSetRowLevelPermissionTagConfigurationArgs{
TagRules: quicksight.DataSetRowLevelPermissionTagConfigurationTagRuleArray{
&quicksight.DataSetRowLevelPermissionTagConfigurationTagRuleArgs{
ColumnName: pulumi.String("string"),
TagKey: pulumi.String("string"),
MatchAllValue: pulumi.String("string"),
TagMultiValueDelimiter: pulumi.String("string"),
},
},
Status: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var awsDataSetResource = new DataSet("awsDataSetResource", DataSetArgs.builder()
.importMode("string")
.dataSetId("string")
.name("string")
.columnLevelPermissionRules(DataSetColumnLevelPermissionRuleArgs.builder()
.columnNames("string")
.principals("string")
.build())
.dataSetUsageConfiguration(DataSetDataSetUsageConfigurationArgs.builder()
.disableUseAsDirectQuerySource(false)
.disableUseAsImportedSource(false)
.build())
.fieldFolders(DataSetFieldFolderArgs.builder()
.fieldFoldersId("string")
.columns("string")
.description("string")
.build())
.columnGroups(DataSetColumnGroupArgs.builder()
.geoSpatialColumnGroup(DataSetColumnGroupGeoSpatialColumnGroupArgs.builder()
.columns("string")
.countryCode("string")
.name("string")
.build())
.build())
.logicalTableMaps(DataSetLogicalTableMapArgs.builder()
.alias("string")
.logicalTableMapId("string")
.source(DataSetLogicalTableMapSourceArgs.builder()
.dataSetArn("string")
.joinInstruction(DataSetLogicalTableMapSourceJoinInstructionArgs.builder()
.leftOperand("string")
.onClause("string")
.rightOperand("string")
.type("string")
.leftJoinKeyProperties(DataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyPropertiesArgs.builder()
.uniqueKey(false)
.build())
.rightJoinKeyProperties(DataSetLogicalTableMapSourceJoinInstructionRightJoinKeyPropertiesArgs.builder()
.uniqueKey(false)
.build())
.build())
.physicalTableId("string")
.build())
.dataTransforms(DataSetLogicalTableMapDataTransformArgs.builder()
.castColumnTypeOperation(DataSetLogicalTableMapDataTransformCastColumnTypeOperationArgs.builder()
.columnName("string")
.newColumnType("string")
.format("string")
.build())
.createColumnsOperation(DataSetLogicalTableMapDataTransformCreateColumnsOperationArgs.builder()
.columns(DataSetLogicalTableMapDataTransformCreateColumnsOperationColumnArgs.builder()
.columnId("string")
.columnName("string")
.expression("string")
.build())
.build())
.filterOperation(DataSetLogicalTableMapDataTransformFilterOperationArgs.builder()
.conditionExpression("string")
.build())
.projectOperation(DataSetLogicalTableMapDataTransformProjectOperationArgs.builder()
.projectedColumns("string")
.build())
.renameColumnOperation(DataSetLogicalTableMapDataTransformRenameColumnOperationArgs.builder()
.columnName("string")
.newColumnName("string")
.build())
.tagColumnOperation(DataSetLogicalTableMapDataTransformTagColumnOperationArgs.builder()
.columnName("string")
.tags(DataSetLogicalTableMapDataTransformTagColumnOperationTagArgs.builder()
.columnDescription(DataSetLogicalTableMapDataTransformTagColumnOperationTagColumnDescriptionArgs.builder()
.text("string")
.build())
.columnGeographicRole("string")
.build())
.build())
.untagColumnOperation(DataSetLogicalTableMapDataTransformUntagColumnOperationArgs.builder()
.columnName("string")
.tagNames("string")
.build())
.build())
.build())
.awsAccountId("string")
.permissions(DataSetPermissionArgs.builder()
.actions("string")
.principal("string")
.build())
.physicalTableMaps(DataSetPhysicalTableMapArgs.builder()
.physicalTableMapId("string")
.customSql(DataSetPhysicalTableMapCustomSqlArgs.builder()
.dataSourceArn("string")
.name("string")
.sqlQuery("string")
.columns(DataSetPhysicalTableMapCustomSqlColumnArgs.builder()
.name("string")
.type("string")
.build())
.build())
.relationalTable(DataSetPhysicalTableMapRelationalTableArgs.builder()
.dataSourceArn("string")
.inputColumns(DataSetPhysicalTableMapRelationalTableInputColumnArgs.builder()
.name("string")
.type("string")
.build())
.name("string")
.catalog("string")
.schema("string")
.build())
.s3Source(DataSetPhysicalTableMapS3SourceArgs.builder()
.dataSourceArn("string")
.inputColumns(DataSetPhysicalTableMapS3SourceInputColumnArgs.builder()
.name("string")
.type("string")
.build())
.uploadSettings(DataSetPhysicalTableMapS3SourceUploadSettingsArgs.builder()
.containsHeader(false)
.delimiter("string")
.format("string")
.startFromRow(0)
.textQualifier("string")
.build())
.build())
.build())
.refreshProperties(DataSetRefreshPropertiesArgs.builder()
.refreshConfiguration(DataSetRefreshPropertiesRefreshConfigurationArgs.builder()
.incrementalRefresh(DataSetRefreshPropertiesRefreshConfigurationIncrementalRefreshArgs.builder()
.lookbackWindow(DataSetRefreshPropertiesRefreshConfigurationIncrementalRefreshLookbackWindowArgs.builder()
.columnName("string")
.size(0)
.sizeUnit("string")
.build())
.build())
.build())
.build())
.rowLevelPermissionDataSet(DataSetRowLevelPermissionDataSetArgs.builder()
.arn("string")
.permissionPolicy("string")
.formatVersion("string")
.namespace("string")
.status("string")
.build())
.rowLevelPermissionTagConfiguration(DataSetRowLevelPermissionTagConfigurationArgs.builder()
.tagRules(DataSetRowLevelPermissionTagConfigurationTagRuleArgs.builder()
.columnName("string")
.tagKey("string")
.matchAllValue("string")
.tagMultiValueDelimiter("string")
.build())
.status("string")
.build())
.tags(Map.of("string", "string"))
.build());
aws_data_set_resource = aws.quicksight.DataSet("awsDataSetResource",
import_mode="string",
data_set_id="string",
name="string",
column_level_permission_rules=[{
"column_names": ["string"],
"principals": ["string"],
}],
data_set_usage_configuration={
"disable_use_as_direct_query_source": False,
"disable_use_as_imported_source": False,
},
field_folders=[{
"field_folders_id": "string",
"columns": ["string"],
"description": "string",
}],
column_groups=[{
"geo_spatial_column_group": {
"columns": ["string"],
"country_code": "string",
"name": "string",
},
}],
logical_table_maps=[{
"alias": "string",
"logical_table_map_id": "string",
"source": {
"data_set_arn": "string",
"join_instruction": {
"left_operand": "string",
"on_clause": "string",
"right_operand": "string",
"type": "string",
"left_join_key_properties": {
"unique_key": False,
},
"right_join_key_properties": {
"unique_key": False,
},
},
"physical_table_id": "string",
},
"data_transforms": [{
"cast_column_type_operation": {
"column_name": "string",
"new_column_type": "string",
"format": "string",
},
"create_columns_operation": {
"columns": [{
"column_id": "string",
"column_name": "string",
"expression": "string",
}],
},
"filter_operation": {
"condition_expression": "string",
},
"project_operation": {
"projected_columns": ["string"],
},
"rename_column_operation": {
"column_name": "string",
"new_column_name": "string",
},
"tag_column_operation": {
"column_name": "string",
"tags": [{
"column_description": {
"text": "string",
},
"column_geographic_role": "string",
}],
},
"untag_column_operation": {
"column_name": "string",
"tag_names": ["string"],
},
}],
}],
aws_account_id="string",
permissions=[{
"actions": ["string"],
"principal": "string",
}],
physical_table_maps=[{
"physical_table_map_id": "string",
"custom_sql": {
"data_source_arn": "string",
"name": "string",
"sql_query": "string",
"columns": [{
"name": "string",
"type": "string",
}],
},
"relational_table": {
"data_source_arn": "string",
"input_columns": [{
"name": "string",
"type": "string",
}],
"name": "string",
"catalog": "string",
"schema": "string",
},
"s3_source": {
"data_source_arn": "string",
"input_columns": [{
"name": "string",
"type": "string",
}],
"upload_settings": {
"contains_header": False,
"delimiter": "string",
"format": "string",
"start_from_row": 0,
"text_qualifier": "string",
},
},
}],
refresh_properties={
"refresh_configuration": {
"incremental_refresh": {
"lookback_window": {
"column_name": "string",
"size": 0,
"size_unit": "string",
},
},
},
},
row_level_permission_data_set={
"arn": "string",
"permission_policy": "string",
"format_version": "string",
"namespace": "string",
"status": "string",
},
row_level_permission_tag_configuration={
"tag_rules": [{
"column_name": "string",
"tag_key": "string",
"match_all_value": "string",
"tag_multi_value_delimiter": "string",
}],
"status": "string",
},
tags={
"string": "string",
})
const awsDataSetResource = new aws.quicksight.DataSet("awsDataSetResource", {
importMode: "string",
dataSetId: "string",
name: "string",
columnLevelPermissionRules: [{
columnNames: ["string"],
principals: ["string"],
}],
dataSetUsageConfiguration: {
disableUseAsDirectQuerySource: false,
disableUseAsImportedSource: false,
},
fieldFolders: [{
fieldFoldersId: "string",
columns: ["string"],
description: "string",
}],
columnGroups: [{
geoSpatialColumnGroup: {
columns: ["string"],
countryCode: "string",
name: "string",
},
}],
logicalTableMaps: [{
alias: "string",
logicalTableMapId: "string",
source: {
dataSetArn: "string",
joinInstruction: {
leftOperand: "string",
onClause: "string",
rightOperand: "string",
type: "string",
leftJoinKeyProperties: {
uniqueKey: false,
},
rightJoinKeyProperties: {
uniqueKey: false,
},
},
physicalTableId: "string",
},
dataTransforms: [{
castColumnTypeOperation: {
columnName: "string",
newColumnType: "string",
format: "string",
},
createColumnsOperation: {
columns: [{
columnId: "string",
columnName: "string",
expression: "string",
}],
},
filterOperation: {
conditionExpression: "string",
},
projectOperation: {
projectedColumns: ["string"],
},
renameColumnOperation: {
columnName: "string",
newColumnName: "string",
},
tagColumnOperation: {
columnName: "string",
tags: [{
columnDescription: {
text: "string",
},
columnGeographicRole: "string",
}],
},
untagColumnOperation: {
columnName: "string",
tagNames: ["string"],
},
}],
}],
awsAccountId: "string",
permissions: [{
actions: ["string"],
principal: "string",
}],
physicalTableMaps: [{
physicalTableMapId: "string",
customSql: {
dataSourceArn: "string",
name: "string",
sqlQuery: "string",
columns: [{
name: "string",
type: "string",
}],
},
relationalTable: {
dataSourceArn: "string",
inputColumns: [{
name: "string",
type: "string",
}],
name: "string",
catalog: "string",
schema: "string",
},
s3Source: {
dataSourceArn: "string",
inputColumns: [{
name: "string",
type: "string",
}],
uploadSettings: {
containsHeader: false,
delimiter: "string",
format: "string",
startFromRow: 0,
textQualifier: "string",
},
},
}],
refreshProperties: {
refreshConfiguration: {
incrementalRefresh: {
lookbackWindow: {
columnName: "string",
size: 0,
sizeUnit: "string",
},
},
},
},
rowLevelPermissionDataSet: {
arn: "string",
permissionPolicy: "string",
formatVersion: "string",
namespace: "string",
status: "string",
},
rowLevelPermissionTagConfiguration: {
tagRules: [{
columnName: "string",
tagKey: "string",
matchAllValue: "string",
tagMultiValueDelimiter: "string",
}],
status: "string",
},
tags: {
string: "string",
},
});
type: aws:quicksight:DataSet
properties:
awsAccountId: string
columnGroups:
- geoSpatialColumnGroup:
columns:
- string
countryCode: string
name: string
columnLevelPermissionRules:
- columnNames:
- string
principals:
- string
dataSetId: string
dataSetUsageConfiguration:
disableUseAsDirectQuerySource: false
disableUseAsImportedSource: false
fieldFolders:
- columns:
- string
description: string
fieldFoldersId: string
importMode: string
logicalTableMaps:
- alias: string
dataTransforms:
- castColumnTypeOperation:
columnName: string
format: string
newColumnType: string
createColumnsOperation:
columns:
- columnId: string
columnName: string
expression: string
filterOperation:
conditionExpression: string
projectOperation:
projectedColumns:
- string
renameColumnOperation:
columnName: string
newColumnName: string
tagColumnOperation:
columnName: string
tags:
- columnDescription:
text: string
columnGeographicRole: string
untagColumnOperation:
columnName: string
tagNames:
- string
logicalTableMapId: string
source:
dataSetArn: string
joinInstruction:
leftJoinKeyProperties:
uniqueKey: false
leftOperand: string
onClause: string
rightJoinKeyProperties:
uniqueKey: false
rightOperand: string
type: string
physicalTableId: string
name: string
permissions:
- actions:
- string
principal: string
physicalTableMaps:
- customSql:
columns:
- name: string
type: string
dataSourceArn: string
name: string
sqlQuery: string
physicalTableMapId: string
relationalTable:
catalog: string
dataSourceArn: string
inputColumns:
- name: string
type: string
name: string
schema: string
s3Source:
dataSourceArn: string
inputColumns:
- name: string
type: string
uploadSettings:
containsHeader: false
delimiter: string
format: string
startFromRow: 0
textQualifier: string
refreshProperties:
refreshConfiguration:
incrementalRefresh:
lookbackWindow:
columnName: string
size: 0
sizeUnit: string
rowLevelPermissionDataSet:
arn: string
formatVersion: string
namespace: string
permissionPolicy: string
status: string
rowLevelPermissionTagConfiguration:
status: string
tagRules:
- columnName: string
matchAllValue: string
tagKey: string
tagMultiValueDelimiter: string
tags:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DataSet resource accepts the following input properties:
- Data
Set stringId - Identifier for the data set.
- Import
Mode string - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - Aws
Account stringId - AWS account ID.
- Column
Groups List<DataSet Column Group> - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- Column
Level List<DataPermission Rules Set Column Level Permission Rule> - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- Data
Set DataUsage Configuration Set Data Set Usage Configuration - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- Field
Folders List<DataSet Field Folder> - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- Logical
Table List<DataMaps Set Logical Table Map> - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- Name string
- Display name for the dataset.
- Permissions
List<Data
Set Permission> - A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- Physical
Table List<DataMaps Set Physical Table Map> Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- Refresh
Properties DataSet Refresh Properties - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - Row
Level DataPermission Data Set Set Row Level Permission Data Set - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- Row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration - 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.
- Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Data
Set stringId - Identifier for the data set.
- Import
Mode string - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - Aws
Account stringId - AWS account ID.
- Column
Groups []DataSet Column Group Args - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- Column
Level []DataPermission Rules Set Column Level Permission Rule Args - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- Data
Set DataUsage Configuration Set Data Set Usage Configuration Args - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- Field
Folders []DataSet Field Folder Args - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- Logical
Table []DataMaps Set Logical Table Map Args - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- Name string
- Display name for the dataset.
- Permissions
[]Data
Set Permission Args - A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- Physical
Table []DataMaps Set Physical Table Map Args Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- Refresh
Properties DataSet Refresh Properties Args - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - Row
Level DataPermission Data Set Set Row Level Permission Data Set Args - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- Row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration Args - 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.
- map[string]string
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- data
Set StringId - Identifier for the data set.
- import
Mode String - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - aws
Account StringId - AWS account ID.
- column
Groups List<DataSet Column Group> - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- column
Level List<DataPermission Rules Set Column Level Permission Rule> - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- data
Set DataUsage Configuration Set Data Set Usage Configuration - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- field
Folders List<DataSet Field Folder> - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- logical
Table List<DataMaps Set Logical Table Map> - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- name String
- Display name for the dataset.
- permissions
List<Data
Set Permission> - A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- physical
Table List<DataMaps Set Physical Table Map> Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- refresh
Properties DataSet Refresh Properties - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - row
Level DataPermission Data Set Set Row Level Permission Data Set - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration - 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.
- Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- data
Set stringId - Identifier for the data set.
- import
Mode string - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - aws
Account stringId - AWS account ID.
- column
Groups DataSet Column Group[] - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- column
Level DataPermission Rules Set Column Level Permission Rule[] - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- data
Set DataUsage Configuration Set Data Set Usage Configuration - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- field
Folders DataSet Field Folder[] - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- logical
Table DataMaps Set Logical Table Map[] - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- name string
- Display name for the dataset.
- permissions
Data
Set Permission[] - A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- physical
Table DataMaps Set Physical Table Map[] Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- refresh
Properties DataSet Refresh Properties - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - row
Level DataPermission Data Set Set Row Level Permission Data Set - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration - 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.
- {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- data_
set_ strid - Identifier for the data set.
- import_
mode str - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - aws_
account_ strid - AWS account ID.
- column_
groups Sequence[DataSet Column Group Args] - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- column_
level_ Sequence[Datapermission_ rules Set Column Level Permission Rule Args] - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- data_
set_ Datausage_ configuration Set Data Set Usage Configuration Args - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- field_
folders Sequence[DataSet Field Folder Args] - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- logical_
table_ Sequence[Datamaps Set Logical Table Map Args] - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- name str
- Display name for the dataset.
- permissions
Sequence[Data
Set Permission Args] - A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- physical_
table_ Sequence[Datamaps Set Physical Table Map Args] Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- refresh_
properties DataSet Refresh Properties Args - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - row_
level_ Datapermission_ data_ set Set Row Level Permission Data Set Args - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- row_
level_ Datapermission_ tag_ configuration Set Row Level Permission Tag Configuration Args - 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.
- Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- data
Set StringId - Identifier for the data set.
- import
Mode String - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - aws
Account StringId - AWS account ID.
- column
Groups List<Property Map> - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- column
Level List<Property Map>Permission Rules - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- data
Set Property MapUsage Configuration - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- field
Folders List<Property Map> - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- logical
Table List<Property Map>Maps - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- name String
- Display name for the dataset.
- permissions List<Property Map>
- A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- physical
Table List<Property Map>Maps Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- refresh
Properties Property Map - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - row
Level Property MapPermission Data Set - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- row
Level Property MapPermission Tag Configuration - 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.
- Map<String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the DataSet resource produces the following output properties:
- Arn string
- Amazon Resource Name (ARN) of the data set.
- Id string
- The provider-assigned unique ID for this managed resource.
- Output
Columns List<DataSet Output Column> - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- Arn string
- Amazon Resource Name (ARN) of the data set.
- Id string
- The provider-assigned unique ID for this managed resource.
- Output
Columns []DataSet Output Column - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- Amazon Resource Name (ARN) of the data set.
- id String
- The provider-assigned unique ID for this managed resource.
- output
Columns List<DataSet Output Column> - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn string
- Amazon Resource Name (ARN) of the data set.
- id string
- The provider-assigned unique ID for this managed resource.
- output
Columns DataSet Output Column[] - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn str
- Amazon Resource Name (ARN) of the data set.
- id str
- The provider-assigned unique ID for this managed resource.
- output_
columns Sequence[DataSet Output Column] - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- Amazon Resource Name (ARN) of the data set.
- id String
- The provider-assigned unique ID for this managed resource.
- output
Columns List<Property Map> - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
Look up Existing DataSet Resource
Get an existing DataSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DataSetState, opts?: CustomResourceOptions): DataSet@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = 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_usage_configuration: Optional[DataSetDataSetUsageConfigurationArgs] = None,
field_folders: Optional[Sequence[DataSetFieldFolderArgs]] = None,
import_mode: Optional[str] = None,
logical_table_maps: Optional[Sequence[DataSetLogicalTableMapArgs]] = None,
name: Optional[str] = None,
output_columns: Optional[Sequence[DataSetOutputColumnArgs]] = None,
permissions: Optional[Sequence[DataSetPermissionArgs]] = None,
physical_table_maps: Optional[Sequence[DataSetPhysicalTableMapArgs]] = None,
refresh_properties: Optional[DataSetRefreshPropertiesArgs] = None,
row_level_permission_data_set: Optional[DataSetRowLevelPermissionDataSetArgs] = None,
row_level_permission_tag_configuration: Optional[DataSetRowLevelPermissionTagConfigurationArgs] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> DataSetfunc GetDataSet(ctx *Context, name string, id IDInput, state *DataSetState, opts ...ResourceOption) (*DataSet, error)public static DataSet Get(string name, Input<string> id, DataSetState? state, CustomResourceOptions? opts = null)public static DataSet get(String name, Output<String> id, DataSetState state, CustomResourceOptions options)resources: _: type: aws:quicksight:DataSet get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- Amazon Resource Name (ARN) of the data set.
- Aws
Account stringId - AWS account ID.
- Column
Groups List<DataSet Column Group> - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- Column
Level List<DataPermission Rules Set Column Level Permission Rule> - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- Data
Set stringId - Identifier for the data set.
- Data
Set DataUsage Configuration Set Data Set Usage Configuration - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- Field
Folders List<DataSet Field Folder> - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- Import
Mode string - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - Logical
Table List<DataMaps Set Logical Table Map> - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- Name string
- Display name for the dataset.
- Output
Columns List<DataSet Output Column> - Permissions
List<Data
Set Permission> - A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- Physical
Table List<DataMaps Set Physical Table Map> Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- Refresh
Properties DataSet Refresh Properties - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - Row
Level DataPermission Data Set Set Row Level Permission Data Set - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- Row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration - 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.
- Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- Arn string
- Amazon Resource Name (ARN) of the data set.
- Aws
Account stringId - AWS account ID.
- Column
Groups []DataSet Column Group Args - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- Column
Level []DataPermission Rules Set Column Level Permission Rule Args - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- Data
Set stringId - Identifier for the data set.
- Data
Set DataUsage Configuration Set Data Set Usage Configuration Args - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- Field
Folders []DataSet Field Folder Args - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- Import
Mode string - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - Logical
Table []DataMaps Set Logical Table Map Args - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- Name string
- Display name for the dataset.
- Output
Columns []DataSet Output Column Args - Permissions
[]Data
Set Permission Args - A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- Physical
Table []DataMaps Set Physical Table Map Args Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- Refresh
Properties DataSet Refresh Properties Args - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - Row
Level DataPermission Data Set Set Row Level Permission Data Set Args - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- Row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration Args - 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.
- map[string]string
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- Amazon Resource Name (ARN) of the data set.
- aws
Account StringId - AWS account ID.
- column
Groups List<DataSet Column Group> - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- column
Level List<DataPermission Rules Set Column Level Permission Rule> - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- data
Set StringId - Identifier for the data set.
- data
Set DataUsage Configuration Set Data Set Usage Configuration - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- field
Folders List<DataSet Field Folder> - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- import
Mode String - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - logical
Table List<DataMaps Set Logical Table Map> - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- name String
- Display name for the dataset.
- output
Columns List<DataSet Output Column> - permissions
List<Data
Set Permission> - A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- physical
Table List<DataMaps Set Physical Table Map> Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- refresh
Properties DataSet Refresh Properties - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - row
Level DataPermission Data Set Set Row Level Permission Data Set - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration - 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.
- Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn string
- Amazon Resource Name (ARN) of the data set.
- aws
Account stringId - AWS account ID.
- column
Groups DataSet Column Group[] - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- column
Level DataPermission Rules Set Column Level Permission Rule[] - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- data
Set stringId - Identifier for the data set.
- data
Set DataUsage Configuration Set Data Set Usage Configuration - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- field
Folders DataSet Field Folder[] - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- import
Mode string - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - logical
Table DataMaps Set Logical Table Map[] - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- name string
- Display name for the dataset.
- output
Columns DataSet Output Column[] - permissions
Data
Set Permission[] - A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- physical
Table DataMaps Set Physical Table Map[] Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- refresh
Properties DataSet Refresh Properties - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - row
Level DataPermission Data Set Set Row Level Permission Data Set - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- row
Level DataPermission Tag Configuration Set Row Level Permission Tag Configuration - 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.
- {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn str
- Amazon Resource Name (ARN) of the data set.
- aws_
account_ strid - AWS account ID.
- column_
groups Sequence[DataSet Column Group Args] - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- column_
level_ Sequence[Datapermission_ rules Set Column Level Permission Rule Args] - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- data_
set_ strid - Identifier for the data set.
- data_
set_ Datausage_ configuration Set Data Set Usage Configuration Args - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- field_
folders Sequence[DataSet Field Folder Args] - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- import_
mode str - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - logical_
table_ Sequence[Datamaps Set Logical Table Map Args] - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- name str
- Display name for the dataset.
- output_
columns Sequence[DataSet Output Column Args] - permissions
Sequence[Data
Set Permission Args] - A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- physical_
table_ Sequence[Datamaps Set Physical Table Map Args] Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- refresh_
properties DataSet Refresh Properties Args - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - row_
level_ Datapermission_ data_ set Set Row Level Permission Data Set Args - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- row_
level_ Datapermission_ tag_ configuration Set Row Level Permission Tag Configuration Args - 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.
- Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- Amazon Resource Name (ARN) of the data set.
- aws
Account StringId - AWS account ID.
- column
Groups List<Property Map> - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See column_groups.
- column
Level List<Property Map>Permission Rules - A set of 1 or more definitions of a ColumnLevelPermissionRule. See column_level_permission_rules.
- data
Set StringId - Identifier for the data set.
- data
Set Property MapUsage Configuration - The usage configuration to apply to child datasets that reference this dataset as a source. See data_set_usage_configuration.
- field
Folders List<Property Map> - The folder that contains fields and nested subfolders for your dataset. See field_folders.
- import
Mode String - Indicates whether you want to import the data into SPICE. Valid values are
SPICEandDIRECT_QUERY. - logical
Table List<Property Map>Maps - Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See logical_table_map.
- name String
- Display name for the dataset.
- output
Columns List<Property Map> - permissions List<Property Map>
- A set of resource permissions on the data source. Maximum of 64 items. See permissions.
- physical
Table List<Property Map>Maps Declares the physical tables that are available in the underlying data sources. See physical_table_map.
The following arguments are optional:
- refresh
Properties Property Map - The refresh properties for the data set. NOTE: Only valid when
import_modeis set toSPICE. See refresh_properties. - row
Level Property MapPermission Data Set - The row-level security configuration for the data that you want to create. See row_level_permission_data_set.
- row
Level Property MapPermission Tag Configuration - 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.
- Map<String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
Supporting Types
DataSetColumnGroup, DataSetColumnGroupArgs
- Geo
Spatial DataColumn Group Set Column Group Geo Spatial Column Group - Geospatial column group that denotes a hierarchy. See geo_spatial_column_group.
- Geo
Spatial DataColumn Group Set Column Group Geo Spatial Column Group - Geospatial column group that denotes a hierarchy. See geo_spatial_column_group.
- geo
Spatial DataColumn Group Set Column Group Geo Spatial Column Group - Geospatial column group that denotes a hierarchy. See geo_spatial_column_group.
- geo
Spatial DataColumn Group Set Column Group Geo Spatial Column Group - Geospatial column group that denotes a hierarchy. See geo_spatial_column_group.
- geo_
spatial_ Datacolumn_ group Set Column Group Geo Spatial Column Group - Geospatial column group that denotes a hierarchy. See geo_spatial_column_group.
- geo
Spatial Property MapColumn Group - Geospatial column group that denotes a hierarchy. See geo_spatial_column_group.
DataSetColumnGroupGeoSpatialColumnGroup, DataSetColumnGroupGeoSpatialColumnGroupArgs
- Columns List<string>
- Columns in this hierarchy.
- Country
Code string - Country code. Valid values are
US. - Name string
- A display name for the hierarchy.
- Columns []string
- Columns in this hierarchy.
- Country
Code string - Country code. Valid values are
US. - Name string
- A display name for the hierarchy.
- columns List<String>
- Columns in this hierarchy.
- country
Code String - Country code. Valid values are
US. - name String
- A display name for the hierarchy.
- columns string[]
- Columns in this hierarchy.
- country
Code string - Country code. Valid values are
US. - name string
- A display name for the hierarchy.
- columns Sequence[str]
- Columns in this hierarchy.
- country_
code str - Country code. Valid values are
US. - name str
- A display name for the hierarchy.
- columns List<String>
- Columns in this hierarchy.
- country
Code String - Country code. Valid values are
US. - name String
- A display name for the hierarchy.
DataSetColumnLevelPermissionRule, DataSetColumnLevelPermissionRuleArgs
- Column
Names List<string> - An array of column names.
- Principals List<string>
- An array of ARNs for Amazon QuickSight users or groups.
- Column
Names []string - An array of column names.
- Principals []string
- An array of ARNs for Amazon QuickSight users or groups.
- column
Names List<String> - An array of column names.
- principals List<String>
- An array of ARNs for Amazon QuickSight users or groups.
- column
Names string[] - An array of column names.
- principals string[]
- An array of ARNs for Amazon QuickSight users or groups.
- column_
names Sequence[str] - An array of column names.
- principals Sequence[str]
- An array of ARNs for Amazon QuickSight users or groups.
- column
Names List<String> - An array of column names.
- principals List<String>
- An array of ARNs for Amazon QuickSight users or groups.
DataSetDataSetUsageConfiguration, DataSetDataSetUsageConfigurationArgs
- Disable
Use boolAs Direct Query Source - Controls whether a child dataset of a direct query can use this dataset as a source.
- Disable
Use boolAs Imported Source - Controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
- Disable
Use boolAs Direct Query Source - Controls whether a child dataset of a direct query can use this dataset as a source.
- Disable
Use boolAs Imported Source - Controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
- disable
Use BooleanAs Direct Query Source - Controls whether a child dataset of a direct query can use this dataset as a source.
- disable
Use BooleanAs Imported Source - Controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
- disable
Use booleanAs Direct Query Source - Controls whether a child dataset of a direct query can use this dataset as a source.
- disable
Use booleanAs Imported Source - Controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
- disable_
use_ boolas_ direct_ query_ source - Controls whether a child dataset of a direct query can use this dataset as a source.
- disable_
use_ boolas_ imported_ source - Controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
- disable
Use BooleanAs Direct Query Source - Controls whether a child dataset of a direct query can use this dataset as a source.
- disable
Use BooleanAs Imported Source - Controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
DataSetFieldFolder, DataSetFieldFolderArgs
- Field
Folders stringId - Key of the field folder map.
- Columns List<string>
- An array of column names to add to the folder. A column can only be in one folder.
- Description string
- Field folder description.
- Field
Folders stringId - Key of the field folder map.
- Columns []string
- An array of column names to add to the folder. A column can only be in one folder.
- Description string
- Field folder description.
- field
Folders StringId - Key of the field folder map.
- columns List<String>
- An array of column names to add to the folder. A column can only be in one folder.
- description String
- Field folder description.
- field
Folders stringId - Key of the field folder map.
- columns string[]
- An array of column names to add to the folder. A column can only be in one folder.
- description string
- Field folder description.
- field_
folders_ strid - Key of the field folder map.
- columns Sequence[str]
- An array of column names to add to the folder. A column can only be in one folder.
- description str
- Field folder description.
- field
Folders StringId - Key of the field folder map.
- columns List<String>
- An array of column names to add to the folder. A column can only be in one folder.
- description String
- Field folder description.
DataSetLogicalTableMap, DataSetLogicalTableMapArgs
- Alias string
- A display name for the logical table.
- Logical
Table stringMap Id - Key of the logical table map.
- Source
Data
Set Logical Table Map Source - Source of this logical table. See source.
- Data
Transforms List<DataSet Logical Table Map Data Transform> - Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. See data_transforms.
- Alias string
- A display name for the logical table.
- Logical
Table stringMap Id - Key of the logical table map.
- Source
Data
Set Logical Table Map Source - Source of this logical table. See source.
- Data
Transforms []DataSet Logical Table Map Data Transform - Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. See data_transforms.
- alias String
- A display name for the logical table.
- logical
Table StringMap Id - Key of the logical table map.
- source
Data
Set Logical Table Map Source - Source of this logical table. See source.
- data
Transforms List<DataSet Logical Table Map Data Transform> - Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. See data_transforms.
- alias string
- A display name for the logical table.
- logical
Table stringMap Id - Key of the logical table map.
- source
Data
Set Logical Table Map Source - Source of this logical table. See source.
- data
Transforms DataSet Logical Table Map Data Transform[] - Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. See data_transforms.
- alias str
- A display name for the logical table.
- logical_
table_ strmap_ id - Key of the logical table map.
- source
Data
Set Logical Table Map Source - Source of this logical table. See source.
- data_
transforms Sequence[DataSet Logical Table Map Data Transform] - Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. See data_transforms.
- alias String
- A display name for the logical table.
- logical
Table StringMap Id - Key of the logical table map.
- source Property Map
- Source of this logical table. See source.
- data
Transforms List<Property Map> - Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. See data_transforms.
DataSetLogicalTableMapDataTransform, DataSetLogicalTableMapDataTransformArgs
- Cast
Column DataType Operation Set Logical Table Map Data Transform Cast Column Type Operation - A transform operation that casts a column to a different type. See cast_column_type_operation.
- Create
Columns DataOperation Set Logical Table Map Data Transform Create Columns Operation - An operation that creates calculated columns. Columns created in one such operation form a lexical closure. See create_columns_operation.
- Filter
Operation DataSet Logical Table Map Data Transform Filter Operation - An operation that filters rows based on some condition. See filter_operation.
- Project
Operation DataSet Logical Table Map Data Transform Project Operation - An operation that projects columns. Operations that come after a projection can only refer to projected columns. See project_operation.
- Rename
Column DataOperation Set Logical Table Map Data Transform Rename Column Operation - An operation that renames a column. See rename_column_operation.
- Tag
Column DataOperation Set Logical Table Map Data Transform Tag Column Operation - An operation that tags a column with additional information. See tag_column_operation.
- Untag
Column DataOperation Set Logical Table Map Data Transform Untag Column Operation - A transform operation that removes tags associated with a column. See untag_column_operation.
- Cast
Column DataType Operation Set Logical Table Map Data Transform Cast Column Type Operation - A transform operation that casts a column to a different type. See cast_column_type_operation.
- Create
Columns DataOperation Set Logical Table Map Data Transform Create Columns Operation - An operation that creates calculated columns. Columns created in one such operation form a lexical closure. See create_columns_operation.
- Filter
Operation DataSet Logical Table Map Data Transform Filter Operation - An operation that filters rows based on some condition. See filter_operation.
- Project
Operation DataSet Logical Table Map Data Transform Project Operation - An operation that projects columns. Operations that come after a projection can only refer to projected columns. See project_operation.
- Rename
Column DataOperation Set Logical Table Map Data Transform Rename Column Operation - An operation that renames a column. See rename_column_operation.
- Tag
Column DataOperation Set Logical Table Map Data Transform Tag Column Operation - An operation that tags a column with additional information. See tag_column_operation.
- Untag
Column DataOperation Set Logical Table Map Data Transform Untag Column Operation - A transform operation that removes tags associated with a column. See untag_column_operation.
- cast
Column DataType Operation Set Logical Table Map Data Transform Cast Column Type Operation - A transform operation that casts a column to a different type. See cast_column_type_operation.
- create
Columns DataOperation Set Logical Table Map Data Transform Create Columns Operation - An operation that creates calculated columns. Columns created in one such operation form a lexical closure. See create_columns_operation.
- filter
Operation DataSet Logical Table Map Data Transform Filter Operation - An operation that filters rows based on some condition. See filter_operation.
- project
Operation DataSet Logical Table Map Data Transform Project Operation - An operation that projects columns. Operations that come after a projection can only refer to projected columns. See project_operation.
- rename
Column DataOperation Set Logical Table Map Data Transform Rename Column Operation - An operation that renames a column. See rename_column_operation.
- tag
Column DataOperation Set Logical Table Map Data Transform Tag Column Operation - An operation that tags a column with additional information. See tag_column_operation.
- untag
Column DataOperation Set Logical Table Map Data Transform Untag Column Operation - A transform operation that removes tags associated with a column. See untag_column_operation.
- cast
Column DataType Operation Set Logical Table Map Data Transform Cast Column Type Operation - A transform operation that casts a column to a different type. See cast_column_type_operation.
- create
Columns DataOperation Set Logical Table Map Data Transform Create Columns Operation - An operation that creates calculated columns. Columns created in one such operation form a lexical closure. See create_columns_operation.
- filter
Operation DataSet Logical Table Map Data Transform Filter Operation - An operation that filters rows based on some condition. See filter_operation.
- project
Operation DataSet Logical Table Map Data Transform Project Operation - An operation that projects columns. Operations that come after a projection can only refer to projected columns. See project_operation.
- rename
Column DataOperation Set Logical Table Map Data Transform Rename Column Operation - An operation that renames a column. See rename_column_operation.
- tag
Column DataOperation Set Logical Table Map Data Transform Tag Column Operation - An operation that tags a column with additional information. See tag_column_operation.
- untag
Column DataOperation Set Logical Table Map Data Transform Untag Column Operation - A transform operation that removes tags associated with a column. See untag_column_operation.
- cast_
column_ Datatype_ operation Set Logical Table Map Data Transform Cast Column Type Operation - A transform operation that casts a column to a different type. See cast_column_type_operation.
- create_
columns_ Dataoperation Set Logical Table Map Data Transform Create Columns Operation - An operation that creates calculated columns. Columns created in one such operation form a lexical closure. See create_columns_operation.
- filter_
operation DataSet Logical Table Map Data Transform Filter Operation - An operation that filters rows based on some condition. See filter_operation.
- project_
operation DataSet Logical Table Map Data Transform Project Operation - An operation that projects columns. Operations that come after a projection can only refer to projected columns. See project_operation.
- rename_
column_ Dataoperation Set Logical Table Map Data Transform Rename Column Operation - An operation that renames a column. See rename_column_operation.
- tag_
column_ Dataoperation Set Logical Table Map Data Transform Tag Column Operation - An operation that tags a column with additional information. See tag_column_operation.
- untag_
column_ Dataoperation Set Logical Table Map Data Transform Untag Column Operation - A transform operation that removes tags associated with a column. See untag_column_operation.
- cast
Column Property MapType Operation - A transform operation that casts a column to a different type. See cast_column_type_operation.
- create
Columns Property MapOperation - An operation that creates calculated columns. Columns created in one such operation form a lexical closure. See create_columns_operation.
- filter
Operation Property Map - An operation that filters rows based on some condition. See filter_operation.
- project
Operation Property Map - An operation that projects columns. Operations that come after a projection can only refer to projected columns. See project_operation.
- rename
Column Property MapOperation - An operation that renames a column. See rename_column_operation.
- tag
Column Property MapOperation - An operation that tags a column with additional information. See tag_column_operation.
- untag
Column Property MapOperation - A transform operation that removes tags associated with a column. See untag_column_operation.
DataSetLogicalTableMapDataTransformCastColumnTypeOperation, DataSetLogicalTableMapDataTransformCastColumnTypeOperationArgs
- Column
Name string - Column name.
- New
Column stringType - New column data type. Valid values are
STRING,INTEGER,DECIMAL,DATETIME. - Format string
- When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
- Column
Name string - Column name.
- New
Column stringType - New column data type. Valid values are
STRING,INTEGER,DECIMAL,DATETIME. - Format string
- When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
- column
Name String - Column name.
- new
Column StringType - New column data type. Valid values are
STRING,INTEGER,DECIMAL,DATETIME. - format String
- When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
- column
Name string - Column name.
- new
Column stringType - New column data type. Valid values are
STRING,INTEGER,DECIMAL,DATETIME. - format string
- When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
- column_
name str - Column name.
- new_
column_ strtype - New column data type. Valid values are
STRING,INTEGER,DECIMAL,DATETIME. - format str
- When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
- column
Name String - Column name.
- new
Column StringType - New column data type. Valid values are
STRING,INTEGER,DECIMAL,DATETIME. - format String
- When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
DataSetLogicalTableMapDataTransformCreateColumnsOperation, DataSetLogicalTableMapDataTransformCreateColumnsOperationArgs
- Columns
List<Data
Set Logical Table Map Data Transform Create Columns Operation Column> - Calculated columns to create. See columns.
- Columns
[]Data
Set Logical Table Map Data Transform Create Columns Operation Column - Calculated columns to create. See columns.
- columns
List<Data
Set Logical Table Map Data Transform Create Columns Operation Column> - Calculated columns to create. See columns.
- columns
Data
Set Logical Table Map Data Transform Create Columns Operation Column[] - Calculated columns to create. See columns.
- columns
Sequence[Data
Set Logical Table Map Data Transform Create Columns Operation Column] - Calculated columns to create. See columns.
- columns List<Property Map>
- Calculated columns to create. See columns.
DataSetLogicalTableMapDataTransformCreateColumnsOperationColumn, DataSetLogicalTableMapDataTransformCreateColumnsOperationColumnArgs
- Column
Id string - A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
- Column
Name string - Column name.
- Expression string
- An expression that defines the calculated column.
- Column
Id string - A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
- Column
Name string - Column name.
- Expression string
- An expression that defines the calculated column.
- column
Id String - A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
- column
Name String - Column name.
- expression String
- An expression that defines the calculated column.
- column
Id string - A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
- column
Name string - Column name.
- expression string
- An expression that defines the calculated column.
- column_
id str - A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
- column_
name str - Column name.
- expression str
- An expression that defines the calculated column.
- column
Id String - A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
- column
Name String - Column name.
- expression String
- An expression that defines the calculated column.
DataSetLogicalTableMapDataTransformFilterOperation, DataSetLogicalTableMapDataTransformFilterOperationArgs
- Condition
Expression string - An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
- Condition
Expression string - An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
- condition
Expression String - An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
- condition
Expression string - An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
- condition_
expression str - An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
- condition
Expression String - An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
DataSetLogicalTableMapDataTransformProjectOperation, DataSetLogicalTableMapDataTransformProjectOperationArgs
- Projected
Columns List<string> - Projected columns.
- Projected
Columns []string - Projected columns.
- projected
Columns List<String> - Projected columns.
- projected
Columns string[] - Projected columns.
- projected_
columns Sequence[str] - Projected columns.
- projected
Columns List<String> - Projected columns.
DataSetLogicalTableMapDataTransformRenameColumnOperation, DataSetLogicalTableMapDataTransformRenameColumnOperationArgs
- Column
Name string - Column to be renamed.
- New
Column stringName - New name for the column.
- Column
Name string - Column to be renamed.
- New
Column stringName - New name for the column.
- column
Name String - Column to be renamed.
- new
Column StringName - New name for the column.
- column
Name string - Column to be renamed.
- new
Column stringName - New name for the column.
- column_
name str - Column to be renamed.
- new_
column_ strname - New name for the column.
- column
Name String - Column to be renamed.
- new
Column StringName - New name for the column.
DataSetLogicalTableMapDataTransformTagColumnOperation, DataSetLogicalTableMapDataTransformTagColumnOperationArgs
- Column
Name string - Column name.
-
List<Data
Set Logical Table Map Data Transform Tag Column Operation Tag> - The dataset column tag, currently only used for geospatial type tagging. See tags.
- Column
Name string - Column name.
-
[]Data
Set Logical Table Map Data Transform Tag Column Operation Tag - The dataset column tag, currently only used for geospatial type tagging. See tags.
- column
Name String - Column name.
-
List<Data
Set Logical Table Map Data Transform Tag Column Operation Tag> - The dataset column tag, currently only used for geospatial type tagging. See tags.
- column
Name string - Column name.
-
Data
Set Logical Table Map Data Transform Tag Column Operation Tag[] - The dataset column tag, currently only used for geospatial type tagging. See tags.
- column_
name str - Column name.
-
Sequence[Data
Set Logical Table Map Data Transform Tag Column Operation Tag] - The dataset column tag, currently only used for geospatial type tagging. See tags.
- column
Name String - Column name.
- List<Property Map>
- The dataset column tag, currently only used for geospatial type tagging. See tags.
DataSetLogicalTableMapDataTransformTagColumnOperationTag, DataSetLogicalTableMapDataTransformTagColumnOperationTagArgs
- Column
Description DataSet Logical Table Map Data Transform Tag Column Operation Tag Column Description - A description for a column. See column_description.
- Column
Geographic stringRole - A geospatial role for a column. Valid values are
COUNTRY,STATE,COUNTY,CITY,POSTCODE,LONGITUDE, andLATITUDE.
- Column
Description DataSet Logical Table Map Data Transform Tag Column Operation Tag Column Description - A description for a column. See column_description.
- Column
Geographic stringRole - A geospatial role for a column. Valid values are
COUNTRY,STATE,COUNTY,CITY,POSTCODE,LONGITUDE, andLATITUDE.
- column
Description DataSet Logical Table Map Data Transform Tag Column Operation Tag Column Description - A description for a column. See column_description.
- column
Geographic StringRole - A geospatial role for a column. Valid values are
COUNTRY,STATE,COUNTY,CITY,POSTCODE,LONGITUDE, andLATITUDE.
- column
Description DataSet Logical Table Map Data Transform Tag Column Operation Tag Column Description - A description for a column. See column_description.
- column
Geographic stringRole - A geospatial role for a column. Valid values are
COUNTRY,STATE,COUNTY,CITY,POSTCODE,LONGITUDE, andLATITUDE.
- column_
description DataSet Logical Table Map Data Transform Tag Column Operation Tag Column Description - A description for a column. See column_description.
- column_
geographic_ strrole - A geospatial role for a column. Valid values are
COUNTRY,STATE,COUNTY,CITY,POSTCODE,LONGITUDE, andLATITUDE.
- column
Description Property Map - A description for a column. See column_description.
- column
Geographic StringRole - A geospatial role for a column. Valid values are
COUNTRY,STATE,COUNTY,CITY,POSTCODE,LONGITUDE, andLATITUDE.
DataSetLogicalTableMapDataTransformTagColumnOperationTagColumnDescription, DataSetLogicalTableMapDataTransformTagColumnOperationTagColumnDescriptionArgs
- Text string
- The text of a description for a column.
- Text string
- The text of a description for a column.
- text String
- The text of a description for a column.
- text string
- The text of a description for a column.
- text str
- The text of a description for a column.
- text String
- The text of a description for a column.
DataSetLogicalTableMapDataTransformUntagColumnOperation, DataSetLogicalTableMapDataTransformUntagColumnOperationArgs
- Column
Name string - Column name.
- Tag
Names List<string> - The column tags to remove from this column.
- Column
Name string - Column name.
- Tag
Names []string - The column tags to remove from this column.
- column
Name String - Column name.
- tag
Names List<String> - The column tags to remove from this column.
- column
Name string - Column name.
- tag
Names string[] - The column tags to remove from this column.
- column_
name str - Column name.
- tag_
names Sequence[str] - The column tags to remove from this column.
- column
Name String - Column name.
- tag
Names List<String> - The column tags to remove from this column.
DataSetLogicalTableMapSource, DataSetLogicalTableMapSourceArgs
- Data
Set stringArn - ARN of the parent data set.
- Join
Instruction DataSet Logical Table Map Source Join Instruction - Specifies the result of a join of two logical tables. See join_instruction.
- Physical
Table stringId - Physical table ID.
- Data
Set stringArn - ARN of the parent data set.
- Join
Instruction DataSet Logical Table Map Source Join Instruction - Specifies the result of a join of two logical tables. See join_instruction.
- Physical
Table stringId - Physical table ID.
- data
Set StringArn - ARN of the parent data set.
- join
Instruction DataSet Logical Table Map Source Join Instruction - Specifies the result of a join of two logical tables. See join_instruction.
- physical
Table StringId - Physical table ID.
- data
Set stringArn - ARN of the parent data set.
- join
Instruction DataSet Logical Table Map Source Join Instruction - Specifies the result of a join of two logical tables. See join_instruction.
- physical
Table stringId - Physical table ID.
- data_
set_ strarn - ARN of the parent data set.
- join_
instruction DataSet Logical Table Map Source Join Instruction - Specifies the result of a join of two logical tables. See join_instruction.
- physical_
table_ strid - Physical table ID.
- data
Set StringArn - ARN of the parent data set.
- join
Instruction Property Map - Specifies the result of a join of two logical tables. See join_instruction.
- physical
Table StringId - Physical table ID.
DataSetLogicalTableMapSourceJoinInstruction, DataSetLogicalTableMapSourceJoinInstructionArgs
- Left
Operand string - Operand on the left side of a join.
- On
Clause string - Join instructions provided in the ON clause of a join.
- Right
Operand string - Operand on the right side of a join.
- Type string
- Type of join. Valid values are
INNER,OUTER,LEFT, andRIGHT. - Left
Join DataKey Properties Set Logical Table Map Source Join Instruction Left Join Key Properties - Join key properties of the left operand. See left_join_key_properties.
- Right
Join DataKey Properties Set Logical Table Map Source Join Instruction Right Join Key Properties - Join key properties of the right operand. See right_join_key_properties.
- Left
Operand string - Operand on the left side of a join.
- On
Clause string - Join instructions provided in the ON clause of a join.
- Right
Operand string - Operand on the right side of a join.
- Type string
- Type of join. Valid values are
INNER,OUTER,LEFT, andRIGHT. - Left
Join DataKey Properties Set Logical Table Map Source Join Instruction Left Join Key Properties - Join key properties of the left operand. See left_join_key_properties.
- Right
Join DataKey Properties Set Logical Table Map Source Join Instruction Right Join Key Properties - Join key properties of the right operand. See right_join_key_properties.
- left
Operand String - Operand on the left side of a join.
- on
Clause String - Join instructions provided in the ON clause of a join.
- right
Operand String - Operand on the right side of a join.
- type String
- Type of join. Valid values are
INNER,OUTER,LEFT, andRIGHT. - left
Join DataKey Properties Set Logical Table Map Source Join Instruction Left Join Key Properties - Join key properties of the left operand. See left_join_key_properties.
- right
Join DataKey Properties Set Logical Table Map Source Join Instruction Right Join Key Properties - Join key properties of the right operand. See right_join_key_properties.
- left
Operand string - Operand on the left side of a join.
- on
Clause string - Join instructions provided in the ON clause of a join.
- right
Operand string - Operand on the right side of a join.
- type string
- Type of join. Valid values are
INNER,OUTER,LEFT, andRIGHT. - left
Join DataKey Properties Set Logical Table Map Source Join Instruction Left Join Key Properties - Join key properties of the left operand. See left_join_key_properties.
- right
Join DataKey Properties Set Logical Table Map Source Join Instruction Right Join Key Properties - Join key properties of the right operand. See right_join_key_properties.
- left_
operand str - Operand on the left side of a join.
- on_
clause str - Join instructions provided in the ON clause of a join.
- right_
operand str - Operand on the right side of a join.
- type str
- Type of join. Valid values are
INNER,OUTER,LEFT, andRIGHT. - left_
join_ Datakey_ properties Set Logical Table Map Source Join Instruction Left Join Key Properties - Join key properties of the left operand. See left_join_key_properties.
- right_
join_ Datakey_ properties Set Logical Table Map Source Join Instruction Right Join Key Properties - Join key properties of the right operand. See right_join_key_properties.
- left
Operand String - Operand on the left side of a join.
- on
Clause String - Join instructions provided in the ON clause of a join.
- right
Operand String - Operand on the right side of a join.
- type String
- Type of join. Valid values are
INNER,OUTER,LEFT, andRIGHT. - left
Join Property MapKey Properties - Join key properties of the left operand. See left_join_key_properties.
- right
Join Property MapKey Properties - Join key properties of the right operand. See right_join_key_properties.
DataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyProperties, DataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyPropertiesArgs
- Unique
Key bool - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
- Unique
Key bool - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
- unique
Key Boolean - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
- unique
Key boolean - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
- unique_
key bool - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
- unique
Key Boolean - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
DataSetLogicalTableMapSourceJoinInstructionRightJoinKeyProperties, DataSetLogicalTableMapSourceJoinInstructionRightJoinKeyPropertiesArgs
- Unique
Key bool - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
- Unique
Key bool - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
- unique
Key Boolean - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
- unique
Key boolean - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
- unique_
key bool - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
- unique
Key Boolean - A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
DataSetOutputColumn, DataSetOutputColumnArgs
- Description string
- Field folder description.
- Name string
- Display name for the dataset.
- Type string
- Description string
- Field folder description.
- Name string
- Display name for the dataset.
- Type string
- description String
- Field folder description.
- name String
- Display name for the dataset.
- type String
- description string
- Field folder description.
- name string
- Display name for the dataset.
- type string
- description str
- Field folder description.
- name str
- Display name for the dataset.
- type str
- description String
- Field folder description.
- name String
- Display name for the dataset.
- type String
DataSetPermission, DataSetPermissionArgs
- Actions List<string>
- List of IAM actions to grant or revoke permissions on.
- Principal string
- ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
- Actions []string
- List of IAM actions to grant or revoke permissions on.
- Principal string
- ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
- actions List<String>
- List of IAM actions to grant or revoke permissions on.
- principal String
- ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
- actions string[]
- List of IAM actions to grant or revoke permissions on.
- principal string
- ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
- actions Sequence[str]
- List of IAM actions to grant or revoke permissions on.
- principal str
- ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
- actions List<String>
- List of IAM actions to grant or revoke permissions on.
- principal String
- ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
DataSetPhysicalTableMap, DataSetPhysicalTableMapArgs
- Physical
Table stringMap Id - Key of the physical table map.
- Custom
Sql DataSet Physical Table Map Custom Sql - A physical table type built from the results of the custom SQL query. See custom_sql.
- Relational
Table DataSet Physical Table Map Relational Table - A physical table type for relational data sources. See relational_table.
- S3Source
Data
Set Physical Table Map S3Source - A physical table type for as S3 data source. See s3_source.
- Physical
Table stringMap Id - Key of the physical table map.
- Custom
Sql DataSet Physical Table Map Custom Sql - A physical table type built from the results of the custom SQL query. See custom_sql.
- Relational
Table DataSet Physical Table Map Relational Table - A physical table type for relational data sources. See relational_table.
- S3Source
Data
Set Physical Table Map S3Source - A physical table type for as S3 data source. See s3_source.
- physical
Table StringMap Id - Key of the physical table map.
- custom
Sql DataSet Physical Table Map Custom Sql - A physical table type built from the results of the custom SQL query. See custom_sql.
- relational
Table DataSet Physical Table Map Relational Table - A physical table type for relational data sources. See relational_table.
- s3Source
Data
Set Physical Table Map S3Source - A physical table type for as S3 data source. See s3_source.
- physical
Table stringMap Id - Key of the physical table map.
- custom
Sql DataSet Physical Table Map Custom Sql - A physical table type built from the results of the custom SQL query. See custom_sql.
- relational
Table DataSet Physical Table Map Relational Table - A physical table type for relational data sources. See relational_table.
- s3Source
Data
Set Physical Table Map S3Source - A physical table type for as S3 data source. See s3_source.
- physical_
table_ strmap_ id - Key of the physical table map.
- custom_
sql DataSet Physical Table Map Custom Sql - A physical table type built from the results of the custom SQL query. See custom_sql.
- relational_
table DataSet Physical Table Map Relational Table - A physical table type for relational data sources. See relational_table.
- s3_
source DataSet Physical Table Map S3Source - A physical table type for as S3 data source. See s3_source.
- physical
Table StringMap Id - Key of the physical table map.
- custom
Sql Property Map - A physical table type built from the results of the custom SQL query. See custom_sql.
- relational
Table Property Map - A physical table type for relational data sources. See relational_table.
- s3Source Property Map
- A physical table type for as S3 data source. See s3_source.
DataSetPhysicalTableMapCustomSql, DataSetPhysicalTableMapCustomSqlArgs
- Data
Source stringArn - ARN of the data source.
- Name string
- Display name for the SQL query result.
- Sql
Query string - SQL query.
- Columns
List<Data
Set Physical Table Map Custom Sql Column> - Column schema from the SQL query result set. See columns.
- Data
Source stringArn - ARN of the data source.
- Name string
- Display name for the SQL query result.
- Sql
Query string - SQL query.
- Columns
[]Data
Set Physical Table Map Custom Sql Column - Column schema from the SQL query result set. See columns.
- data
Source StringArn - ARN of the data source.
- name String
- Display name for the SQL query result.
- sql
Query String - SQL query.
- columns
List<Data
Set Physical Table Map Custom Sql Column> - Column schema from the SQL query result set. See columns.
- data
Source stringArn - ARN of the data source.
- name string
- Display name for the SQL query result.
- sql
Query string - SQL query.
- columns
Data
Set Physical Table Map Custom Sql Column[] - Column schema from the SQL query result set. See columns.
- data_
source_ strarn - ARN of the data source.
- name str
- Display name for the SQL query result.
- sql_
query str - SQL query.
- columns
Sequence[Data
Set Physical Table Map Custom Sql Column] - Column schema from the SQL query result set. See columns.
- data
Source StringArn - ARN of the data source.
- name String
- Display name for the SQL query result.
- sql
Query String - SQL query.
- columns List<Property Map>
- Column schema from the SQL query result set. See columns.
DataSetPhysicalTableMapCustomSqlColumn, DataSetPhysicalTableMapCustomSqlColumnArgs
DataSetPhysicalTableMapRelationalTable, DataSetPhysicalTableMapRelationalTableArgs
- Data
Source stringArn - ARN of the data source.
- Input
Columns List<DataSet Physical Table Map Relational Table Input Column> - Column schema of the table. See input_columns.
- Name string
- Name of the relational table.
- Catalog string
- Catalog associated with the table.
- Schema string
- Schema name. This name applies to certain relational database engines.
- Data
Source stringArn - ARN of the data source.
- Input
Columns []DataSet Physical Table Map Relational Table Input Column - Column schema of the table. See input_columns.
- Name string
- Name of the relational table.
- Catalog string
- Catalog associated with the table.
- Schema string
- Schema name. This name applies to certain relational database engines.
- data
Source StringArn - ARN of the data source.
- input
Columns List<DataSet Physical Table Map Relational Table Input Column> - Column schema of the table. See input_columns.
- name String
- Name of the relational table.
- catalog String
- Catalog associated with the table.
- schema String
- Schema name. This name applies to certain relational database engines.
- data
Source stringArn - ARN of the data source.
- input
Columns DataSet Physical Table Map Relational Table Input Column[] - Column schema of the table. See input_columns.
- name string
- Name of the relational table.
- catalog string
- Catalog associated with the table.
- schema string
- Schema name. This name applies to certain relational database engines.
- data_
source_ strarn - ARN of the data source.
- input_
columns Sequence[DataSet Physical Table Map Relational Table Input Column] - Column schema of the table. See input_columns.
- name str
- Name of the relational table.
- catalog str
- Catalog associated with the table.
- schema str
- Schema name. This name applies to certain relational database engines.
- data
Source StringArn - ARN of the data source.
- input
Columns List<Property Map> - Column schema of the table. See input_columns.
- name String
- Name of the relational table.
- catalog String
- Catalog associated with the table.
- schema String
- Schema name. This name applies to certain relational database engines.
DataSetPhysicalTableMapRelationalTableInputColumn, DataSetPhysicalTableMapRelationalTableInputColumnArgs
DataSetPhysicalTableMapS3Source, DataSetPhysicalTableMapS3SourceArgs
- Data
Source stringArn - ARN of the data source.
- Input
Columns List<DataSet Physical Table Map S3Source Input Column> - Column schema of the table. See input_columns.
- Upload
Settings DataSet Physical Table Map S3Source Upload Settings - Information about the format for the S3 source file or files. See upload_settings.
- Data
Source stringArn - ARN of the data source.
- Input
Columns []DataSet Physical Table Map S3Source Input Column - Column schema of the table. See input_columns.
- Upload
Settings DataSet Physical Table Map S3Source Upload Settings - Information about the format for the S3 source file or files. See upload_settings.
- data
Source StringArn - ARN of the data source.
- input
Columns List<DataSet Physical Table Map S3Source Input Column> - Column schema of the table. See input_columns.
- upload
Settings DataSet Physical Table Map S3Source Upload Settings - Information about the format for the S3 source file or files. See upload_settings.
- data
Source stringArn - ARN of the data source.
- input
Columns DataSet Physical Table Map S3Source Input Column[] - Column schema of the table. See input_columns.
- upload
Settings DataSet Physical Table Map S3Source Upload Settings - Information about the format for the S3 source file or files. See upload_settings.
- data_
source_ strarn - ARN of the data source.
- input_
columns Sequence[DataSet Physical Table Map S3Source Input Column] - Column schema of the table. See input_columns.
- upload_
settings DataSet Physical Table Map S3Source Upload Settings - Information about the format for the S3 source file or files. See upload_settings.
- data
Source StringArn - ARN of the data source.
- input
Columns List<Property Map> - Column schema of the table. See input_columns.
- upload
Settings Property Map - Information about the format for the S3 source file or files. See upload_settings.
DataSetPhysicalTableMapS3SourceInputColumn, DataSetPhysicalTableMapS3SourceInputColumnArgs
DataSetPhysicalTableMapS3SourceUploadSettings, DataSetPhysicalTableMapS3SourceUploadSettingsArgs
- Contains
Header bool - Whether the file has a header row, or the files each have a header row.
- Delimiter string
- Delimiter between values in the file.
- Format string
- File format. Valid values are
CSV,TSV,CLF,ELF,XLSX, andJSON. - Start
From intRow - A row number to start reading data from.
- Text
Qualifier string - Text qualifier. Valid values are
DOUBLE_QUOTEandSINGLE_QUOTE.
- Contains
Header bool - Whether the file has a header row, or the files each have a header row.
- Delimiter string
- Delimiter between values in the file.
- Format string
- File format. Valid values are
CSV,TSV,CLF,ELF,XLSX, andJSON. - Start
From intRow - A row number to start reading data from.
- Text
Qualifier string - Text qualifier. Valid values are
DOUBLE_QUOTEandSINGLE_QUOTE.
- contains
Header Boolean - Whether the file has a header row, or the files each have a header row.
- delimiter String
- Delimiter between values in the file.
- format String
- File format. Valid values are
CSV,TSV,CLF,ELF,XLSX, andJSON. - start
From IntegerRow - A row number to start reading data from.
- text
Qualifier String - Text qualifier. Valid values are
DOUBLE_QUOTEandSINGLE_QUOTE.
- contains
Header boolean - Whether the file has a header row, or the files each have a header row.
- delimiter string
- Delimiter between values in the file.
- format string
- File format. Valid values are
CSV,TSV,CLF,ELF,XLSX, andJSON. - start
From numberRow - A row number to start reading data from.
- text
Qualifier string - Text qualifier. Valid values are
DOUBLE_QUOTEandSINGLE_QUOTE.
- contains_
header bool - Whether the file has a header row, or the files each have a header row.
- delimiter str
- Delimiter between values in the file.
- format str
- File format. Valid values are
CSV,TSV,CLF,ELF,XLSX, andJSON. - start_
from_ introw - A row number to start reading data from.
- text_
qualifier str - Text qualifier. Valid values are
DOUBLE_QUOTEandSINGLE_QUOTE.
- contains
Header Boolean - Whether the file has a header row, or the files each have a header row.
- delimiter String
- Delimiter between values in the file.
- format String
- File format. Valid values are
CSV,TSV,CLF,ELF,XLSX, andJSON. - start
From NumberRow - A row number to start reading data from.
- text
Qualifier String - Text qualifier. Valid values are
DOUBLE_QUOTEandSINGLE_QUOTE.
DataSetRefreshProperties, DataSetRefreshPropertiesArgs
- Refresh
Configuration DataSet Refresh Properties Refresh Configuration - The refresh configuration for the data set. See refresh_configuration.
- Refresh
Configuration DataSet Refresh Properties Refresh Configuration - The refresh configuration for the data set. See refresh_configuration.
- refresh
Configuration DataSet Refresh Properties Refresh Configuration - The refresh configuration for the data set. See refresh_configuration.
- refresh
Configuration DataSet Refresh Properties Refresh Configuration - The refresh configuration for the data set. See refresh_configuration.
- refresh_
configuration DataSet Refresh Properties Refresh Configuration - The refresh configuration for the data set. See refresh_configuration.
- refresh
Configuration Property Map - The refresh configuration for the data set. See refresh_configuration.
DataSetRefreshPropertiesRefreshConfiguration, DataSetRefreshPropertiesRefreshConfigurationArgs
- Incremental
Refresh DataSet Refresh Properties Refresh Configuration Incremental Refresh - The incremental refresh for the data set. See incremental_refresh.
- Incremental
Refresh DataSet Refresh Properties Refresh Configuration Incremental Refresh - The incremental refresh for the data set. See incremental_refresh.
- incremental
Refresh DataSet Refresh Properties Refresh Configuration Incremental Refresh - The incremental refresh for the data set. See incremental_refresh.
- incremental
Refresh DataSet Refresh Properties Refresh Configuration Incremental Refresh - The incremental refresh for the data set. See incremental_refresh.
- incremental_
refresh DataSet Refresh Properties Refresh Configuration Incremental Refresh - The incremental refresh for the data set. See incremental_refresh.
- incremental
Refresh Property Map - The incremental refresh for the data set. See incremental_refresh.
DataSetRefreshPropertiesRefreshConfigurationIncrementalRefresh, DataSetRefreshPropertiesRefreshConfigurationIncrementalRefreshArgs
- Lookback
Window DataSet Refresh Properties Refresh Configuration Incremental Refresh Lookback Window - The lookback window setup for an incremental refresh configuration. See lookback_window.
- Lookback
Window DataSet Refresh Properties Refresh Configuration Incremental Refresh Lookback Window - The lookback window setup for an incremental refresh configuration. See lookback_window.
- lookback
Window DataSet Refresh Properties Refresh Configuration Incremental Refresh Lookback Window - The lookback window setup for an incremental refresh configuration. See lookback_window.
- lookback
Window DataSet Refresh Properties Refresh Configuration Incremental Refresh Lookback Window - The lookback window setup for an incremental refresh configuration. See lookback_window.
- lookback_
window DataSet Refresh Properties Refresh Configuration Incremental Refresh Lookback Window - The lookback window setup for an incremental refresh configuration. See lookback_window.
- lookback
Window Property Map - The lookback window setup for an incremental refresh configuration. See lookback_window.
DataSetRefreshPropertiesRefreshConfigurationIncrementalRefreshLookbackWindow, DataSetRefreshPropertiesRefreshConfigurationIncrementalRefreshLookbackWindowArgs
- Column
Name string - The name of the lookback window column.
- Size int
- The lookback window column size.
- Size
Unit string - The size unit that is used for the lookback window column. Valid values for this structure are
HOUR,DAY, andWEEK.
- Column
Name string - The name of the lookback window column.
- Size int
- The lookback window column size.
- Size
Unit string - The size unit that is used for the lookback window column. Valid values for this structure are
HOUR,DAY, andWEEK.
- column
Name String - The name of the lookback window column.
- size Integer
- The lookback window column size.
- size
Unit String - The size unit that is used for the lookback window column. Valid values for this structure are
HOUR,DAY, andWEEK.
- column
Name string - The name of the lookback window column.
- size number
- The lookback window column size.
- size
Unit string - The size unit that is used for the lookback window column. Valid values for this structure are
HOUR,DAY, andWEEK.
- column_
name str - The name of the lookback window column.
- size int
- The lookback window column size.
- size_
unit str - The size unit that is used for the lookback window column. Valid values for this structure are
HOUR,DAY, andWEEK.
- column
Name String - The name of the lookback window column.
- size Number
- The lookback window column size.
- size
Unit String - The size unit that is used for the lookback window column. Valid values for this structure are
HOUR,DAY, andWEEK.
DataSetRowLevelPermissionDataSet, DataSetRowLevelPermissionDataSetArgs
- Arn string
- ARN of the dataset that contains permissions for RLS.
- Permission
Policy string - Type of permissions to use when interpreting the permissions for RLS. Valid values are
GRANT_ACCESSandDENY_ACCESS. - Format
Version string - User or group rules associated with the dataset that contains permissions for RLS.
- Namespace string
- Namespace associated with the dataset that contains permissions for RLS.
- Status string
- Status of the row-level security permission dataset. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
- Arn string
- ARN of the dataset that contains permissions for RLS.
- Permission
Policy string - Type of permissions to use when interpreting the permissions for RLS. Valid values are
GRANT_ACCESSandDENY_ACCESS. - Format
Version string - User or group rules associated with the dataset that contains permissions for RLS.
- Namespace string
- Namespace associated with the dataset that contains permissions for RLS.
- Status string
- Status of the row-level security permission dataset. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
- arn String
- ARN of the dataset that contains permissions for RLS.
- permission
Policy String - Type of permissions to use when interpreting the permissions for RLS. Valid values are
GRANT_ACCESSandDENY_ACCESS. - format
Version String - User or group rules associated with the dataset that contains permissions for RLS.
- namespace String
- Namespace associated with the dataset that contains permissions for RLS.
- status String
- Status of the row-level security permission dataset. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
- arn string
- ARN of the dataset that contains permissions for RLS.
- permission
Policy string - Type of permissions to use when interpreting the permissions for RLS. Valid values are
GRANT_ACCESSandDENY_ACCESS. - format
Version string - User or group rules associated with the dataset that contains permissions for RLS.
- namespace string
- Namespace associated with the dataset that contains permissions for RLS.
- status string
- Status of the row-level security permission dataset. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
- arn str
- ARN of the dataset that contains permissions for RLS.
- permission_
policy str - Type of permissions to use when interpreting the permissions for RLS. Valid values are
GRANT_ACCESSandDENY_ACCESS. - format_
version str - User or group rules associated with the dataset that contains permissions for RLS.
- namespace str
- Namespace associated with the dataset that contains permissions for RLS.
- status str
- Status of the row-level security permission dataset. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
- arn String
- ARN of the dataset that contains permissions for RLS.
- permission
Policy String - Type of permissions to use when interpreting the permissions for RLS. Valid values are
GRANT_ACCESSandDENY_ACCESS. - format
Version String - User or group rules associated with the dataset that contains permissions for RLS.
- namespace String
- Namespace associated with the dataset that contains permissions for RLS.
- status String
- Status of the row-level security permission dataset. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
DataSetRowLevelPermissionTagConfiguration, DataSetRowLevelPermissionTagConfigurationArgs
- Tag
Rules List<DataSet Row Level Permission Tag Configuration Tag Rule> - A set of rules associated with row-level security, such as the tag names and columns that they are assigned to. See tag_rules.
- Status string
- The status of row-level security tags. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
- Tag
Rules []DataSet Row Level Permission Tag Configuration Tag Rule - A set of rules associated with row-level security, such as the tag names and columns that they are assigned to. See tag_rules.
- Status string
- The status of row-level security tags. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
- tag
Rules List<DataSet Row Level Permission Tag Configuration Tag Rule> - A set of rules associated with row-level security, such as the tag names and columns that they are assigned to. See tag_rules.
- status String
- The status of row-level security tags. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
- tag
Rules DataSet Row Level Permission Tag Configuration Tag Rule[] - A set of rules associated with row-level security, such as the tag names and columns that they are assigned to. See tag_rules.
- status string
- The status of row-level security tags. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
- tag_
rules Sequence[DataSet Row Level Permission Tag Configuration Tag Rule] - A set of rules associated with row-level security, such as the tag names and columns that they are assigned to. See tag_rules.
- status str
- The status of row-level security tags. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
- tag
Rules List<Property Map> - A set of rules associated with row-level security, such as the tag names and columns that they are assigned to. See tag_rules.
- status String
- The status of row-level security tags. If enabled, the status is
ENABLED. If disabled, the status isDISABLED.
DataSetRowLevelPermissionTagConfigurationTagRule, DataSetRowLevelPermissionTagConfigurationTagRuleArgs
- Column
Name string - Column name that a tag key is assigned to.
- Tag
Key string - Unique key for a tag.
- Match
All stringValue - A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one.
- Tag
Multi stringValue Delimiter - A string that you want to use to delimit the values when you pass the values at run time.
- Column
Name string - Column name that a tag key is assigned to.
- Tag
Key string - Unique key for a tag.
- Match
All stringValue - A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one.
- Tag
Multi stringValue Delimiter - A string that you want to use to delimit the values when you pass the values at run time.
- column
Name String - Column name that a tag key is assigned to.
- tag
Key String - Unique key for a tag.
- match
All StringValue - A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one.
- tag
Multi StringValue Delimiter - A string that you want to use to delimit the values when you pass the values at run time.
- column
Name string - Column name that a tag key is assigned to.
- tag
Key string - Unique key for a tag.
- match
All stringValue - A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one.
- tag
Multi stringValue Delimiter - A string that you want to use to delimit the values when you pass the values at run time.
- column_
name str - Column name that a tag key is assigned to.
- tag_
key str - Unique key for a tag.
- match_
all_ strvalue - A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one.
- tag_
multi_ strvalue_ delimiter - A string that you want to use to delimit the values when you pass the values at run time.
- column
Name String - Column name that a tag key is assigned to.
- tag
Key String - Unique key for a tag.
- match
All StringValue - A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one.
- tag
Multi StringValue Delimiter - A string that you want to use to delimit the values when you pass the values at run time.
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.