PhysicalTableProperty Struct
A view of a data source that contains information about the shape of the data in the underlying source.
This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
| Source | |
|---|---|
| Type last changed |
Example
ts
// 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 physicalTableProperty: quicksight.CfnDataSet.PhysicalTableProperty = {
customSql: {
columns: [{
name: 'name',
type: 'type',
// the properties below are optional
id: 'id',
subType: 'subType',
}],
dataSourceArn: 'dataSourceArn',
name: 'name',
sqlQuery: 'sqlQuery',
},
relationalTable: {
dataSourceArn: 'dataSourceArn',
inputColumns: [{
name: 'name',
type: 'type',
// the properties below are optional
id: 'id',
subType: 'subType',
}],
name: 'name',
// the properties below are optional
catalog: 'catalog',
schema: 'schema',
},
s3Source: {
dataSourceArn: 'dataSourceArn',
inputColumns: [{
name: 'name',
type: 'type',
// the properties below are optional
id: 'id',
subType: 'subType',
}],
// the properties below are optional
uploadSettings: {
containsHeader: false,
delimiter: 'delimiter',
format: 'format',
startFromRow: 123,
textQualifier: 'textQualifier',
},
},
saaSTable: {
dataSourceArn: 'dataSourceArn',
inputColumns: [{
name: 'name',
type: 'type',
// the properties below are optional
id: 'id',
subType: 'subType',
}],
tablePath: [{
id: 'id',
name: 'name',
}],
},
};
python
# 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
physical_table_property = quicksight.CfnDataSet.PhysicalTableProperty(
custom_sql=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"
),
relational_table=quicksight.CfnDataSet.RelationalTableProperty(
data_source_arn="dataSourceArn",
input_columns=[quicksight.CfnDataSet.InputColumnProperty(
name="name",
type="type",
# the properties below are optional
id="id",
sub_type="subType"
)],
name="name",
# the properties below are optional
catalog="catalog",
schema="schema"
),
s3_source=quicksight.CfnDataSet.S3SourceProperty(
data_source_arn="dataSourceArn",
input_columns=[quicksight.CfnDataSet.InputColumnProperty(
name="name",
type="type",
# the properties below are optional
id="id",
sub_type="subType"
)],
# the properties below are optional
upload_settings=quicksight.CfnDataSet.UploadSettingsProperty(
contains_header=False,
delimiter="delimiter",
format="format",
start_from_row=123,
text_qualifier="textQualifier"
)
),
saa_s_table=quicksight.CfnDataSet.SaaSTableProperty(
data_source_arn="dataSourceArn",
input_columns=[quicksight.CfnDataSet.InputColumnProperty(
name="name",
type="type",
# the properties below are optional
id="id",
sub_type="subType"
)],
table_path=[quicksight.CfnDataSet.TablePathElementProperty(
id="id",
name="name"
)]
)
)
java
// 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.*;
PhysicalTableProperty physicalTableProperty = PhysicalTableProperty.builder()
.customSql(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())
.relationalTable(RelationalTableProperty.builder()
.dataSourceArn("dataSourceArn")
.inputColumns(List.of(InputColumnProperty.builder()
.name("name")
.type("type")
// the properties below are optional
.id("id")
.subType("subType")
.build()))
.name("name")
// the properties below are optional
.catalog("catalog")
.schema("schema")
.build())
.s3Source(S3SourceProperty.builder()
.dataSourceArn("dataSourceArn")
.inputColumns(List.of(InputColumnProperty.builder()
.name("name")
.type("type")
// the properties below are optional
.id("id")
.subType("subType")
.build()))
// the properties below are optional
.uploadSettings(UploadSettingsProperty.builder()
.containsHeader(false)
.delimiter("delimiter")
.format("format")
.startFromRow(123)
.textQualifier("textQualifier")
.build())
.build())
.saaSTable(SaaSTableProperty.builder()
.dataSourceArn("dataSourceArn")
.inputColumns(List.of(InputColumnProperty.builder()
.name("name")
.type("type")
// the properties below are optional
.id("id")
.subType("subType")
.build()))
.tablePath(List.of(TablePathElementProperty.builder()
.id("id")
.name("name")
.build()))
.build())
.build();
csharp
// 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 physicalTableProperty = new PhysicalTableProperty {
CustomSql = 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"
},
RelationalTable = new RelationalTableProperty {
DataSourceArn = "dataSourceArn",
InputColumns = new [] { new InputColumnProperty {
Name = "name",
Type = "type",
// the properties below are optional
Id = "id",
SubType = "subType"
} },
Name = "name",
// the properties below are optional
Catalog = "catalog",
Schema = "schema"
},
S3Source = new S3SourceProperty {
DataSourceArn = "dataSourceArn",
InputColumns = new [] { new InputColumnProperty {
Name = "name",
Type = "type",
// the properties below are optional
Id = "id",
SubType = "subType"
} },
// the properties below are optional
UploadSettings = new UploadSettingsProperty {
ContainsHeader = false,
Delimiter = "delimiter",
Format = "format",
StartFromRow = 123,
TextQualifier = "textQualifier"
}
},
SaaSTable = new SaaSTableProperty {
DataSourceArn = "dataSourceArn",
InputColumns = new [] { new InputColumnProperty {
Name = "name",
Type = "type",
// the properties below are optional
Id = "id",
SubType = "subType"
} },
TablePath = new [] { new TablePathElementProperty {
Id = "id",
Name = "name"
} }
}
};
go
// 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"
physicalTableProperty := &PhysicalTableProperty{
CustomSql: &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"),
},
RelationalTable: &RelationalTableProperty{
DataSourceArn: jsii.String("dataSourceArn"),
InputColumns: []interface{}{
&InputColumnProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Id: jsii.String("id"),
SubType: jsii.String("subType"),
},
},
Name: jsii.String("name"),
// the properties below are optional
Catalog: jsii.String("catalog"),
Schema: jsii.String("schema"),
},
S3Source: &S3SourceProperty{
DataSourceArn: jsii.String("dataSourceArn"),
InputColumns: []interface{}{
&InputColumnProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Id: jsii.String("id"),
SubType: jsii.String("subType"),
},
},
// the properties below are optional
UploadSettings: &UploadSettingsProperty{
ContainsHeader: jsii.Boolean(false),
Delimiter: jsii.String("delimiter"),
Format: jsii.String("format"),
StartFromRow: jsii.Number(123),
TextQualifier: jsii.String("textQualifier"),
},
},
SaaSTable: &SaaSTableProperty{
DataSourceArn: jsii.String("dataSourceArn"),
InputColumns: []interface{}{
&InputColumnProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Id: jsii.String("id"),
SubType: jsii.String("subType"),
},
},
TablePath: []interface{}{
&TablePathElementProperty{
Id: jsii.String("id"),
Name: jsii.String("name"),
},
},
},
}
Properties
customSqloptionalIResolvable | CfnDataSet.CustomSqlPropertycustom_sqloptionaltyping.Union[IResolvable, CustomSqlProperty]customSqloptionalIResolvableCustomSqloptionalIResolvableCustomSqloptionalinterface{} #A physical table type built from the results of the custom SQL query.
relationalTableoptionalIResolvable | CfnDataSet.relational_tableoptionaltyping.Union[IResolvable, RelationalTableProperty]relationalTableoptionalIResolvableRelationalTableoptionalIResolvableRelationalTableoptionalinterface{} #A physical table type for relational data sources.
s3SourceoptionalIResolvable | CfnDataSet.S3SourcePropertys3_sourceoptionaltyping.Union[IResolvable, S3SourceProperty]s3SourceoptionalIResolvableS3SourceoptionalIResolvableS3Sourceoptionalinterface{} #A physical table type for as S3 data source.
saaSTableoptionalIResolvable | CfnDataSet.SaaSTablePropertysaa_s_tableoptionaltyping.Union[IResolvable, SaaSTableProperty]saaSTableoptionalIResolvableSaaSTableoptionalIResolvableSaaSTableoptionalinterface{} #A physical table type for Software-as-a-Service (SaaS) sources.