Package software.amazon.awscdk.services.glue

Interface CfnTableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:20.026Z")
@Stability(Stable)
public interface CfnTableProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTable.

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;
 CfnTableProps cfnTableProps = CfnTableProps.builder()
         .catalogId("catalogId")
         .databaseName("databaseName")
         .tableInput(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")
                         .region("region")
                         .build())
                 .viewExpandedText("viewExpandedText")
                 .viewOriginalText("viewOriginalText")
                 .build())
         // the properties below are optional
         .openTableFormatInput(OpenTableFormatInputProperty.builder()
                 .icebergInput(IcebergInputProperty.builder()
                         .metadataOperation("metadataOperation")
                         .version("version")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTableProps.Builder	builder()
String	getCatalogId()	The ID of the Data Catalog in which to create the Table .
String	getDatabaseName()	The name of the database where the table metadata resides.
default Object	getOpenTableFormatInput()	Specifies an OpenTableFormatInput structure when creating an open format table.
Object	getTableInput()	A structure used to define a table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCatalogId

@Stability(Stable)
@NotNull
String getCatalogId()

The ID of the Data Catalog in which to create the Table .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-catalogid

getDatabaseName

@Stability(Stable)
@NotNull
String getDatabaseName()

The name of the database where the table metadata resides.

For Hive compatibility, this must be all lowercase.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-databasename

getTableInput

@Stability(Stable)
@NotNull
Object getTableInput()

A structure used to define a table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-tableinput

getOpenTableFormatInput

@Stability(Stable)
@Nullable
default Object getOpenTableFormatInput()

Specifies an OpenTableFormatInput structure when creating an open format table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-opentableformatinput

builder

@Stability(Stable)
static CfnTableProps.Builder builder()

Returns:

a CfnTableProps.Builder of CfnTableProps