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

Interface ITable.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, ITable, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ITable.Jsii$Proxy
Enclosing interface:
ITable
@Internal public static interface ITable.Jsii$Default extends ITable, IResource.Jsii$Default
Internal default implementation for ITable.

  • Method Details

    • getTableArn

      @Stability(Experimental) @NotNull default String getTableArn()
      (experimental) The ARN of this table.
      Specified by:
      getTableArn in interface ITable

    • getTableName

      @Stability(Experimental) @NotNull default String getTableName()
      (experimental) The name of this table.
      Specified by:
      getTableName in interface ITable

    • getAccount

      @Stability(Experimental) @Nullable default String getAccount()
      (experimental) The accountId containing this table.
      Specified by:
      getAccount in interface ITable

    • getRegion

      @Stability(Experimental) @Nullable default String getRegion()
      (experimental) The region containing this table.
      Specified by:
      getRegion in interface ITable

    • addToResourcePolicy

      @Stability(Experimental) @NotNull default 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.

      Specified by:
      addToResourcePolicy in interface ITable
      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 default 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.

      Specified by:
      grantRead in interface ITable
      Parameters:
      identity - The principal to allow read permissions to. This parameter is required.

    • grantReadWrite

      @Stability(Experimental) @NotNull default 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.

      Specified by:
      grantReadWrite in interface ITable
      Parameters:
      identity - The principal to allow read and write permissions to. This parameter is required.

    • grantWrite

      @Stability(Experimental) @NotNull default 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.

      Specified by:
      grantWrite in interface ITable
      Parameters:
      identity - The principal to allow write permissions to. This parameter is required.