ITable

class aws_cdk.aws_s3tables_alpha.ITable(*args, **kwargs)

Bases: IResource, Protocol

(experimental) Represents an S3 Table.

Stability:

experimental

Methods

add_to_resource_policy(statement)

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

Parameters:

statement (PolicyStatement) – the policy statement to be added to the table’s policy.

Return type:

AddToResourcePolicyResult

Returns:

metadata about the execution of this method. If the policy was not added, the value of statementAdded will be false. You should always check this value to make sure that the operation was actually carried out. Otherwise, synthesis and deploy will terminate silently, which may be confusing.

Stability:

experimental

apply_removal_policy(policy)

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

Parameters:

policy (RemovalPolicy)

Return type:

None

grant_read(identity)

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

Parameters:

identity (IGrantable) – The principal to allow read permissions to.

Stability:

experimental

Return type:

Grant

grant_read_write(identity)

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

Parameters:

identity (IGrantable) – The principal to allow read and write permissions to.

Stability:

experimental

Return type:

Grant

grant_write(identity)

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

Parameters:

identity (IGrantable) – The principal to allow write permissions to.

Stability:

experimental

Return type:

Grant

Attributes

account

(experimental) The accountId containing this table.

Stability:

experimental

Attribute:

true

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

node

The tree node.

region

(experimental) The region containing this table.

Stability:

experimental

Attribute:

true

stack

The stack in which this resource is defined.

table_arn

(experimental) The ARN of this table.

Stability:

experimental

Attribute:

true

table_name

(experimental) The name of this table.

Stability:

experimental

Attribute:

true