software.amazon.awscdk.services.dynamodb

Class Table

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.dynamodb.Table

All Implemented Interfaces:

software.amazon.awscdk.IConstruct, software.amazon.awscdk.IDependable, software.amazon.awscdk.IResource, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.11.3 (build 464b8c6)",
           date="2019-06-19T15:09:58.083Z")
 @Stability(value=Experimental)
public class Table
extends software.amazon.awscdk.Resource

Provides a DynamoDB table. EXPERIMENTAL

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	Table(software.amazon.awscdk.Construct scope, String id, TableProps props) EXPERIMENTAL
protected	Table(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

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(String indexName, EnableScalingProps props) Enable read capacity scaling for the given GSI.
IScalableTableAttribute	autoScaleGlobalSecondaryIndexWriteCapacity(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.
String	getTableArn() EXPERIMENTAL
String	getTableName() EXPERIMENTAL
String	getTableStreamArn() EXPERIMENTAL
software.amazon.awscdk.services.iam.Grant	grant(software.amazon.awscdk.services.iam.IGrantable grantee, String... actions) Adds an IAM policy statement associated with this table to an IAM principal's policy.
software.amazon.awscdk.services.iam.Grant	grantFullAccess(software.amazon.awscdk.services.iam.IGrantable grantee) Permits all DynamoDB operations ("dynamodb:*") to an IAM principal.
static software.amazon.awscdk.services.iam.Grant	grantListStreams(software.amazon.awscdk.services.iam.IGrantable grantee) Permits an IAM Principal to list all DynamoDB Streams.
software.amazon.awscdk.services.iam.Grant	grantReadData(software.amazon.awscdk.services.iam.IGrantable grantee) Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan.
software.amazon.awscdk.services.iam.Grant	grantReadWriteData(software.amazon.awscdk.services.iam.IGrantable grantee) Permits an IAM principal to all data read/write operations to this table.
software.amazon.awscdk.services.iam.Grant	grantStream(software.amazon.awscdk.services.iam.IGrantable grantee, String... actions) Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.
software.amazon.awscdk.services.iam.Grant	grantStreamRead(software.amazon.awscdk.services.iam.IGrantable grantee) Permis an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.
software.amazon.awscdk.services.iam.Grant	grantWriteData(software.amazon.awscdk.services.iam.IGrantable grantee) Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem.
protected List<String>	validate() Validate the table construct.

Methods inherited from class software.amazon.awscdk.Resource

getPhysicalName

Methods inherited from class software.amazon.awscdk.Construct

getNode, isConstruct, prepare, synthesize, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, 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.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Table

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

Table

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

EXPERIMENTAL

Method Detail

grantListStreams

@Stability(value=Experimental)
public static software.amazon.awscdk.services.iam.Grant grantListStreams(software.amazon.awscdk.services.iam.IGrantable grantee)

Permits an IAM Principal to list all DynamoDB Streams. EXPERIMENTAL

Parameters:

grantee - The principal (no-op if undefined).

addGlobalSecondaryIndex

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

Add a global secondary index of table. EXPERIMENTAL

Parameters:

props - the property of global secondary index.

addLocalSecondaryIndex

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

Add a local secondary index of table. EXPERIMENTAL

Parameters:

props - the property of local secondary index.

autoScaleGlobalSecondaryIndexReadCapacity

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

Enable read capacity scaling for the given GSI. EXPERIMENTAL

Returns:

An object to configure additional AutoScaling settings for this attribute

autoScaleGlobalSecondaryIndexWriteCapacity

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

Enable write capacity scaling for the given GSI. EXPERIMENTAL

Returns:

An object to configure additional AutoScaling settings for this attribute

autoScaleReadCapacity

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

Enable read capacity scaling for this table. EXPERIMENTAL

Returns:

An object to configure additional AutoScaling settings

autoScaleWriteCapacity

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

Enable write capacity scaling for this table. EXPERIMENTAL

Returns:

An object to configure additional AutoScaling settings for this attribute

grant

@Stability(value=Experimental)
public software.amazon.awscdk.services.iam.Grant grant(software.amazon.awscdk.services.iam.IGrantable grantee,
                                                                                      String... actions)

Adds an IAM policy statement associated with this table to an IAM principal's policy. EXPERIMENTAL

Parameters:

grantee - The principal (no-op if undefined).

actions - The set of actions to allow (i.e. "dynamodb:PutItem", "dynamodb:GetItem", ...).

grantFullAccess

@Stability(value=Experimental)
public software.amazon.awscdk.services.iam.Grant grantFullAccess(software.amazon.awscdk.services.iam.IGrantable grantee)

Permits all DynamoDB operations ("dynamodb:*") to an IAM principal. EXPERIMENTAL

Parameters:

grantee - The principal to grant access to.

grantReadData

@Stability(value=Experimental)
public software.amazon.awscdk.services.iam.Grant grantReadData(software.amazon.awscdk.services.iam.IGrantable grantee)

Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan. EXPERIMENTAL

Parameters:

grantee - The principal to grant access to.

grantReadWriteData

@Stability(value=Experimental)
public software.amazon.awscdk.services.iam.Grant grantReadWriteData(software.amazon.awscdk.services.iam.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. EXPERIMENTAL

Parameters:

grantee - The principal to grant access to.

grantStream

@Stability(value=Experimental)
public software.amazon.awscdk.services.iam.Grant grantStream(software.amazon.awscdk.services.iam.IGrantable grantee,
                                                                                            String... actions)

Adds an IAM policy statement associated with this table's stream to an IAM principal's policy. EXPERIMENTAL

Parameters:

grantee - The principal (no-op if undefined).

actions - The set of actions to allow (i.e. "dynamodb:DescribeStream", "dynamodb:GetRecords", ...).

grantStreamRead

@Stability(value=Experimental)
public software.amazon.awscdk.services.iam.Grant grantStreamRead(software.amazon.awscdk.services.iam.IGrantable grantee)

Permis an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams. EXPERIMENTAL

Parameters:

grantee - The principal to grant access to.

grantWriteData

@Stability(value=Experimental)
public software.amazon.awscdk.services.iam.Grant grantWriteData(software.amazon.awscdk.services.iam.IGrantable grantee)

Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem. EXPERIMENTAL

Parameters:

grantee - The principal to grant access to.

validate

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

Validate the table construct. EXPERIMENTAL

Overrides:

validate in class software.amazon.awscdk.Construct

Returns:

an array of validation error message

getTableArn

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

EXPERIMENTAL

getTableName

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

EXPERIMENTAL

getTableStreamArn

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

EXPERIMENTAL