interface ITable 🔹

Language	Type name
.NET	Amazon.CDK.AWS.S3Tables.Alpha.ITable
Java	software.amazon.awscdk.services.s3tables.alpha.ITable
Python	aws_cdk.aws_s3tables_alpha.ITable
TypeScript (source)	@aws-cdk/aws-s3tables-alpha » ITable

Implemented by Table

Obtainable from Table.fromTableAttributes()

Represents an S3 Table.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
tableArn🔹	string	The ARN of this table.
tableName🔹	string	The name of this table.
account?🔹	string	The accountId containing this table.
region?🔹	string	The region containing this table.

---

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.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

tableArn🔹

Type: string

The ARN of this table.

---

tableName🔹

Type: string

The name of this table.

---

account?🔹

Type: string (optional)

The accountId containing this table.

---

region?🔹

Type: string (optional)

The region containing this table.

Methods

Name	Description
addToResourcePolicy(statement)🔹	Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this table.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grantRead(identity)🔹	Grant read permissions for this table to an IAM principal (Role/Group/User).
grantReadWrite(identity)🔹	Grant read and write permissions for this table to an IAM principal (Role/Group/User).
grantWrite(identity)🔹	Grant write permissions for this table to an IAM principal (Role/Group/User).

---

addToResourcePolicy(statement)🔹

public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult

Parameters

• statement PolicyStatement — the policy statement to be added to the table's policy.

Returns

• AddToResourcePolicyResult

Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this table.

Note that the policy statement may or may not be added to the policy. For example, when an ITable is created from an existing table, it's not possible to tell whether the table already has a policy attached, let alone to re-use that policy to add more statements to it. So it's safest to do nothing in these cases.

---

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).

---

grantRead(identity)🔹

public grantRead(identity: IGrantable): Grant

Parameters

• identity IGrantable — The principal to allow read permissions to.

Returns

• Grant

Grant read permissions for this table to an IAM principal (Role/Group/User).

If the parent TableBucket of this table has encryption, you should grant kms:Decrypt permission to use this key to the same principal.

---

grantReadWrite(identity)🔹

public grantReadWrite(identity: IGrantable): Grant

Parameters

• identity IGrantable — The principal to allow read and write permissions to.

Returns

• Grant

Grant read and write permissions for this table to an IAM principal (Role/Group/User).

If the parent TableBucket of this table has encryption, you should grant kms:GenerateDataKey and kms:Decrypt permission to use this key to the same principal.

---

grantWrite(identity)🔹

public grantWrite(identity: IGrantable): Grant

Parameters

• identity IGrantable — The principal to allow write permissions to.

Returns

• Grant

Grant write permissions for this table to an IAM principal (Role/Group/User).

If the parent TableBucket of this table has encryption, you should grant kms:GenerateDataKey and kms:Decrypt permission to use this key to the same principal.