class Table (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Redshift.Table
Java	software.amazon.awscdk.services.redshift.Table
Python	aws_cdk.aws_redshift.Table
TypeScript (source)	@aws-cdk/aws-redshift » Table

Implements IConstruct, IConstruct, IDependable, ITable

A table in a Redshift cluster.

Example

new Table(this, 'Table', {
  tableColumns: [
    { name: 'col1', dataType: 'varchar(4)', distKey: true },
    { name: 'col2', dataType: 'float' },
  ],
  cluster: cluster,
  databaseName: 'databaseName',
  distStyle: TableDistStyle.KEY,
});

Initializer

new Table(scope: Construct, id: string, props: TableProps)

Parameters

• scope Construct
• id string
• props TableProps

Construct Props

Name	Type	Description
cluster🔹	ICluster	The cluster containing the database.
databaseName🔹	string	The name of the database.
tableColumns🔹	Column[]	The columns of the table.
adminUser?🔹	ISecret	The secret containing credentials to a Redshift user with administrator privileges.
distStyle?🔹	TableDistStyle	The distribution style of the table.
removalPolicy?🔹	RemovalPolicy	The policy to apply when this resource is removed from the application.
sortStyle?🔹	TableSortStyle	The sort style of the table.
tableName?🔹	string	The name of the table.

---

cluster🔹

Type: ICluster

The cluster containing the database.

---

databaseName🔹

Type: string

The name of the database.

---

tableColumns🔹

Type: Column[]

The columns of the table.

---

adminUser?🔹

Type: ISecret (optional, default: the admin secret is taken from the cluster)

The secret containing credentials to a Redshift user with administrator privileges.

Secret JSON schema: { username: string; password: string }.

---

distStyle?🔹

Type: TableDistStyle (optional, default: TableDistStyle.AUTO)

The distribution style of the table.

---

removalPolicy?🔹

Type: RemovalPolicy (optional, default: cdk.RemovalPolicy.Retain)

The policy to apply when this resource is removed from the application.

---

sortStyle?🔹

Type: TableSortStyle (optional, default: TableSortStyle.AUTO if no sort key is specified, TableSortStyle.COMPOUND if a sort key is specified)

The sort style of the table.

---

tableName?🔹

Type: string (optional, default: a name is generated)

The name of the table.

Properties

Name	Type	Description
cluster🔹	ICluster	The cluster where the table is located.
databaseName🔹	string	The name of the database where the table is located.
node🔹	ConstructNode	The construct tree node associated with this construct.
tableColumns🔹	Column[]	The columns of the table.
tableName🔹	string	Name of the table.

---

cluster🔹

Type: ICluster

The cluster where the table is located.

---

databaseName🔹

Type: string

The name of the database where the table is located.

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

---

tableColumns🔹

Type: Column[]

The columns of the table.

---

tableName🔹

Type: string

Name of the table.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(user, ...actions)🔹	Grant a user privilege to access this table.
toString()🔹	Returns a string representation of this construct.
static fromTableAttributes(scope, id, attrs)🔹	Specify a Redshift table using a table name and schema that already exists.

---

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 destroyed (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

This resource is retained by default.

---

grant(user, ...actions)🔹

public grant(user: IUser, ...actions: TableAction[]): void

Parameters

• user IUser
• actions TableAction

Grant a user privilege to access this table.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromTableAttributes(scope, id, attrs)🔹

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

Parameters

• scope Construct
• id string
• attrs TableAttributes

Returns

• ITable

Specify a Redshift table using a table name and schema that already exists.