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

Interface ITableBucket.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, ITableBucket, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ITableBucket.Jsii$Proxy
Enclosing interface:
ITableBucket
@Internal public static interface ITableBucket.Jsii$Default extends ITableBucket, IResource.Jsii$Default
Internal default implementation for ITableBucket.

  • Method Details

    • getTableBucketArn

      @Stability(Experimental) @NotNull default String getTableBucketArn()
      (experimental) The ARN of the table bucket.
      Specified by:
      getTableBucketArn in interface ITableBucket

    • getTableBucketName

      @Stability(Experimental) @NotNull default String getTableBucketName()
      (experimental) The name of the table bucket.
      Specified by:
      getTableBucketName in interface ITableBucket

    • getAccount

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

    • getEncryptionKey

      @Stability(Experimental) @Nullable default IKey getEncryptionKey()
      (experimental) Optional KMS encryption key associated with this table bucket.
      Specified by:
      getEncryptionKey in interface ITableBucket

    • getRegion

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

    • 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 bucket and/or its tables.

      Note that the policy statement may or may not be added to the policy. For example, when an ITableBucket is created from an existing table bucket, it's not possible to tell whether the bucket 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 ITableBucket
      Parameters:
      statement - the policy statement to be added to the bucket'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, @NotNull String tableId)
      (experimental) Grant read permissions for this table bucket and its tables to an IAM principal (Role/Group/User).

      If encryption is used, permission to use the key to decrypt the contents of the bucket will also be granted to the same principal.

      Specified by:
      grantRead in interface ITableBucket
      Parameters:
      identity - The principal to allow read permissions to. This parameter is required.
      tableId - Allow the permissions to all tables using '*' or to single table by its unique ID. This parameter is required.

    • grantReadWrite

      @Stability(Experimental) @NotNull default Grant grantReadWrite(@NotNull IGrantable identity, @NotNull String tableId)
      (experimental) Grant read and write permissions for this table bucket and its tables to an IAM principal (Role/Group/User).

      If encryption is used, permission to use the key to encrypt/decrypt the contents of the bucket will also be granted to the same principal.

      Specified by:
      grantReadWrite in interface ITableBucket
      Parameters:
      identity - The principal to allow read and write permissions to. This parameter is required.
      tableId - Allow the permissions to all tables using '*' or to single table by its unique ID. This parameter is required.

    • grantWrite

      @Stability(Experimental) @NotNull default Grant grantWrite(@NotNull IGrantable identity, @NotNull String tableId)
      (experimental) Grant write permissions for this table bucket and its tables to an IAM principal (Role/Group/User).

      If encryption is used, permission to use the key to encrypt the contents of the bucket will also be granted to the same principal.

      Specified by:
      grantWrite in interface ITableBucket
      Parameters:
      identity - The principal to allow write permissions to. This parameter is required.
      tableId - Allow the permissions to all tables using '*' or to single table by its unique ID. This parameter is required.