software.amazon.awscdk.services.glue

Class Table

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.glue.Table

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:31.579Z")
 @Stability(value=Experimental)
public class Table
extends Resource
implements ITable

(experimental) A Glue table.

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	Table.Builder (experimental) A fluent builder for 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.services.glue.ITable

ITable.Jsii$Default, ITable.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addPartitionIndex(PartitionIndex index) (experimental) Add a partition index to the table.
static ITable	fromTableArn(software.constructs.Construct scope, String id, String tableArn)
static ITable	fromTableAttributes(software.constructs.Construct scope, String id, TableAttributes attrs) (experimental) Creates a Table construct that represents an external table.
IBucket	getBucket() (experimental) S3 bucket in which the table's data resides.
List<Column>	getColumns() (experimental) This table's columns.
Boolean	getCompressed() (experimental) Indicates whether the table's data is compressed or not.
IDatabase	getDatabase() (experimental) Database this table belongs to.
DataFormat	getDataFormat() (experimental) Format of this table's data files.
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.
List<Column>	getPartitionKeys() (experimental) This table's partition keys if the table is partitioned.
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.
Grant	grant(IGrantable grantee, List<String> actions) (experimental) Grant the given identity custom permissions.
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	grantToUnderlyingResources(IGrantable grantee, List<String> actions) (experimental) Grant the given identity custom permissions to ALL underlying resources of the table.
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.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Table

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

Table

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

Table

@Stability(value=Experimental)
public Table(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            TableProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromTableArn

@Stability(value=Experimental)
 @NotNull
public static ITable fromTableArn(@NotNull
                                                                           software.constructs.Construct scope,
                                                                           @NotNull
                                                                           String id,
                                                                           @NotNull
                                                                           String tableArn)

Parameters:

scope - This parameter is required.

id - This parameter is required.

tableArn - This parameter is required.

fromTableAttributes

@Stability(value=Experimental)
 @NotNull
public static ITable fromTableAttributes(@NotNull
                                                                                  software.constructs.Construct scope,
                                                                                  @NotNull
                                                                                  String id,
                                                                                  @NotNull
                                                                                  TableAttributes attrs)

(experimental) Creates a Table construct that represents an external table.

Parameters:

scope - The scope creating construct (usually `this`). This parameter is required.

id - The construct's id. This parameter is required.

attrs - Import attributes. This parameter is required.

addPartitionIndex

@Stability(value=Experimental)
public void addPartitionIndex(@NotNull
                                                             PartitionIndex index)

(experimental) Add a partition index to the table.

You can have a maximum of 3 partition indexes to a table. Partition index keys must be a subset of the table's partition keys.

Parameters:

index - This parameter is required.

See Also:

https://docs.aws.amazon.com/glue/latest/dg/partition-indexes.html

grant

@Stability(value=Experimental)
 @NotNull
public Grant grant(@NotNull
                                                            IGrantable grantee,
                                                            @NotNull
                                                            List<String> actions)

(experimental) Grant the given identity custom permissions.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(value=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.

Parameters:

grantee - the principal. This parameter is required.

grantReadWrite

@Stability(value=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.

Parameters:

grantee - the principal. This parameter is required.

grantToUnderlyingResources

@Stability(value=Experimental)
 @NotNull
public Grant grantToUnderlyingResources(@NotNull
                                                                                 IGrantable grantee,
                                                                                 @NotNull
                                                                                 List<String> actions)

(experimental) Grant the given identity custom permissions to ALL underlying resources of the table.

Permissions will be granted to the catalog, the database, and the table.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantWrite

@Stability(value=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.

Parameters:

grantee - the principal. This parameter is required.

getBucket

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

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

getColumns

@Stability(value=Experimental)
 @NotNull
public List<Column> getColumns()

(experimental) This table's columns.

getCompressed

@Stability(value=Experimental)
 @NotNull
public Boolean getCompressed()

(experimental) Indicates whether the table's data is compressed or not.

getDatabase

@Stability(value=Experimental)
 @NotNull
public IDatabase getDatabase()

(experimental) Database this table belongs to.

getDataFormat

@Stability(value=Experimental)
 @NotNull
public DataFormat getDataFormat()

(experimental) Format of this table's data files.

getEncryption

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

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

getS3Prefix

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

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

getTableArn

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

(experimental) ARN of this table.

Specified by:

getTableArn in interface ITable

getTableName

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

(experimental) Name of this table.

Specified by:

getTableName in interface ITable

getEncryptionKey

@Stability(value=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(value=Experimental)
 @Nullable
public List<PartitionIndex> getPartitionIndexes()

(experimental) This table's partition indexes.

getPartitionKeys

@Stability(value=Experimental)
 @Nullable
public List<Column> getPartitionKeys()

(experimental) This table's partition keys if the table is partitioned.