software.amazon.awscdk.services.glue

Class DataFormat

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.glue.DataFormat

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:07.710Z")
 @Stability(value=Experimental)
public class DataFormat
extends software.amazon.jsii.JsiiObject

(experimental) Defines the input/output formats and ser/de for a single DataFormat.

Example:

 Database myDatabase;
 Table.Builder.create(this, "MyTable")
         .database(myDatabase)
         .tableName("my_table")
         .columns(List.of(Column.builder()
                 .name("col1")
                 .type(Schema.STRING)
                 .build()))
         .partitionKeys(List.of(Column.builder()
                 .name("year")
                 .type(Schema.SMALL_INT)
                 .build(), Column.builder()
                 .name("month")
                 .type(Schema.SMALL_INT)
                 .build()))
         .dataFormat(DataFormat.JSON)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataFormat.Builder (experimental) A fluent builder for DataFormat.

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

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static DataFormat	APACHE_LOGS (experimental) DataFormat for Apache Web Server Logs.
static DataFormat	AVRO (experimental) DataFormat for Apache Avro.
static DataFormat	CLOUDTRAIL_LOGS (experimental) DataFormat for CloudTrail logs stored on S3.
static DataFormat	CSV (experimental) DataFormat for CSV Files.
static DataFormat	JSON (experimental) Stored as plain text files in JSON format.
static DataFormat	LOGSTASH (experimental) DataFormat for Logstash Logs, using the GROK SerDe.
static DataFormat	ORC (experimental) DataFormat for Apache ORC (Optimized Row Columnar).
static DataFormat	PARQUET (experimental) DataFormat for Apache Parquet.
static DataFormat	TSV (experimental) DataFormat for TSV (Tab-Separated Values).

Constructor Summary

Constructors

Modifier	Constructor and Description
	DataFormat(DataFormatProps props)
protected	DataFormat(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DataFormat(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
ClassificationString	getClassificationString() (experimental) Classification string given to tables with this data format.
InputFormat	getInputFormat() (experimental) `InputFormat` for this data format.
OutputFormat	getOutputFormat() (experimental) `OutputFormat` for this data format.
SerializationLibrary	getSerializationLibrary() (experimental) Serialization library for this data format.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

APACHE_LOGS

@Stability(value=Experimental)
public static final DataFormat APACHE_LOGS

(experimental) DataFormat for Apache Web Server Logs.

Also works for CloudFront logs

See Also:

https://docs.aws.amazon.com/athena/latest/ug/apache.html

AVRO

@Stability(value=Experimental)
public static final DataFormat AVRO

(experimental) DataFormat for Apache Avro.

See Also:

https://docs.aws.amazon.com/athena/latest/ug/avro.html

CLOUDTRAIL_LOGS

@Stability(value=Experimental)
public static final DataFormat CLOUDTRAIL_LOGS

(experimental) DataFormat for CloudTrail logs stored on S3.

See Also:

https://docs.aws.amazon.com/athena/latest/ug/cloudtrail.html

CSV

@Stability(value=Experimental)
public static final DataFormat CSV

(experimental) DataFormat for CSV Files.

See Also:

https://docs.aws.amazon.com/athena/latest/ug/csv.html

JSON

@Stability(value=Experimental)
public static final DataFormat JSON

(experimental) Stored as plain text files in JSON format.

Uses OpenX Json SerDe for serialization and deseralization.

See Also:

https://docs.aws.amazon.com/athena/latest/ug/json.html

LOGSTASH

@Stability(value=Experimental)
public static final DataFormat LOGSTASH

(experimental) DataFormat for Logstash Logs, using the GROK SerDe.

See Also:

https://docs.aws.amazon.com/athena/latest/ug/grok.html

ORC

@Stability(value=Experimental)
public static final DataFormat ORC

(experimental) DataFormat for Apache ORC (Optimized Row Columnar).

See Also:

https://docs.aws.amazon.com/athena/latest/ug/orc.html

PARQUET

@Stability(value=Experimental)
public static final DataFormat PARQUET

(experimental) DataFormat for Apache Parquet.

See Also:

https://docs.aws.amazon.com/athena/latest/ug/parquet.html

TSV

@Stability(value=Experimental)
public static final DataFormat TSV

(experimental) DataFormat for TSV (Tab-Separated Values).

See Also:

https://docs.aws.amazon.com/athena/latest/ug/lazy-simple-serde.html

Constructor Detail

DataFormat

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

DataFormat

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

DataFormat

@Stability(value=Experimental)
public DataFormat(@NotNull
                                                 DataFormatProps props)

Parameters:

props - This parameter is required.

Method Detail

getInputFormat

@Stability(value=Experimental)
 @NotNull
public InputFormat getInputFormat()

(experimental) `InputFormat` for this data format.

getOutputFormat

@Stability(value=Experimental)
 @NotNull
public OutputFormat getOutputFormat()

(experimental) `OutputFormat` for this data format.

getSerializationLibrary

@Stability(value=Experimental)
 @NotNull
public SerializationLibrary getSerializationLibrary()

(experimental) Serialization library for this data format.

getClassificationString

@Stability(value=Experimental)
 @Nullable
public ClassificationString getClassificationString()

(experimental) Classification string given to tables with this data format.