Package software.amazon.awscdk.services.dynamodb

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

  • Method Details

    • getTableArn

      @Stability(Stable) @NotNull default String getTableArn()
      Arn of the dynamodb table.
      Specified by:
      getTableArn in interface ITable

    • getTableName

      @Stability(Stable) @NotNull default String getTableName()
      Table name of the dynamodb table.
      Specified by:
      getTableName in interface ITable

    • getEncryptionKey

      @Stability(Stable) @Nullable default IKey getEncryptionKey()
      Optional KMS encryption key associated with this table.
      Specified by:
      getEncryptionKey in interface ITable

    • getTableStreamArn

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

    • grant

      @Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @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
      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 default 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
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantReadData

      @Stability(Stable) @NotNull default 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
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantReadWriteData

      @Stability(Stable) @NotNull default 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
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantStream

      @Stability(Stable) @NotNull default Grant grantStream(@NotNull IGrantable grantee, @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
      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 default 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
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantTableListStreams

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

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

    • grantWriteData

      @Stability(Stable) @NotNull default 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
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • metric

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

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

    • metric

      @Stability(Stable) @NotNull default 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 default Metric metricConditionalCheckFailedRequests(@Nullable MetricOptions props)
      Metric for the conditional check failed requests.

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

    • metricConditionalCheckFailedRequests

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

    • metricConsumedReadCapacityUnits

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

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

    • metricConsumedReadCapacityUnits

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

    • metricConsumedWriteCapacityUnits

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

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

    • metricConsumedWriteCapacityUnits

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

    • metricSuccessfulRequestLatency

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

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

    • metricSuccessfulRequestLatency

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

    • metricSystemErrorsForOperations

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

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

    • metricSystemErrorsForOperations

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

    • metricThrottledRequests

      @Stability(Deprecated) @Deprecated @NotNull default Metric metricThrottledRequests(@Nullable MetricOptions props)
      Deprecated.
      use metricThrottledRequestsForOperations
      (deprecated) Metric for throttled requests.

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

    • metricThrottledRequests

      @Stability(Deprecated) @Deprecated @NotNull default Metric metricThrottledRequests()
      Deprecated.
      use metricThrottledRequestsForOperations
      (deprecated) Metric for throttled requests.

      Specified by:
      metricThrottledRequests in interface ITable

    • metricThrottledRequestsForOperations

      @Stability(Stable) @NotNull default IMetric metricThrottledRequestsForOperations(@Nullable OperationsMetricOptions props)
      Metric for throttled requests.

      Specified by:
      metricThrottledRequestsForOperations in interface ITable
      Parameters:
      props - properties of a metric.

    • metricThrottledRequestsForOperations

      @Stability(Stable) @NotNull default IMetric metricThrottledRequestsForOperations()
      Metric for throttled requests.
      Specified by:
      metricThrottledRequestsForOperations in interface ITable

    • metricUserErrors

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

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

    • metricUserErrors

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