Table

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.Resource
    - - software.amazon.awscdk.services.dynamodb.Table

All Implemented Interfaces:: IConstruct, IDependable, IResource, ITable

@Generated(value="jsii-pacmak/1.31.0 (build 6fa403d)",
           date="2021-07-21T15:56:31.111Z")
public class Table
extends Resource
implements ITable

Provides a DynamoDB table.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Table.Builder
A fluent builder for Table.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dynamodb.ITable
  ITable.Jsii$Default, ITable.Jsii$Proxy

Nested Classes
Modifier and Type	Class and Description
`static class`	`Table.Builder` A fluent builder for `Table`.

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addGlobalSecondaryIndex(GlobalSecondaryIndexProps props)` Add a global secondary index of table.
`void`	`addLocalSecondaryIndex(LocalSecondaryIndexProps props)` Add a local secondary index of table.
`IScalableTableAttribute`	`autoScaleGlobalSecondaryIndexReadCapacity(java.lang.String indexName, EnableScalingProps props)` Enable read capacity scaling for the given GSI.
`IScalableTableAttribute`	`autoScaleGlobalSecondaryIndexWriteCapacity(java.lang.String indexName, EnableScalingProps props)` Enable write capacity scaling for the given GSI.
`IScalableTableAttribute`	`autoScaleReadCapacity(EnableScalingProps props)` Enable read capacity scaling for this table.
`IScalableTableAttribute`	`autoScaleWriteCapacity(EnableScalingProps props)` Enable write capacity scaling for this table.
`static ITable`	`fromTableArn(software.constructs.Construct scope, java.lang.String id, java.lang.String tableArn)` Creates a Table construct that represents an external table via table arn.
`static ITable`	`fromTableAttributes(software.constructs.Construct scope, java.lang.String id, TableAttributes attrs)` Creates a Table construct that represents an external table.
`static ITable`	`fromTableName(software.constructs.Construct scope, java.lang.String id, java.lang.String tableName)` Creates a Table construct that represents an external table via table name.
`IKey`	`getEncryptionKey()` KMS encryption key, if this table uses a customer-managed encryption key.
`protected java.lang.Boolean`	`getHasIndex()` Whether this table has indexes.
`protected java.util.List<java.lang.String>`	`getRegionalArns()`
`java.lang.String`	`getTableArn()` Arn of the dynamodb table.
`java.lang.String`	`getTableName()` Table name of the dynamodb table.
`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.
`static Grant`	`grantListStreams(IGrantable grantee)` Deprecated. Use `grantTableListStreams(software.amazon.awscdk.services.iam.IGrantable)` for more granular permission
`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)` Return the given named metric for this Table.
`Metric`	`metric(java.lang.String metricName, MetricOptions props)` Return the given named metric for this Table.
`Metric`	`metricConditionalCheckFailedRequests()` Metric for the conditional check failed requests this table.
`Metric`	`metricConditionalCheckFailedRequests(MetricOptions props)` Metric for the conditional check failed requests this table.
`Metric`	`metricConsumedReadCapacityUnits()` Metric for the consumed read capacity units this table.
`Metric`	`metricConsumedReadCapacityUnits(MetricOptions props)` Metric for the consumed read capacity units this table.
`Metric`	`metricConsumedWriteCapacityUnits()` Metric for the consumed write capacity units this table.
`Metric`	`metricConsumedWriteCapacityUnits(MetricOptions props)` Metric for the consumed write capacity units this table.
`Metric`	`metricSuccessfulRequestLatency()` Metric for the successful request latency this table.
`Metric`	`metricSuccessfulRequestLatency(MetricOptions props)` Metric for the successful request latency this table.
`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()` How many requests are throttled on this table.
`Metric`	`metricThrottledRequests(MetricOptions props)` How many requests are throttled on this table.
`Metric`	`metricUserErrors()` Metric for the user errors.
`Metric`	`metricUserErrors(MetricOptions props)` Metric for the user errors.
`SchemaOptions`	`schema()` Get schema attributes of table or index.
`SchemaOptions`	`schema(java.lang.String indexName)` Get schema attributes of table or index.
`protected java.util.List<java.lang.String>`	`validate()` Validate the table construct.

Methods inherited from class software.amazon.awscdk.core.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource
getEnv, getStack

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

