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, IResource, IResource.Jsii$Default, ITable, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ITable.Jsii$Proxy

Enclosing interface:

ITable

@Internal
public static interface ITable.Jsii$Default
extends ITable, IResource.Jsii$Default

Internal default implementation for ITable.

Nested Class Summary

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

ITable.Jsii$Default, ITable.Jsii$Proxy

Method Summary

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

Methods inherited from interface software.amazon.awscdk.services.dynamodb.ITable

metric, metricConditionalCheckFailedRequests, metricConsumedReadCapacityUnits, metricConsumedWriteCapacityUnits, metricSuccessfulRequestLatency, metricSystemErrorsForOperations, metricThrottledRequests, metricUserErrors

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

(experimental) The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getTableArn

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

(experimental) Arn of the dynamodb table.

Specified by:

getTableArn in interface ITable

getTableName

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

(experimental) Table name of the dynamodb table.

Specified by:

getTableName in interface ITable

getEncryptionKey

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

(experimental) Optional KMS encryption key associated with this table.

Specified by:

getEncryptionKey in interface ITable

getTableStreamArn

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

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

Specified by:

getTableStreamArn in interface ITable

grant

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

(experimental) Metric for the number of Errors executing all Lambdas.

Specified by:

metric in interface ITable

Parameters:

metricName - This parameter is required.

props -

metricConditionalCheckFailedRequests

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

(experimental) Metric for the conditional check failed requests.

Specified by:

metricConditionalCheckFailedRequests in interface ITable

Parameters:

props - properties of a metric.

metricConsumedReadCapacityUnits

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

(experimental) Metric for the consumed read capacity units.

Specified by:

metricConsumedReadCapacityUnits in interface ITable

Parameters:

props - properties of a metric.

metricConsumedWriteCapacityUnits

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

(experimental) Metric for the consumed write capacity units.

Specified by:

metricConsumedWriteCapacityUnits in interface ITable

Parameters:

props - properties of a metric.

metricSuccessfulRequestLatency

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

(experimental) Metric for the successful request latency.

Specified by:

metricSuccessfulRequestLatency in interface ITable

Parameters:

props - properties of a metric.

metricSystemErrorsForOperations

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

(experimental) Metric for the system errors this table.

Specified by:

metricSystemErrorsForOperations in interface ITable

Parameters:

props - properties of a metric.

metricThrottledRequests

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

(experimental) Metric for throttled requests.

Specified by:

metricThrottledRequests in interface ITable

Parameters:

props - properties of a metric.

metricUserErrors

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

(experimental) Metric for the user errors.

Specified by:

metricUserErrors in interface ITable

Parameters:

props - properties of a metric.