software.amazon.awscdk.services.dynamodb

Interface ITable

All Superinterfaces:

IConstruct, IDependable, IResource

All Known Subinterfaces:

ITable.Jsii$Default

All Known Implementing Classes:

ITable.Jsii$Proxy, Table

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:40.729Z")
public interface ITable
extends IResource

An interface that represents a DynamoDB Table - either created with the CDK, or an existing one.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ITable.Jsii$Default Internal default implementation for ITable.
static class	ITable.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
default IKey	getEncryptionKey() Optional KMS encryption key associated with this table.
java.lang.String	getTableArn() Arn of the dynamodb table.
java.lang.String	getTableName() Table name of the dynamodb table.
default java.lang.String	getTableStreamArn() ARN of the table's stream, if there is one.
Grant	grant(IGrantable grantee, java.lang.String... actions) Adds an IAM policy statement associated with this table to an IAM principal's policy.
Grant	grantFullAccess(IGrantable grantee) Permits all DynamoDB operations ("dynamodb:*") to an IAM principal.
Grant	grantReadData(IGrantable grantee) Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan.
Grant	grantReadWriteData(IGrantable grantee) Permits an IAM principal to all data read/write operations to this table.
Grant	grantStream(IGrantable grantee, java.lang.String... actions) Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.
Grant	grantStreamRead(IGrantable grantee) Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.
Grant	grantTableListStreams(IGrantable grantee) Permits an IAM Principal to list streams attached to current dynamodb table.
Grant	grantWriteData(IGrantable grantee) Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem.
Metric	metric(java.lang.String metricName) Metric for the number of Errors executing all Lambdas.
Metric	metric(java.lang.String metricName, MetricOptions props) Metric for the number of Errors executing all Lambdas.
Metric	metricConditionalCheckFailedRequests() Metric for the conditional check failed requests.
Metric	metricConditionalCheckFailedRequests(MetricOptions props) Metric for the conditional check failed requests.
Metric	metricConsumedReadCapacityUnits() Metric for the consumed read capacity units.
Metric	metricConsumedReadCapacityUnits(MetricOptions props) Metric for the consumed read capacity units.
Metric	metricConsumedWriteCapacityUnits() Metric for the consumed write capacity units.
Metric	metricConsumedWriteCapacityUnits(MetricOptions props) Metric for the consumed write capacity units.
Metric	metricSuccessfulRequestLatency() Metric for the successful request latency.
Metric	metricSuccessfulRequestLatency(MetricOptions props) Metric for the successful request latency.
Metric	metricSystemErrors() Deprecated. use `metricSystemErrorsForOperations`
Metric	metricSystemErrors(MetricOptions props) Deprecated. use `metricSystemErrorsForOperations`
IMetric	metricSystemErrorsForOperations() Metric for the system errors this table.
IMetric	metricSystemErrorsForOperations(SystemErrorsForOperationsMetricOptions props) Metric for the system errors this table.
Metric	metricThrottledRequests() Metric for throttled requests.
Metric	metricThrottledRequests(MetricOptions props) Metric for throttled requests.
Metric	metricUserErrors() Metric for the user errors.
Metric	metricUserErrors(MetricOptions props) Metric for the user errors.

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Method Detail

getTableArn

java.lang.String getTableArn()

Arn of the dynamodb table.

getTableName

java.lang.String getTableName()

Table name of the dynamodb table.

getEncryptionKey

default IKey getEncryptionKey()

Optional KMS encryption key associated with this table.

getTableStreamArn

default java.lang.String getTableStreamArn()

ARN of the table's stream, if there is one.

grant

Grant grant(IGrantable grantee,
            java.lang.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.

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

Grant grantFullAccess(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.

Parameters:

grantee - The principal to grant access to. This parameter is required.

grantReadData

Grant grantReadData(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.

Parameters:

grantee - The principal to grant access to. This parameter is required.

grantReadWriteData

Grant grantReadWriteData(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.

Parameters:

grantee - The principal to grant access to. This parameter is required.

grantStream

Grant grantStream(IGrantable grantee,
                  java.lang.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.

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

Grant grantStreamRead(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.

Parameters:

grantee - The principal to grant access to. This parameter is required.

grantTableListStreams

Grant grantTableListStreams(IGrantable grantee)

Permits an IAM Principal to list streams attached to current dynamodb table.

Parameters:

grantee - The principal (no-op if undefined). This parameter is required.

grantWriteData

Grant grantWriteData(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.

Parameters:

grantee - The principal to grant access to. This parameter is required.

metric

Metric metric(java.lang.String metricName,
              MetricOptions props)

Metric for the number of Errors executing all Lambdas.

Parameters:

metricName - This parameter is required.

props -

metric

Metric metric(java.lang.String metricName)

Metric for the number of Errors executing all Lambdas.

Parameters:

metricName - This parameter is required.

metricConditionalCheckFailedRequests

Metric metricConditionalCheckFailedRequests(MetricOptions props)

Metric for the conditional check failed requests.

Parameters:

props - properties of a metric.

metricConditionalCheckFailedRequests

Metric metricConditionalCheckFailedRequests()

Metric for the conditional check failed requests.

metricConsumedReadCapacityUnits

Metric metricConsumedReadCapacityUnits(MetricOptions props)

Metric for the consumed read capacity units.

Parameters:

props - properties of a metric.

metricConsumedReadCapacityUnits

Metric metricConsumedReadCapacityUnits()

Metric for the consumed read capacity units.

metricConsumedWriteCapacityUnits

Metric metricConsumedWriteCapacityUnits(MetricOptions props)

Metric for the consumed write capacity units.

Parameters:

props - properties of a metric.

metricConsumedWriteCapacityUnits

Metric metricConsumedWriteCapacityUnits()

Metric for the consumed write capacity units.

metricSuccessfulRequestLatency

Metric metricSuccessfulRequestLatency(MetricOptions props)

Metric for the successful request latency.

Parameters:

props - properties of a metric.

metricSuccessfulRequestLatency

Metric metricSuccessfulRequestLatency()

Metric for the successful request latency.

metricSystemErrors

@Deprecated
Metric metricSystemErrors(MetricOptions props)

Deprecated. use `metricSystemErrorsForOperations`

(deprecated) Metric for the system errors.

Parameters:

props - properties of a metric.

metricSystemErrors

@Deprecated
Metric metricSystemErrors()

Deprecated. use `metricSystemErrorsForOperations`

(deprecated) Metric for the system errors.

metricSystemErrorsForOperations

IMetric metricSystemErrorsForOperations(SystemErrorsForOperationsMetricOptions props)

Metric for the system errors this table.

Parameters:

props - properties of a metric.

metricSystemErrorsForOperations

IMetric metricSystemErrorsForOperations()

Metric for the system errors this table.

metricThrottledRequests

Metric metricThrottledRequests(MetricOptions props)

Metric for throttled requests.

Parameters:

props - properties of a metric.

metricThrottledRequests

Metric metricThrottledRequests()

Metric for throttled requests.

metricUserErrors

Metric metricUserErrors(MetricOptions props)

Metric for the user errors.

Parameters:

props - properties of a metric.

metricUserErrors

Metric metricUserErrors()

Metric for the user errors.