- Constructor Detail
  - Table
```
protected Table(software.amazon.jsii.JsiiObjectRef objRef)
```
  - Table
```
protected Table(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - Table
```
public Table(software.constructs.Construct scope,
             java.lang.String id,
             TableProps props)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props - This parameter is required.
- Method Detail
  - fromTableArn
```
public static ITable fromTableArn(software.constructs.Construct scope,
                                  java.lang.String id,
                                  java.lang.String tableArn)
```
    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
```
public static ITable fromTableAttributes(software.constructs.Construct scope,
                                         java.lang.String id,
                                         TableAttributes attrs)
```
    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
```
public static ITable fromTableName(software.constructs.Construct scope,
                                   java.lang.String id,
                                   java.lang.String tableName)
```
    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.
  - grantListStreams
```
@Deprecated
public static Grant grantListStreams(IGrantable grantee)
```
    Deprecated. Use grantTableListStreams(software.amazon.awscdk.services.iam.IGrantable) for more granular permission
    
    (deprecated) Permits an IAM Principal to list all DynamoDB Streams.
    
    Parameters:
    
    grantee - The principal (no-op if undefined). This parameter is required.
  - addGlobalSecondaryIndex
```
public void addGlobalSecondaryIndex(GlobalSecondaryIndexProps props)
```
    Add a global secondary index of table.
    
    Parameters:
    
    props - the property of global secondary index. This parameter is required.
  - addLocalSecondaryIndex
```
public void addLocalSecondaryIndex(LocalSecondaryIndexProps props)
```
    Add a local secondary index of table.
    
    Parameters:
    
    props - the property of local secondary index. This parameter is required.
  - autoScaleGlobalSecondaryIndexReadCapacity
```
public IScalableTableAttribute autoScaleGlobalSecondaryIndexReadCapacity(java.lang.String indexName,
                                                                         EnableScalingProps props)
```
    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
```
public IScalableTableAttribute autoScaleGlobalSecondaryIndexWriteCapacity(java.lang.String indexName,
                                                                          EnableScalingProps props)
```
    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
```
public IScalableTableAttribute autoScaleReadCapacity(EnableScalingProps props)
```
    Enable read capacity scaling for this table.
    
    Parameters:
    
    props - This parameter is required.
    
    Returns:
    
    An object to configure additional AutoScaling settings
  - autoScaleWriteCapacity
```
public IScalableTableAttribute autoScaleWriteCapacity(EnableScalingProps props)
```
    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
```
public 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.
    
    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
```
public 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.
    
    Specified by:
    
    grantFullAccess in interface ITable
    
    Parameters:
    
    grantee - The principal to grant access to. This parameter is required.
  - grantReadData
```
public 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.
    
    Specified by:
    
    grantReadData in interface ITable
    
    Parameters:
    
    grantee - The principal to grant access to. This parameter is required.
  - grantReadWriteData
```
public 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.
    
    Specified by:
    
    grantReadWriteData in interface ITable
    
    Parameters:
    
    grantee - The principal to grant access to. This parameter is required.
  - grantStream
```
public 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.
    
    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
```
public 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.
    
    Specified by:
    
    grantStreamRead in interface ITable
    
    Parameters:
    
    grantee - The principal to grant access to. This parameter is required.
  - grantTableListStreams
```
public Grant grantTableListStreams(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
```
public 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.
    
    Specified by:
    
    grantWriteData in interface ITable
    
    Parameters:
    
    grantee - The principal to grant access to. This parameter is required.
  - metric
```
public Metric metric(java.lang.String metricName,
                     MetricOptions props)
```
    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
```
public Metric metric(java.lang.String metricName)
```
    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
```
public Metric metricConditionalCheckFailedRequests(MetricOptions props)
```
    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
```
public Metric metricConditionalCheckFailedRequests()
```
    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
```
public Metric metricConsumedReadCapacityUnits(MetricOptions props)
```
    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
```
public Metric metricConsumedReadCapacityUnits()
```
    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
```
public Metric metricConsumedWriteCapacityUnits(MetricOptions props)
```
    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
```
public Metric metricConsumedWriteCapacityUnits()
```
    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
```
public Metric metricSuccessfulRequestLatency(MetricOptions props)
```
    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
