Package software.amazon.awscdk.services.glue.alpha

Class S3Table

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.glue.alpha.TableBase

software.amazon.awscdk.services.glue.alpha.S3Table

All Implemented Interfaces:

IResource, ITable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

Table

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-10-31T19:13:07.918Z")
@Stability(Experimental)
public class S3Table
extends TableBase

(experimental) A Glue table that targets a S3 dataset.

Example:

 Database myDatabase;
 S3Table.Builder.create(this, "MyTable")
         .database(myDatabase)
         .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)
         .enablePartitionFiltering(true)
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.glue.alpha.ITable

ITable.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	S3Table(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	S3Table(software.amazon.jsii.JsiiObjectRef objRef)
	S3Table(software.constructs.Construct scope, String id, S3TableProps props)

Method Summary

Modifier and Type	Method	Description
protected String	generateS3PrefixForGrant()
IBucket	getBucket()	(experimental) S3 bucket in which the table's data resides.
TableEncryption	getEncryption()	(experimental) The type of encryption enabled for the table.
IKey	getEncryptionKey()	(experimental) The KMS key used to secure the data if encryption is set to CSE-KMS or SSE-KMS.
List<PartitionIndex>	getPartitionIndexes()	(experimental) This table's partition indexes.
String	getS3Prefix()	(experimental) S3 Key Prefix under which this table's files are stored in S3.
String	getTableArn()	(experimental) ARN of this table.
String	getTableName()	(experimental) Name of this table.
protected CfnTable	getTableResource()
Grant	grantRead(IGrantable grantee)	(experimental) Grant read permissions to the table and the underlying data stored in S3 to an IAM principal.
Grant	grantReadWrite(IGrantable grantee)	(experimental) Grant read and write permissions to the table and the underlying data stored in S3 to an IAM principal.
Grant	grantWrite(IGrantable grantee)	(experimental) Grant write permissions to the table and the underlying data stored in S3 to an IAM principal.

Methods inherited from class software.amazon.awscdk.services.glue.alpha.TableBase

addPartitionIndex, fromTableArn, fromTableAttributes, getColumns, getCompressed, getDatabase, getDataFormat, getParameters, getPartitionKeys, getStorageParameters, grant, grantToUnderlyingResources

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

S3Table

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

S3Table

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

S3Table

@Stability(Experimental)
public S3Table(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 S3TableProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

generateS3PrefixForGrant

@Stability(Experimental)
@NotNull
protected String generateS3PrefixForGrant()

grantRead

@Stability(Experimental)
@NotNull
public Grant grantRead(@NotNull
 IGrantable grantee)

(experimental) Grant read permissions to the table and the underlying data stored in S3 to an IAM principal.

Specified by:

grantRead in class TableBase

Parameters:

grantee - the principal. This parameter is required.

grantReadWrite

@Stability(Experimental)
@NotNull
public Grant grantReadWrite(@NotNull
 IGrantable grantee)

(experimental) Grant read and write permissions to the table and the underlying data stored in S3 to an IAM principal.

Specified by:

grantReadWrite in class TableBase

Parameters:

grantee - the principal. This parameter is required.

grantWrite

@Stability(Experimental)
@NotNull
public Grant grantWrite(@NotNull
 IGrantable grantee)

(experimental) Grant write permissions to the table and the underlying data stored in S3 to an IAM principal.

Specified by:

grantWrite in class TableBase

Parameters:

grantee - the principal. This parameter is required.

getBucket

@Stability(Experimental)
@NotNull
public IBucket getBucket()

(experimental) S3 bucket in which the table's data resides.

getEncryption

@Stability(Experimental)
@NotNull
public TableEncryption getEncryption()

(experimental) The type of encryption enabled for the table.

getS3Prefix

@Stability(Experimental)
@NotNull
public String getS3Prefix()

(experimental) S3 Key Prefix under which this table's files are stored in S3.

getTableArn

@Stability(Experimental)
@NotNull
public String getTableArn()

(experimental) ARN of this table.

Specified by:

getTableArn in interface ITable

Specified by:

getTableArn in class TableBase

getTableName

@Stability(Experimental)
@NotNull
public String getTableName()

(experimental) Name of this table.

Specified by:

getTableName in interface ITable

Specified by:

getTableName in class TableBase

getTableResource

@Stability(Experimental)
@NotNull
protected CfnTable getTableResource()

Specified by:

getTableResource in class TableBase

getEncryptionKey

@Stability(Experimental)
@Nullable
public IKey getEncryptionKey()

(experimental) The KMS key used to secure the data if encryption is set to CSE-KMS or SSE-KMS.

Otherwise, undefined.

getPartitionIndexes

@Stability(Experimental)
@Nullable
public List<PartitionIndex> getPartitionIndexes()

(experimental) This table's partition indexes.

Specified by:

getPartitionIndexes in class TableBase