Package software.amazon.awscdk.services.s3tables.alpha

Interface ITable

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
ITable.Jsii$Default
All Known Implementing Classes:
ITable.Jsii$Proxy, Table
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-09-25T11:29:20.616Z") @Stability(Experimental) public interface ITable extends software.amazon.jsii.JsiiSerializable, IResource
(experimental) Represents an S3 Table.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ITable.Jsii$Default
    Internal default implementation for ITable.
    static final class 
    ITable.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    AddToResourcePolicyResult
    addToResourcePolicy(PolicyStatement statement)
    (experimental) Adds a statement to the resource policy for a principal (i.e.
    default String
    getAccount()
    (experimental) The accountId containing this table.
    default String
    getRegion()
    (experimental) The region containing this table.
    String
    getTableArn()
    (experimental) The ARN of this table.
    String
    getTableName()
    (experimental) The name of this table.
    Grant
    grantRead(IGrantable identity)
    (experimental) Grant read permissions for this table to an IAM principal (Role/Group/User).
    Grant
    grantReadWrite(IGrantable identity)
    (experimental) Grant read and write permissions for this table to an IAM principal (Role/Group/User).
    Grant
    grantWrite(IGrantable identity)
    (experimental) Grant write permissions for this table to an IAM principal (Role/Group/User).

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getEnv, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getTableArn

      @Stability(Experimental) @NotNull String getTableArn()
      (experimental) The ARN of this table.

    • getTableName

      @Stability(Experimental) @NotNull String getTableName()
      (experimental) The name of this table.

    • getAccount

      @Stability(Experimental) @Nullable default String getAccount()
      (experimental) The accountId containing this table.

    • getRegion

      @Stability(Experimental) @Nullable default String getRegion()
      (experimental) The region containing this table.

    • addToResourcePolicy

      @Stability(Experimental) @NotNull AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement 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 - the policy statement to be added to the table's policy. This parameter is required.
      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.

    • grantRead

      @Stability(Experimental) @NotNull Grant grantRead(@NotNull IGrantable 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 - The principal to allow read permissions to. This parameter is required.

    • grantReadWrite

      @Stability(Experimental) @NotNull Grant grantReadWrite(@NotNull IGrantable 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 - The principal to allow read and write permissions to. This parameter is required.

    • grantWrite

      @Stability(Experimental) @NotNull Grant grantWrite(@NotNull IGrantable 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 - The principal to allow write permissions to. This parameter is required.