class TableBase 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Glue.Alpha.TableBase`
Go	`github.com/aws/aws-cdk-go/awscdkgluealpha/v2#TableBase`
Java	`software.amazon.awscdk.services.glue.alpha.TableBase`
Python	`aws_cdk.aws_glue_alpha.TableBase`
TypeScript (source)	`@aws-cdk/aws-glue-alpha` » `TableBase`

Implements IConstruct, IDependable, IResource, ITable

Extends Resource

Implemented by ExternalTable, S3Table, Table

A Glue table.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as glue_alpha from '@aws-cdk/aws-glue-alpha';
const tableBase = glue_alpha.TableBase.fromTableArn(this, 'MyTableBase', 'tableArn');

Initializer

new TableBase(scope: Construct, id: string, props: TableBaseProps)

Parameters

scope Construct
id string
props TableBaseProps

Properties

Name	Type	Description
columns🔹	`Column[]`	This table's columns.
compressed🔹	`boolean`	Indicates whether the table's data is compressed or not.
dataFormat🔹	`DataFormat`	Format of this table's data files.
database🔹	`IDatabase`	Database this table belongs to.
env🔹	`ResourceEnvironment`	The environment this resource belongs to.
node🔹	`Node`	The tree node.
parameters🔹	`{ [string]: string }`	The tables' properties associated with the table.
stack🔹	`Stack`	The stack in which this resource is defined.
tableArn🔹	`string`
tableName🔹	`string`
tableResource🔹	`CfnTable`
partitionIndexes?🔹	`PartitionIndex[]`
partitionKeys?🔹	`Column[]`	This table's partition keys if the table is partitioned.
storageParameters?🔹	`StorageParameter[]`	The tables' storage descriptor properties.

columns🔹

Type: Column[]

This table's columns.

compressed🔹

Type: boolean

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

dataFormat🔹

Type: DataFormat

Format of this table's data files.

database🔹

Type: IDatabase

Database this table belongs to.

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node🔹

Type: Node

The tree node.

parameters🔹

Type: { [string]: string }

The tables' properties associated with the table.

stack🔹

Type: Stack

The stack in which this resource is defined.

tableArn🔹

Type: string

tableName🔹

Type: string

tableResource🔹

Type: CfnTable

partitionIndexes?🔹

Type: PartitionIndex[] (optional)

partitionKeys?🔹

Type: Column[] (optional)

This table's partition keys if the table is partitioned.

storageParameters?🔹

Type: StorageParameter[] (optional)

The tables' storage descriptor properties.

Methods

Name	Description
addPartitionIndex(index)🔹	Add a partition index to the table.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, actions)🔹	Grant the given identity custom permissions.
grantRead(grantee)🔹
grantReadWrite(grantee)🔹
grantToUnderlyingResources(grantee, actions)🔹	Grant the given identity custom permissions to ALL underlying resources of the table.
grantWrite(grantee)🔹
toString()🔹	Returns a string representation of this construct.
static fromTableArn(scope, id, tableArn)🔹
static fromTableAttributes(scope, id, attrs)🔹	Creates a Table construct that represents an external table.

addPartitionIndex(index)🔹

public addPartitionIndex(index: PartitionIndex): void

Parameters

index PartitionIndex

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.

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

grant(grantee, actions)🔹

public grant(grantee: IGrantable, actions: string[]): Grant

Parameters

grantee IGrantable
actions string[]

Returns

Grant

Grant the given identity custom permissions.

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

grantee IGrantable

Returns

Grant

grantReadWrite(grantee)🔹

public grantReadWrite(grantee: IGrantable): Grant

Parameters

grantee IGrantable

Returns

Grant

grantToUnderlyingResources(grantee, actions)🔹

public grantToUnderlyingResources(grantee: IGrantable, actions: string[]): Grant

Parameters

grantee IGrantable
actions string[]

Returns

Grant

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.

grantWrite(grantee)🔹

public grantWrite(grantee: IGrantable): Grant

Parameters

grantee IGrantable

Returns

Grant

toString()🔹

public toString(): string

Returns

string

Returns a string representation of this construct.

static fromTableArn(scope, id, tableArn)🔹

public static fromTableArn(scope: Construct, id: string, tableArn: string): ITable

Parameters

scope Construct
id string
tableArn string

Returns

ITable

static fromTableAttributes(scope, id, attrs)🔹

public static fromTableAttributes(scope: Construct, id: string, attrs: TableAttributes): ITable

Parameters

scope Construct — The scope creating construct (usually this).
id string — The construct's id.
attrs TableAttributes — Import attributes.

Returns

ITable

Creates a Table construct that represents an external table.