Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnDataSetPropsMixin.RelationalTableProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSetPropsMixin.RelationalTableProperty.Jsii$Proxy

Enclosing class:

CfnDataSetPropsMixin

@Stability(Stable)
public static interface CfnDataSetPropsMixin.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.cfnpropertymixins.services.quicksight.*;
 RelationalTableProperty relationalTableProperty = RelationalTableProperty.builder()
         .catalog("catalog")
         .dataSourceArn("dataSourceArn")
         .inputColumns(List.of(InputColumnProperty.builder()
                 .id("id")
                 .name("name")
                 .subType("subType")
                 .type("type")
                 .build()))
         .name("name")
         .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	CfnDataSetPropsMixin.RelationalTableProperty.Builder	A builder for CfnDataSetPropsMixin.RelationalTableProperty
static final class	CfnDataSetPropsMixin.RelationalTableProperty.Jsii$Proxy	An implementation for CfnDataSetPropsMixin.RelationalTableProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSetPropsMixin.RelationalTableProperty.Builder	builder()
default String	getCatalog()	The catalog associated with a table.
default String	getDataSourceArn()	The Amazon Resource Name (ARN) for the data source.
default Object	getInputColumns()	The column schema of the table.
default 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

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

getDataSourceArn

@Stability(Stable)
@Nullable
default 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)
@Nullable
default Object getInputColumns()

The column schema of the table.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSetPropsMixin.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)
@Nullable
default 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

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 CfnDataSetPropsMixin.RelationalTableProperty.Builder builder()

Returns:

a CfnDataSetPropsMixin.RelationalTableProperty.Builder of CfnDataSetPropsMixin.RelationalTableProperty