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

  • Nested Class Summary

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IDependable

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default, IResource.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3tables.alpha.ITable

    ITable.Jsii$Default, ITable.Jsii$Proxy

  • Method Summary

    Modifier and Type
    Method
    Description
    default AddToResourcePolicyResult
    addToResourcePolicy(PolicyStatement statement)
    (experimental) Adds a statement to the resource policy for a principal (i.e.
    default void
    applyRemovalPolicy(RemovalPolicy policy)
    Apply the given removal policy to this resource.
    default String
    getAccount()
    (experimental) The accountId containing this table.
    default ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    default software.constructs.Node
    getNode()
    The tree node.
    default String
    getRegion()
    (experimental) The region containing this table.
    default Stack
    getStack()
    The stack in which this resource is defined.
    default String
    getTableArn()
    (experimental) The ARN of this table.
    default String
    getTableName()
    (experimental) The name of this table.
    default Grant
    grantRead(IGrantable identity)
    (experimental) Grant read permissions for this table to an IAM principal (Role/Group/User).
    default Grant
    grantReadWrite(IGrantable identity)
    (experimental) Grant read and write permissions for this table to an IAM principal (Role/Group/User).
    default Grant
    grantWrite(IGrantable identity)
    (experimental) Grant write permissions for this table to an IAM principal (Role/Group/User).

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      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.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • 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

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy 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).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

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