aws-cdk-lib.aws_quicksight.CfnDataSet.CustomSqlProperty

CustomSqlProperty Struct

A physical table type built from the results of the custom SQL query.

Source

Generated code

Type last changed

v2.224.0 · 13 Nov 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const customSqlProperty: quicksight.CfnDataSet.CustomSqlProperty = {
  columns: [{
    name: 'name',
    type: 'type',

    // the properties below are optional
    id: 'id',
    subType: 'subType',
  }],
  dataSourceArn: 'dataSourceArn',
  name: 'name',
  sqlQuery: 'sqlQuery',
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

custom_sql_property = quicksight.CfnDataSet.CustomSqlProperty(
    columns=[quicksight.CfnDataSet.InputColumnProperty(
        name="name",
        type="type",

        # the properties below are optional
        id="id",
        sub_type="subType"
    )],
    data_source_arn="dataSourceArn",
    name="name",
    sql_query="sqlQuery"
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

CustomSqlProperty customSqlProperty = CustomSqlProperty.builder()
        .columns(List.of(InputColumnProperty.builder()
                .name("name")
                .type("type")

                // the properties below are optional
                .id("id")
                .subType("subType")
                .build()))
        .dataSourceArn("dataSourceArn")
        .name("name")
        .sqlQuery("sqlQuery")
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var customSqlProperty = new CustomSqlProperty {
    Columns = new [] { new InputColumnProperty {
        Name = "name",
        Type = "type",

        // the properties below are optional
        Id = "id",
        SubType = "subType"
    } },
    DataSourceArn = "dataSourceArn",
    Name = "name",
    SqlQuery = "sqlQuery"
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

customSqlProperty := &CustomSqlProperty{
	Columns: []interface{}{
		&InputColumnProperty{
			Name: jsii.String("name"),
			Type: jsii.String("type"),

			// the properties below are optional
			Id: jsii.String("id"),
			SubType: jsii.String("subType"),
		},
	},
	DataSourceArn: jsii.String("dataSourceArn"),
	Name: jsii.String("name"),
	SqlQuery: jsii.String("sqlQuery"),
}

Properties

columnsIResolvable | IResolvable | CfnDataSet.InputColumnProperty[]columnstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InputColumnProperty]]]columnsIResolvableColumnsIResolvableColumnsinterface{}required#

The column schema from the SQL query result set.

dataSourceArnstringdata_source_arnstrdataSourceArnStringDataSourceArnstringDataSourceArn*stringrequired#

The Amazon Resource Name (ARN) of the data source.

namestringnamestrnameStringNamestringName*stringrequired#

A display name for the SQL query result.

sqlQuerystringsql_querystrsqlQueryStringSqlQuerystringSqlQuery*stringrequired#

The SQL query.