```
public Metric metricSuccessfulRequestLatency()
```
    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
  - metricSystemErrors
```
@Deprecated
public Metric metricSystemErrors(MetricOptions props)
```
    Deprecated. use `metricSystemErrorsForOperations`.
    
    (deprecated) Metric for the system errors this table.
    
    Specified by:
    
    metricSystemErrors in interface ITable
    
    Parameters:
    
    props -
  - metricSystemErrors
```
@Deprecated
public Metric metricSystemErrors()
```
    Deprecated. use `metricSystemErrorsForOperations`.
    
    (deprecated) Metric for the system errors this table.
    
    Specified by:
    
    metricSystemErrors in interface ITable
  - metricSystemErrorsForOperations
```
public IMetric metricSystemErrorsForOperations(SystemErrorsForOperationsMetricOptions props)
```
    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
```
public IMetric metricSystemErrorsForOperations()
```
    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
```
public Metric metricThrottledRequests(MetricOptions props)
```
    How many requests are throttled on this table.
    Default: sum over 5 minutes
    
    Specified by:
    
    metricThrottledRequests in interface ITable
    
    Parameters:
    
    props -
  - metricThrottledRequests
```
public Metric metricThrottledRequests()
```
    How many requests are throttled on this table.
    Default: sum over 5 minutes
    
    Specified by:
    
    metricThrottledRequests in interface ITable
  - metricUserErrors
```
public Metric metricUserErrors(MetricOptions props)
```
    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
```
public Metric metricUserErrors()
```
    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
  - schema
```
public SchemaOptions schema(java.lang.String indexName)
```
    Get schema attributes of table or index.
    
    Parameters:
    
    indexName -
    
    Returns:
    
    Schema of table or index.
  - schema
```
public SchemaOptions schema()
```
    Get schema attributes of table or index.
    
    Returns:
    
    Schema of table or index.
  - validate
```
protected java.util.List<java.lang.String> validate()
```
    Validate the table construct.
    
    Overrides:
    
    validate in class Construct
    
    Returns:
    
    an array of validation error message
  - getHasIndex
```
protected java.lang.Boolean getHasIndex()
```
    Whether this table has indexes.
  - getRegionalArns
```
protected java.util.List<java.lang.String> getRegionalArns()
```
  - getTableArn
```
public java.lang.String getTableArn()
```
    Arn of the dynamodb table.
    
    Specified by:
    
    getTableArn in interface ITable
  - getTableName
```
public java.lang.String getTableName()
```
    Table name of the dynamodb table.
    
    Specified by:
    
    getTableName in interface ITable
  - getEncryptionKey
```
public IKey getEncryptionKey()
```
    KMS encryption key, if this table uses a customer-managed encryption key.
    
    Specified by:
    
    getEncryptionKey in interface ITable
  - getTableStreamArn
```
public java.lang.String getTableStreamArn()
```
    ARN of the table's stream, if there is one.
    
    Specified by:
    
    getTableStreamArn in interface ITable

Class Table

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.Resource

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

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

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

Constructor Detail

Table

Table

Table

Method Detail

fromTableArn

fromTableAttributes

fromTableName

grantListStreams

addGlobalSecondaryIndex

addLocalSecondaryIndex

autoScaleGlobalSecondaryIndexReadCapacity

autoScaleGlobalSecondaryIndexWriteCapacity

autoScaleReadCapacity

autoScaleWriteCapacity

grant

grantFullAccess

grantReadData

grantReadWriteData

grantStream

grantStreamRead

grantTableListStreams

grantWriteData

metric

metric

metricConditionalCheckFailedRequests

metricConditionalCheckFailedRequests

metricConsumedReadCapacityUnits

metricConsumedReadCapacityUnits

metricConsumedWriteCapacityUnits

metricConsumedWriteCapacityUnits

metricSuccessfulRequestLatency

metricSuccessfulRequestLatency

metricSystemErrors

metricSystemErrors

metricSystemErrorsForOperations

metricSystemErrorsForOperations

metricThrottledRequests

metricThrottledRequests

metricUserErrors

metricUserErrors

schema

schema

validate

getHasIndex

getRegionalArns

getTableArn

getTableName

getEncryptionKey

getTableStreamArn