Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.RelationalTableProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.RelationalTableProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

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

A physical table type for relational data sources.

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.*;
 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.RelationalTableProperty.Builder	builder()
default String	getCatalog()	The catalog associated with a table.
String	getDataSourceArn()	The Amazon Resource Name (ARN) for the data source.
Object	getInputColumns()	The column schema of the table.
String	getName()	The name of the relational table.
default String	getSchema()	The schema name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSourceArn

@Stability(Stable)
@NotNull
String getDataSourceArn()

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

See Also:

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

getInputColumns

@Stability(Stable)
@NotNull
Object getInputColumns()

The column schema of the table.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSet.InputColumnProperty>

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the relational table.

See Also:

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

getCatalog

@Stability(Stable)
@Nullable
default String getCatalog()

The catalog associated with a table.

See Also:

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

getSchema

@Stability(Stable)
@Nullable
default String getSchema()

The schema name.

This name applies to certain relational database engines.

See Also:

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

builder

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

Returns:

a CfnDataSet.RelationalTableProperty.Builder of CfnDataSet.RelationalTableProperty