Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.CustomSqlProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.CustomSqlProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

@Stability(Stable)
public static interface CfnDataSet.CustomSqlProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // 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
                 .subType("subType")
                 .build()))
         .dataSourceArn("dataSourceArn")
         .name("name")
         .sqlQuery("sqlQuery")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSet.CustomSqlProperty.Builder	A builder for CfnDataSet.CustomSqlProperty
static final class	CfnDataSet.CustomSqlProperty.Jsii$Proxy	An implementation for CfnDataSet.CustomSqlProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.CustomSqlProperty.Builder	builder()
Object	getColumns()	The column schema from the SQL query result set.
String	getDataSourceArn()	The Amazon Resource Name (ARN) of the data source.
String	getName()	A display name for the SQL query result.
String	getSqlQuery()	The SQL query.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumns

@Stability(Stable)
@NotNull
Object getColumns()

The column schema from the SQL query result set.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-columns

getDataSourceArn

@Stability(Stable)
@NotNull
String getDataSourceArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-datasourcearn

getName

@Stability(Stable)
@NotNull
String getName()

A display name for the SQL query result.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-name

getSqlQuery

@Stability(Stable)
@NotNull
String getSqlQuery()

The SQL query.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-customsql.html#cfn-quicksight-dataset-customsql-sqlquery

builder

@Stability(Stable)
static CfnDataSet.CustomSqlProperty.Builder builder()

Returns:

a CfnDataSet.CustomSqlProperty.Builder of CfnDataSet.CustomSqlProperty