software.amazon.awscdk.services.glue

Class CfnTable

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.glue.CfnTable

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.576Z")
 @Stability(value=Stable)
public class CfnTable
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Glue::Table`.

The AWS::Glue::Table resource specifies tabular data in the AWS Glue data catalog. For more information, see Defining Tables in the AWS Glue Data Catalog and Table Structure in the AWS Glue Developer Guide .

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;
 CfnTable cfnTable = CfnTable.Builder.create(this, "MyCfnTable")
         .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")
                         .build())
                 .viewExpandedText("viewExpandedText")
                 .viewOriginalText("viewOriginalText")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTable.Builder A fluent builder for CfnTable.
static interface	CfnTable.ColumnProperty A column in a `Table` .
static interface	CfnTable.OrderProperty Specifies the sort order of a sorted column.
static interface	CfnTable.SchemaIdProperty A structure that contains schema identity fields.
static interface	CfnTable.SchemaReferenceProperty An object that references a schema stored in the AWS Glue Schema Registry.
static interface	CfnTable.SerdeInfoProperty Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
static interface	CfnTable.SkewedInfoProperty Specifies skewed values in a table.
static interface	CfnTable.StorageDescriptorProperty Describes the physical storage of table data.
static interface	CfnTable.TableIdentifierProperty A structure that describes a target table for resource linking.
static interface	CfnTable.TableInputProperty A structure used to define a table.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTable(software.constructs.Construct scope, String id, CfnTableProps props) Create a new `AWS::Glue::Table`.
protected	CfnTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTable(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getCatalogId() The ID of the Data Catalog in which to create the `Table` .
protected Map<String,Object>	getCfnProperties()
String	getDatabaseName() The name of the database where the table metadata resides.
Object	getTableInput() A structure used to define a table.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCatalogId(String value) The ID of the Data Catalog in which to create the `Table` .
void	setDatabaseName(String value) The name of the database where the table metadata resides.
void	setTableInput(CfnTable.TableInputProperty value) A structure used to define a table.
void	setTableInput(IResolvable value) A structure used to define a table.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTable

protected CfnTable(software.amazon.jsii.JsiiObjectRef objRef)

CfnTable

protected CfnTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTable

@Stability(value=Stable)
public CfnTable(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnTableProps props)

Create a new `AWS::Glue::Table`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCatalogId

@Stability(value=Stable)
 @NotNull
public String getCatalogId()

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

If none is supplied, the AWS account ID is used by default.

setCatalogId

@Stability(value=Stable)
public void setCatalogId(@NotNull
                                                  String value)

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

If none is supplied, the AWS account ID is used by default.

getDatabaseName

@Stability(value=Stable)
 @NotNull
public String getDatabaseName()

The name of the database where the table metadata resides.

For Hive compatibility, this must be all lowercase.

setDatabaseName

@Stability(value=Stable)
public void setDatabaseName(@NotNull
                                                     String value)

The name of the database where the table metadata resides.

For Hive compatibility, this must be all lowercase.

getTableInput

@Stability(value=Stable)
 @NotNull
public Object getTableInput()

A structure used to define a table.

setTableInput

@Stability(value=Stable)
public void setTableInput(@NotNull
                                                   CfnTable.TableInputProperty value)

A structure used to define a table.

setTableInput

@Stability(value=Stable)
public void setTableInput(@NotNull
                                                   IResolvable value)

A structure used to define a table.