software.amazon.awscdk.services.glue

Interface CfnTable.TableInputProperty

All Known Implementing Classes:

CfnTable.TableInputProperty.Jsii$Proxy

Enclosing class:

CfnTable

public static interface CfnTable.TableInputProperty

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 java.lang.String	getDescription() A description of the table.
default java.lang.String	getName() The table name.
default java.lang.String	getOwner() The table owner.
default java.lang.Object	getParameters() These key-value pairs define properties associated with the table.
default java.lang.Object	getPartitionKeys() A list of columns by which the table is partitioned.
default java.lang.Number	getRetention() The retention time for this table.
default java.lang.Object	getStorageDescriptor() A storage descriptor containing information about the physical storage of this table.
default java.lang.String	getTableType() The type of this table.
default java.lang.Object	getTargetTable() A `TableIdentifier` structure that describes a target table for resource linking.
default java.lang.String	getViewExpandedText() Included for Apache Hive compatibility.
default java.lang.String	getViewOriginalText() Included for Apache Hive compatibility.

Method Detail

getDescription

default java.lang.String getDescription()

A description of the table.

getName

default java.lang.String getName()

The table name.

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

getOwner

default java.lang.String getOwner()

The table owner.

Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations.

getParameters

default java.lang.Object getParameters()

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

getPartitionKeys

default java.lang.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

default java.lang.Number getRetention()

The retention time for this table.

getStorageDescriptor

default java.lang.Object getStorageDescriptor()

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

getTableType

default java.lang.String getTableType()

The type of this table.

AWS Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.

AWS Glue related table types:

• EXTERNAL_TABLE - Hive compatible attribute - indicates a non-Hive managed table.
• GOVERNED - Used by AWS Lake Formation . The AWS Glue Data Catalog understands GOVERNED .

getTargetTable

default java.lang.Object getTargetTable()

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

getViewExpandedText

default java.lang.String getViewExpandedText()

Included for Apache Hive compatibility.

Not used in the normal course of AWS Glue operations.

getViewOriginalText

default java.lang.String getViewOriginalText()

Included for Apache Hive compatibility.

Not used in the normal course of AWS Glue operations. If the table is a VIRTUAL_VIEW , certain Athena configuration encoded in base64.

builder

static CfnTable.TableInputProperty.Builder builder()

Returns:

a CfnTable.TableInputProperty.Builder of CfnTable.TableInputProperty