software.amazon.awscdk.services.dynamodb

Class Table

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.dynamodb.Table

All Implemented Interfaces:

IResource, ITable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.474Z")
 @Stability(value=Experimental)
public class Table
extends Resource
implements ITable

(experimental) Provides a DynamoDB table.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Table.Builder (experimental) A fluent builder for Table.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

ITable.Jsii$Default, ITable.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Table(software.constructs.Construct scope, String id, TableProps props)
protected	Table(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Table(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addGlobalSecondaryIndex(GlobalSecondaryIndexProps props) (experimental) Add a global secondary index of table.
void	addLocalSecondaryIndex(LocalSecondaryIndexProps props) (experimental) Add a local secondary index of table.
IScalableTableAttribute	autoScaleGlobalSecondaryIndexReadCapacity(String indexName, EnableScalingProps props) (experimental) Enable read capacity scaling for the given GSI.
IScalableTableAttribute	autoScaleGlobalSecondaryIndexWriteCapacity(String indexName, EnableScalingProps props) (experimental) Enable write capacity scaling for the given GSI.
IScalableTableAttribute	autoScaleReadCapacity(EnableScalingProps props) (experimental) Enable read capacity scaling for this table.
IScalableTableAttribute	autoScaleWriteCapacity(EnableScalingProps props) (experimental) Enable write capacity scaling for this table.
static ITable	fromTableArn(software.constructs.Construct scope, String id, String tableArn) (experimental) Creates a Table construct that represents an external table via table arn.
static ITable	fromTableAttributes(software.constructs.Construct scope, String id, TableAttributes attrs) (experimental) Creates a Table construct that represents an external table.
static ITable	fromTableName(software.constructs.Construct scope, String id, String tableName) (experimental) Creates a Table construct that represents an external table via table name.
IKey	getEncryptionKey() (experimental) KMS encryption key, if this table uses a customer-managed encryption key.
protected Boolean	getHasIndex() (experimental) Whether this table has indexes.
protected List<String>	getRegionalArns()
String	getTableArn() (experimental) Arn of the dynamodb table.
String	getTableName() (experimental) Table name of the dynamodb table.
String	getTableStreamArn() (experimental) ARN of the table's stream, if there is one.
Grant	grant(IGrantable grantee, String... actions) (experimental) Adds an IAM policy statement associated with this table to an IAM principal's policy.
Grant	grantFullAccess(IGrantable grantee) (experimental) Permits all DynamoDB operations ("dynamodb:*") to an IAM principal.
Grant	grantReadData(IGrantable grantee) (experimental) Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan.
Grant	grantReadWriteData(IGrantable grantee) (experimental) Permits an IAM principal to all data read/write operations to this table.
Grant	grantStream(IGrantable grantee, String... actions) (experimental) Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.
Grant	grantStreamRead(IGrantable grantee) (experimental) Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.
Grant	grantTableListStreams(IGrantable grantee) (experimental) Permits an IAM Principal to list streams attached to current dynamodb table.
Grant	grantWriteData(IGrantable grantee) (experimental) Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem.
Metric	metric(String metricName) (experimental) Return the given named metric for this Table.
Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this Table.
Metric	metricConditionalCheckFailedRequests() (experimental) Metric for the conditional check failed requests this table.
Metric	metricConditionalCheckFailedRequests(MetricOptions props) (experimental) Metric for the conditional check failed requests this table.
Metric	metricConsumedReadCapacityUnits() (experimental) Metric for the consumed read capacity units this table.
Metric	metricConsumedReadCapacityUnits(MetricOptions props) (experimental) Metric for the consumed read capacity units this table.
Metric	metricConsumedWriteCapacityUnits() (experimental) Metric for the consumed write capacity units this table.
Metric	metricConsumedWriteCapacityUnits(MetricOptions props) (experimental) Metric for the consumed write capacity units this table.
Metric	metricSuccessfulRequestLatency() (experimental) Metric for the successful request latency this table.
Metric	metricSuccessfulRequestLatency(MetricOptions props) (experimental) Metric for the successful request latency this table.
IMetric	metricSystemErrorsForOperations() (experimental) Metric for the system errors this table.
IMetric	metricSystemErrorsForOperations(SystemErrorsForOperationsMetricOptions props) (experimental) Metric for the system errors this table.
Metric	metricThrottledRequests() (experimental) How many requests are throttled on this table.
Metric	metricThrottledRequests(MetricOptions props) (experimental) How many requests are throttled on this table.
Metric	metricUserErrors() (experimental) Metric for the user errors.
Metric	metricUserErrors(MetricOptions props) (experimental) Metric for the user errors.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Table

protected Table(software.amazon.jsii.JsiiObjectRef objRef)

Table

protected Table(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Table

@Stability(value=Experimental)
public Table(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            TableProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromTableArn

@Stability(value=Experimental)
 @NotNull
public static ITable fromTableArn(@NotNull
                                                                           software.constructs.Construct scope,
                                                                           @NotNull
                                                                           String id,
                                                                           @NotNull
                                                                           String tableArn)

(experimental) Creates a Table construct that represents an external table via table arn.

Parameters:

scope - The parent creating construct (usually `this`). This parameter is required.

id - The construct's name. This parameter is required.

tableArn - The table's ARN. This parameter is required.

fromTableAttributes

@Stability(value=Experimental)
 @NotNull
public static ITable fromTableAttributes(@NotNull
                                                                                  software.constructs.Construct scope,
                                                                                  @NotNull
                                                                                  String id,
                                                                                  @NotNull
                                                                                  TableAttributes attrs)

(experimental) Creates a Table construct that represents an external table.

Parameters:

scope - The parent creating construct (usually `this`). This parameter is required.

id - The construct's name. This parameter is required.

attrs - A `TableAttributes` object. This parameter is required.

fromTableName

@Stability(value=Experimental)
 @NotNull
public static ITable fromTableName(@NotNull
                                                                            software.constructs.Construct scope,
                                                                            @NotNull
                                                                            String id,
                                                                            @NotNull
                                                                            String tableName)

(experimental) Creates a Table construct that represents an external table via table name.

Parameters:

scope - The parent creating construct (usually `this`). This parameter is required.

id - The construct's name. This parameter is required.

tableName - The table's name. This parameter is required.

addGlobalSecondaryIndex

@Stability(value=Experimental)
public void addGlobalSecondaryIndex(@NotNull
                                                                   GlobalSecondaryIndexProps props)

(experimental) Add a global secondary index of table.

Parameters:

props - the property of global secondary index. This parameter is required.

addLocalSecondaryIndex

@Stability(value=Experimental)
public void addLocalSecondaryIndex(@NotNull
                                                                  LocalSecondaryIndexProps props)

(experimental) Add a local secondary index of table.

Parameters:

props - the property of local secondary index. This parameter is required.

autoScaleGlobalSecondaryIndexReadCapacity

@Stability(value=Experimental)
 @NotNull
public IScalableTableAttribute autoScaleGlobalSecondaryIndexReadCapacity(@NotNull
                                                                                                                  String indexName,
                                                                                                                  @NotNull
                                                                                                                  EnableScalingProps props)

(experimental) Enable read capacity scaling for the given GSI.

Parameters:

indexName - This parameter is required.

props - This parameter is required.

Returns:

An object to configure additional AutoScaling settings for this attribute

autoScaleGlobalSecondaryIndexWriteCapacity

@Stability(value=Experimental)
 @NotNull
public IScalableTableAttribute autoScaleGlobalSecondaryIndexWriteCapacity(@NotNull
                                                                                                                   String indexName,
                                                                                                                   @NotNull
                                                                                                                   EnableScalingProps props)

(experimental) Enable write capacity scaling for the given GSI.

Parameters:

indexName - This parameter is required.

props - This parameter is required.

Returns:

An object to configure additional AutoScaling settings for this attribute

autoScaleReadCapacity

@Stability(value=Experimental)
 @NotNull
public IScalableTableAttribute autoScaleReadCapacity(@NotNull
                                                                                              EnableScalingProps props)

(experimental) Enable read capacity scaling for this table.

Parameters:

props - This parameter is required.

Returns:

An object to configure additional AutoScaling settings

autoScaleWriteCapacity

@Stability(value=Experimental)
 @NotNull
public IScalableTableAttribute autoScaleWriteCapacity(@NotNull
                                                                                               EnableScalingProps props)

(experimental) Enable write capacity scaling for this table.

Parameters:

props - This parameter is required.

Returns:

An object to configure additional AutoScaling settings for this attribute

grant

@Stability(value=Experimental)
 @NotNull
public Grant grant(@NotNull
                                                            IGrantable grantee,
                                                            @NotNull
                                                            String... actions)

(experimental) 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(value=Experimental)
 @NotNull
public Grant grantFullAccess(@NotNull
                                                                      IGrantable grantee)

(experimental) 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(value=Experimental)
 @NotNull
public Grant grantReadData(@NotNull
                                                                    IGrantable grantee)

(experimental) 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(value=Experimental)
 @NotNull
public Grant grantReadWriteData(@NotNull
                                                                         IGrantable grantee)

(experimental) 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(value=Experimental)
 @NotNull
public Grant grantStream(@NotNull
                                                                  IGrantable grantee,
                                                                  @NotNull
                                                                  String... actions)

(experimental) 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(value=Experimental)
 @NotNull
public Grant grantStreamRead(@NotNull
                                                                      IGrantable grantee)

(experimental) 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(value=Experimental)
 @NotNull
public Grant grantTableListStreams(@NotNull
                                                                            IGrantable grantee)

(experimental) 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(value=Experimental)
 @NotNull
public Grant grantWriteData(@NotNull
                                                                     IGrantable grantee)

(experimental) 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(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName,
                                                              @Nullable
                                                              MetricOptions props)

(experimental) Return the given named metric for this Table.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metric in interface ITable

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName)

(experimental) Return the given named metric for this Table.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metric in interface ITable

Parameters:

metricName - This parameter is required.

metricConditionalCheckFailedRequests

@Stability(value=Experimental)
 @NotNull
public Metric metricConditionalCheckFailedRequests(@Nullable
                                                                                            MetricOptions props)

(experimental) Metric for the conditional check failed requests this table.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricConditionalCheckFailedRequests in interface ITable

Parameters:

props -

metricConditionalCheckFailedRequests

@Stability(value=Experimental)
 @NotNull
public Metric metricConditionalCheckFailedRequests()

(experimental) Metric for the conditional check failed requests this table.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricConditionalCheckFailedRequests in interface ITable

metricConsumedReadCapacityUnits

@Stability(value=Experimental)
 @NotNull
public Metric metricConsumedReadCapacityUnits(@Nullable
                                                                                       MetricOptions props)

(experimental) Metric for the consumed read capacity units this table.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricConsumedReadCapacityUnits in interface ITable

Parameters:

props -

metricConsumedReadCapacityUnits

@Stability(value=Experimental)
 @NotNull
public Metric metricConsumedReadCapacityUnits()

(experimental) Metric for the consumed read capacity units this table.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricConsumedReadCapacityUnits in interface ITable

metricConsumedWriteCapacityUnits

@Stability(value=Experimental)
 @NotNull
public Metric metricConsumedWriteCapacityUnits(@Nullable
                                                                                        MetricOptions props)

(experimental) Metric for the consumed write capacity units this table.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricConsumedWriteCapacityUnits in interface ITable

Parameters:

props -

metricConsumedWriteCapacityUnits

@Stability(value=Experimental)
 @NotNull
public Metric metricConsumedWriteCapacityUnits()

(experimental) Metric for the consumed write capacity units this table.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricConsumedWriteCapacityUnits in interface ITable

metricSuccessfulRequestLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricSuccessfulRequestLatency(@Nullable
                                                                                      MetricOptions props)

(experimental) Metric for the successful request latency this table.

By default, the metric will be calculated as an average over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricSuccessfulRequestLatency in interface ITable

Parameters:

props -

metricSuccessfulRequestLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricSuccessfulRequestLatency()

(experimental) Metric for the successful request latency this table.

By default, the metric will be calculated as an average over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricSuccessfulRequestLatency in interface ITable

metricSystemErrorsForOperations

@Stability(value=Experimental)
 @NotNull
public IMetric metricSystemErrorsForOperations(@Nullable
                                                                                        SystemErrorsForOperationsMetricOptions props)

(experimental) Metric for the system errors this table.

This will sum errors across all possible operations. Note that by default, each individual metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricSystemErrorsForOperations in interface ITable

Parameters:

props -

metricSystemErrorsForOperations

@Stability(value=Experimental)
 @NotNull
public IMetric metricSystemErrorsForOperations()

(experimental) Metric for the system errors this table.

This will sum errors across all possible operations. Note that by default, each individual metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricSystemErrorsForOperations in interface ITable

metricThrottledRequests

@Stability(value=Experimental)
 @NotNull
public Metric metricThrottledRequests(@Nullable
                                                                               MetricOptions props)

(experimental) How many requests are throttled on this table.

Default: sum over 5 minutes

Specified by:

metricThrottledRequests in interface ITable

Parameters:

props -

metricThrottledRequests

@Stability(value=Experimental)
 @NotNull
public Metric metricThrottledRequests()

(experimental) How many requests are throttled on this table.

Default: sum over 5 minutes

Specified by:

metricThrottledRequests in interface ITable

metricUserErrors

@Stability(value=Experimental)
 @NotNull
public Metric metricUserErrors(@Nullable
                                                                        MetricOptions props)

(experimental) Metric for the user errors.

Note that this metric reports user errors across all the tables in the account and region the table resides in.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricUserErrors in interface ITable

Parameters:

props -

metricUserErrors

@Stability(value=Experimental)
 @NotNull
public Metric metricUserErrors()

(experimental) Metric for the user errors.

Note that this metric reports user errors across all the tables in the account and region the table resides in.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Specified by:

metricUserErrors in interface ITable

getHasIndex

@Stability(value=Experimental)
 @NotNull
protected Boolean getHasIndex()

(experimental) Whether this table has indexes.

getRegionalArns

@Stability(value=Experimental)
 @NotNull
protected List<String> getRegionalArns()

getTableArn

@Stability(value=Experimental)
 @NotNull
public String getTableArn()

(experimental) Arn of the dynamodb table.

Specified by:

getTableArn in interface ITable

getTableName

@Stability(value=Experimental)
 @NotNull
public String getTableName()

(experimental) Table name of the dynamodb table.

Specified by:

getTableName in interface ITable

getEncryptionKey

@Stability(value=Experimental)
 @Nullable
public IKey getEncryptionKey()

(experimental) KMS encryption key, if this table uses a customer-managed encryption key.

Specified by:

getEncryptionKey in interface ITable

getTableStreamArn

@Stability(value=Experimental)
 @Nullable
public String getTableStreamArn()

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

Specified by:

getTableStreamArn in interface ITable