software.amazon.awscdk.services.glue

Interface CfnTable.TableInputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.TableInputProperty.Jsii$Proxy

Enclosing class:

CfnTable

@Stability(value=Stable)
public static interface CfnTable.TableInputProperty
extends software.amazon.jsii.JsiiSerializable

A structure used to define a table.

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.glue.*;
 Object parameters;
 Object skewedColumnValueLocationMaps;
 TableInputProperty tableInputProperty = TableInputProperty.builder()
         .description("description")
         .name("name")
         .owner("owner")
         .parameters(parameters)
         .partitionKeys(List.of(ColumnProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .comment("comment")
                 .type("type")
                 .build()))
         .retention(123)
         .storageDescriptor(StorageDescriptorProperty.builder()
                 .bucketColumns(List.of("bucketColumns"))
                 .columns(List.of(ColumnProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .comment("comment")
                         .type("type")
                         .build()))
                 .compressed(false)
                 .inputFormat("inputFormat")
                 .location("location")
                 .numberOfBuckets(123)
                 .outputFormat("outputFormat")
                 .parameters(parameters)
                 .schemaReference(SchemaReferenceProperty.builder()
                         .schemaId(SchemaIdProperty.builder()
                                 .registryName("registryName")
                                 .schemaArn("schemaArn")
                                 .schemaName("schemaName")
                                 .build())
                         .schemaVersionId("schemaVersionId")
                         .schemaVersionNumber(123)
                         .build())
                 .serdeInfo(SerdeInfoProperty.builder()
                         .name("name")
                         .parameters(parameters)
                         .serializationLibrary("serializationLibrary")
                         .build())
                 .skewedInfo(SkewedInfoProperty.builder()
                         .skewedColumnNames(List.of("skewedColumnNames"))
                         .skewedColumnValueLocationMaps(skewedColumnValueLocationMaps)
                         .skewedColumnValues(List.of("skewedColumnValues"))
                         .build())
                 .sortColumns(List.of(OrderProperty.builder()
                         .column("column")
                         .sortOrder(123)
                         .build()))
                 .storedAsSubDirectories(false)
                 .build())
         .tableType("tableType")
         .targetTable(TableIdentifierProperty.builder()
                 .catalogId("catalogId")
                 .databaseName("databaseName")
                 .name("name")
                 .build())
         .viewExpandedText("viewExpandedText")
         .viewOriginalText("viewOriginalText")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTable.TableInputProperty.Builder A builder for CfnTable.TableInputProperty
static class	CfnTable.TableInputProperty.Jsii$Proxy An implementation for CfnTable.TableInputProperty

Method Summary

Modifier and Type	Method and Description
static CfnTable.TableInputProperty.Builder	builder()
default String	getDescription() A description of the table.
default String	getName() The table name.
default String	getOwner() The table owner.
default Object	getParameters() These key-value pairs define properties associated with the table.
default Object	getPartitionKeys() A list of columns by which the table is partitioned.
default Number	getRetention() The retention time for this table.
default Object	getStorageDescriptor() A storage descriptor containing information about the physical storage of this table.
default String	getTableType() The type of this table ( `EXTERNAL_TABLE` , `VIRTUAL_VIEW` , etc.).
default Object	getTargetTable() A `TableIdentifier` structure that describes a target table for resource linking.
default String	getViewExpandedText() If the table is a view, the expanded text of the view;
default String	getViewOriginalText() If the table is a view, the original text of the view;

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the table.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

The table name.

For Hive compatibility, this is folded to lowercase when it is stored.

getOwner

@Stability(value=Stable)
 @Nullable
default String getOwner()

The table owner.

getParameters

@Stability(value=Stable)
 @Nullable
default Object getParameters()

These key-value pairs define properties associated with the table.

getPartitionKeys

@Stability(value=Stable)
 @Nullable
default Object getPartitionKeys()

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": []

getRetention

@Stability(value=Stable)
 @Nullable
default Number getRetention()

The retention time for this table.

getStorageDescriptor

@Stability(value=Stable)
 @Nullable
default Object getStorageDescriptor()

A storage descriptor containing information about the physical storage of this table.

getTableType

@Stability(value=Stable)
 @Nullable
default String getTableType()

The type of this table ( `EXTERNAL_TABLE` , `VIRTUAL_VIEW` , etc.).

getTargetTable

@Stability(value=Stable)
 @Nullable
default Object getTargetTable()

A `TableIdentifier` structure that describes a target table for resource linking.

getViewExpandedText

@Stability(value=Stable)
 @Nullable
default String getViewExpandedText()

If the table is a view, the expanded text of the view;

otherwise null .

getViewOriginalText

@Stability(value=Stable)
 @Nullable
default String getViewOriginalText()

If the table is a view, the original text of the view;

otherwise null .

builder

@Stability(value=Stable)
static CfnTable.TableInputProperty.Builder builder()

Returns:

a CfnTable.TableInputProperty.Builder of CfnTable.TableInputProperty