Skip to content
v2.277.0

RelationalTableProperty Struct ​

A physical table type for relational data sources.

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 relationalTableProperty: quicksight.CfnDataSet.RelationalTableProperty = {
  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',
};
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

relational_table_property = 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"
)
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.*;

RelationalTableProperty relationalTableProperty = 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();
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 relationalTableProperty = 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"
};
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"

relationalTableProperty := &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"),
}

Properties ​

catalogoptionalstringcatalogoptionalstrcatalogoptionalStringCatalogoptionalstringCatalogoptional*string#
The catalog associated with a table.
dataSourceArnstringdata_source_arnstrdataSourceArnStringDataSourceArnstringDataSourceArn*stringrequired#
The Amazon Resource Name (ARN) for the data source.
inputColumnsIResolvable | IResolvable | CfnDataSet.InputColumnProperty[]input_columnstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InputColumnProperty]]]inputColumnsIResolvableInputColumnsIResolvableInputColumnsinterface{}required#
The column schema of the table.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the relational table.
schemaoptionalstringschemaoptionalstrschemaoptionalStringSchemaoptionalstringSchemaoptional*string#
The schema name.

This name applies to certain relational database engines.