Package software.amazon.awscdk.services.dynamodb

Class ITable.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.dynamodb.ITable.Jsii$Proxy
All Implemented Interfaces:
IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, ITable, ITable.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default
Enclosing interface:
ITable
@Internal public static final class ITable.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ITable.Jsii$Default
A proxy class which represents a concrete javascript instance of this type.

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

  • Method Details

    • getNode

      @Stability(Stable) @NotNull public final ConstructNode getNode()
      The construct tree node for this construct.
      Specified by:
      getNode in interface IConstruct
      Specified by:
      getNode in interface IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default
      Specified by:
      getNode in interface ITable.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull public final 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
      Specified by:
      getEnv in interface ITable.Jsii$Default

    • getStack

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

    • getTableArn

      @Stability(Stable) @NotNull public final String getTableArn()
      Arn of the dynamodb table.
      Specified by:
      getTableArn in interface ITable
      Specified by:
      getTableArn in interface ITable.Jsii$Default

    • getTableName

      @Stability(Stable) @NotNull public final String getTableName()
      Table name of the dynamodb table.
      Specified by:
      getTableName in interface ITable
      Specified by:
      getTableName in interface ITable.Jsii$Default

    • getEncryptionKey

      @Stability(Stable) @Nullable public final IKey getEncryptionKey()
      Optional KMS encryption key associated with this table.
      Specified by:
      getEncryptionKey in interface ITable
      Specified by:
      getEncryptionKey in interface ITable.Jsii$Default

    • getTableStreamArn

      @Stability(Stable) @Nullable public final String getTableStreamArn()
      ARN of the table's stream, if there is one.
      Specified by:
      getTableStreamArn in interface ITable
      Specified by:
      getTableStreamArn in interface ITable.Jsii$Default

    • applyRemovalPolicy

      @Stability(Stable) public final 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
      Specified by:
      applyRemovalPolicy in interface ITable.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • grant

      @Stability(Stable) @NotNull public final Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions)
      Adds an IAM policy statement associated with this table to an IAM principal's policy.

      If encryptionKey is present, appropriate grants to the key needs to be added separately using the table.encryptionKey.grant* methods.

      Specified by:
      grant in interface ITable
      Specified by:
      grant in interface ITable.Jsii$Default
      Parameters:
      grantee - The principal (no-op if undefined). This parameter is required.
      actions - The set of actions to allow (i.e. "dynamodb:PutItem", "dynamodb:GetItem", ...). This parameter is required.

    • grantFullAccess

      @Stability(Stable) @NotNull public final Grant grantFullAccess(@NotNull IGrantable grantee)
      Permits all DynamoDB operations ("dynamodb:*") to an IAM principal.

      Appropriate grants will also be added to the customer-managed KMS key if one was configured.

      Specified by:
      grantFullAccess in interface ITable
      Specified by:
      grantFullAccess in interface ITable.Jsii$Default
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantReadData

      @Stability(Stable) @NotNull public final Grant grantReadData(@NotNull IGrantable grantee)
      Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan.

      Appropriate grants will also be added to the customer-managed KMS key if one was configured.

      Specified by:
      grantReadData in interface ITable
      Specified by:
      grantReadData in interface ITable.Jsii$Default
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantReadWriteData

      @Stability(Stable) @NotNull public final Grant grantReadWriteData(@NotNull IGrantable grantee)
      Permits an IAM principal to all data read/write operations to this table.

      BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, BatchWriteItem, PutItem, UpdateItem, DeleteItem

      Appropriate grants will also be added to the customer-managed KMS key if one was configured.

      Specified by:
      grantReadWriteData in interface ITable
      Specified by:
      grantReadWriteData in interface ITable.Jsii$Default
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantStream

      @Stability(Stable) @NotNull public final Grant grantStream(@NotNull IGrantable grantee, @NotNull @NotNull String... actions)
      Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.

      If encryptionKey is present, appropriate grants to the key needs to be added separately using the table.encryptionKey.grant* methods.

      Specified by:
      grantStream in interface ITable
      Specified by:
      grantStream in interface ITable.Jsii$Default
      Parameters:
      grantee - The principal (no-op if undefined). This parameter is required.
      actions - The set of actions to allow (i.e. "dynamodb:DescribeStream", "dynamodb:GetRecords", ...). This parameter is required.

    • grantStreamRead

      @Stability(Stable) @NotNull public final Grant grantStreamRead(@NotNull IGrantable grantee)
      Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.

      Appropriate grants will also be added to the customer-managed KMS key if one was configured.

      Specified by:
      grantStreamRead in interface ITable
      Specified by:
      grantStreamRead in interface ITable.Jsii$Default
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantTableListStreams

      @Stability(Stable) @NotNull public final Grant grantTableListStreams(@NotNull IGrantable grantee)
      Permits an IAM Principal to list streams attached to current dynamodb table.

      Specified by:
      grantTableListStreams in interface ITable
      Specified by:
      grantTableListStreams in interface ITable.Jsii$Default
      Parameters:
      grantee - The principal (no-op if undefined). This parameter is required.

    • grantWriteData

      @Stability(Stable) @NotNull public final Grant grantWriteData(@NotNull IGrantable grantee)
      Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem.

      Appropriate grants will also be added to the customer-managed KMS key if one was configured.

      Specified by:
      grantWriteData in interface ITable
      Specified by:
      grantWriteData in interface ITable.Jsii$Default
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • metric

      @Stability(Stable) @NotNull public final Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Metric for the number of Errors executing all Lambdas.

      Specified by:
      metric in interface ITable
      Specified by:
      metric in interface ITable.Jsii$Default
      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Stable) @NotNull public final Metric metric(@NotNull String metricName)
      Metric for the number of Errors executing all Lambdas.

      Specified by:
      metric in interface ITable
      Parameters:
      metricName - This parameter is required.

    • metricConditionalCheckFailedRequests

      @Stability(Stable) @NotNull public final Metric metricConditionalCheckFailedRequests(@Nullable MetricOptions props)
      Metric for the conditional check failed requests.

      Specified by:
      metricConditionalCheckFailedRequests in interface ITable
      Specified by:
      metricConditionalCheckFailedRequests in interface ITable.Jsii$Default
      Parameters:
      props - properties of a metric.

    • metricConditionalCheckFailedRequests

      @Stability(Stable) @NotNull public final Metric metricConditionalCheckFailedRequests()
      Metric for the conditional check failed requests.
      Specified by:
      metricConditionalCheckFailedRequests in interface ITable

    • metricConsumedReadCapacityUnits

      @Stability(Stable) @NotNull public final Metric metricConsumedReadCapacityUnits(@Nullable MetricOptions props)
      Metric for the consumed read capacity units.

      Specified by:
      metricConsumedReadCapacityUnits in interface ITable
      Specified by:
      metricConsumedReadCapacityUnits in interface ITable.Jsii$Default
      Parameters:
      props - properties of a metric.

    • metricConsumedReadCapacityUnits

      @Stability(Stable) @NotNull public final Metric metricConsumedReadCapacityUnits()
      Metric for the consumed read capacity units.
      Specified by:
      metricConsumedReadCapacityUnits in interface ITable

    • metricConsumedWriteCapacityUnits

      @Stability(Stable) @NotNull public final Metric metricConsumedWriteCapacityUnits(@Nullable MetricOptions props)
      Metric for the consumed write capacity units.

      Specified by:
      metricConsumedWriteCapacityUnits in interface ITable
      Specified by:
      metricConsumedWriteCapacityUnits in interface ITable.Jsii$Default
      Parameters:
      props - properties of a metric.

    • metricConsumedWriteCapacityUnits

      @Stability(Stable) @NotNull public final Metric metricConsumedWriteCapacityUnits()
      Metric for the consumed write capacity units.
      Specified by:
      metricConsumedWriteCapacityUnits in interface ITable

    • metricSuccessfulRequestLatency

      @Stability(Stable) @NotNull public final Metric metricSuccessfulRequestLatency(@Nullable MetricOptions props)
      Metric for the successful request latency.

      Specified by:
      metricSuccessfulRequestLatency in interface ITable
      Specified by:
      metricSuccessfulRequestLatency in interface ITable.Jsii$Default
      Parameters:
      props - properties of a metric.

    • metricSuccessfulRequestLatency

      @Stability(Stable) @NotNull public final Metric metricSuccessfulRequestLatency()
      Metric for the successful request latency.
      Specified by:
      metricSuccessfulRequestLatency in interface ITable

    • metricSystemErrors

      @Stability(Deprecated) @Deprecated @NotNull public final Metric metricSystemErrors(@Nullable MetricOptions props)
      Deprecated.
      use metricSystemErrorsForOperations
      (deprecated) Metric for the system errors.

      Specified by:
      metricSystemErrors in interface ITable
      Specified by:
      metricSystemErrors in interface ITable.Jsii$Default
      Parameters:
      props - properties of a metric.

    • metricSystemErrors

      @Stability(Deprecated) @Deprecated @NotNull public final Metric metricSystemErrors()
      Deprecated.
      use metricSystemErrorsForOperations
      (deprecated) Metric for the system errors.

      Specified by:
      metricSystemErrors in interface ITable

    • metricSystemErrorsForOperations

      @Stability(Stable) @NotNull public final IMetric metricSystemErrorsForOperations(@Nullable SystemErrorsForOperationsMetricOptions props)
      Metric for the system errors this table.

      Specified by:
      metricSystemErrorsForOperations in interface ITable
      Specified by:
      metricSystemErrorsForOperations in interface ITable.Jsii$Default
      Parameters:
      props - properties of a metric.

    • metricSystemErrorsForOperations

      @Stability(Stable) @NotNull public final IMetric metricSystemErrorsForOperations()
      Metric for the system errors this table.
      Specified by:
      metricSystemErrorsForOperations in interface ITable

    • metricThrottledRequests

      @Stability(Stable) @NotNull public final Metric metricThrottledRequests(@Nullable MetricOptions props)
      Metric for throttled requests.

      Specified by:
      metricThrottledRequests in interface ITable
      Specified by:
      metricThrottledRequests in interface ITable.Jsii$Default
      Parameters:
      props - properties of a metric.

    • metricThrottledRequests

      @Stability(Stable) @NotNull public final Metric metricThrottledRequests()
      Metric for throttled requests.
      Specified by:
      metricThrottledRequests in interface ITable

    • metricUserErrors

      @Stability(Stable) @NotNull public final Metric metricUserErrors(@Nullable MetricOptions props)
      Metric for the user errors.

      Specified by:
      metricUserErrors in interface ITable
      Specified by:
      metricUserErrors in interface ITable.Jsii$Default
      Parameters:
      props - properties of a metric.

    • metricUserErrors

      @Stability(Stable) @NotNull public final Metric metricUserErrors()
      Metric for the user errors.
      Specified by:
      metricUserErrors in interface ITable