Interface ITable

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

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

ITableRef.TableRef

IEnvironmentAware.Env

Namespace: Amazon.CDK.AWS.DynamoDB

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ITable : IResource, ITableRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Interface ITable Inherits IResource, ITableRef, IConstruct, IDependable, IEnvironmentAware

Synopsis

Properties

EncryptionKey	Optional KMS encryption key associated with this table.
TableArn	Arn of the dynamodb table.
TableName	Table name of the dynamodb table.
TableStreamArn	ARN of the table's stream, if there is one.

Methods

Grant(IGrantable, params string[])	Adds an IAM policy statement associated with this table to an IAM principal's policy.
GrantFullAccess(IGrantable)	Permits all DynamoDB operations ("dynamodb:*") to an IAM principal.
GrantReadData(IGrantable)	Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan.
GrantReadWriteData(IGrantable)	Permits an IAM principal to all data read/write operations to this table.
GrantStream(IGrantable, params string[])	Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.
GrantStreamRead(IGrantable)	Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.
GrantTableListStreams(IGrantable)	Permits an IAM Principal to list streams attached to current dynamodb table.
GrantWriteData(IGrantable)	Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem.
Metric(string, IMetricOptions?)	Metric for the number of Errors executing all Lambdas.
MetricConditionalCheckFailedRequests(IMetricOptions?)	Metric for the conditional check failed requests.
MetricConsumedReadCapacityUnits(IMetricOptions?)	Metric for the consumed read capacity units.
MetricConsumedWriteCapacityUnits(IMetricOptions?)	Metric for the consumed write capacity units.
MetricSuccessfulRequestLatency(IMetricOptions?)	Metric for the successful request latency.
MetricSystemErrorsForOperations(ISystemErrorsForOperationsMetricOptions?)	Metric for the system errors this table.
MetricThrottledRequests(IMetricOptions?)	(deprecated) Metric for throttled requests.
MetricThrottledRequestsForOperations(IOperationsMetricOptions?)	Metric for throttled requests.
MetricUserErrors(IMetricOptions?)	Metric for the user errors.

Properties

EncryptionKey

Optional KMS encryption key associated with this table.

IKey? EncryptionKey { get; }

Property Value

IKey

TableArn

Arn of the dynamodb table.

string TableArn { get; }

Property Value

string

Remarks

Attribute: true

TableName

Table name of the dynamodb table.

string TableName { get; }

Property Value

string

Remarks

Attribute: true

TableStreamArn

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

string? TableStreamArn { get; }

Property Value

string

Remarks

Attribute: true

Methods

Grant(IGrantable, params string[])

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

Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable

The principal (no-op if undefined).

actions string[]

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

Returns

Grant

Remarks

If encryptionKey is present, appropriate grants to the key needs to be added separately using the table.encryptionKey.grant* methods.

GrantFullAccess(IGrantable)

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

Grant GrantFullAccess(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant access to.

Returns

Grant

Remarks

Appropriate grants will also be added to the customer-managed KMS key if one was configured.

GrantReadData(IGrantable)

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

Grant GrantReadData(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant access to.

Returns

Grant

Remarks

Appropriate grants will also be added to the customer-managed KMS key if one was configured.

GrantReadWriteData(IGrantable)

Permits an IAM principal to all data read/write operations to this table.

Grant GrantReadWriteData(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant access to.

Returns

Grant

Remarks

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.

GrantStream(IGrantable, params string[])

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

Grant GrantStream(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable

The principal (no-op if undefined).

actions string[]

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

Returns

Grant

Remarks

If encryptionKey is present, appropriate grants to the key needs to be added separately using the table.encryptionKey.grant* methods.

GrantStreamRead(IGrantable)

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

Grant GrantStreamRead(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant access to.

Returns

Grant

Remarks

Appropriate grants will also be added to the customer-managed KMS key if one was configured.

GrantTableListStreams(IGrantable)

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

Grant GrantTableListStreams(IGrantable grantee)

Parameters

grantee IGrantable

The principal (no-op if undefined).

Returns

Grant

GrantWriteData(IGrantable)

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

Grant GrantWriteData(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant access to.

Returns

Grant

Remarks

Appropriate grants will also be added to the customer-managed KMS key if one was configured.

Metric(string, IMetricOptions?)

Metric for the number of Errors executing all Lambdas.

Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string

props IMetricOptions

Returns

Metric

MetricConditionalCheckFailedRequests(IMetricOptions?)

Metric for the conditional check failed requests.

Metric MetricConditionalCheckFailedRequests(IMetricOptions? props = null)

Parameters

props IMetricOptions

properties of a metric.

Returns

Metric

MetricConsumedReadCapacityUnits(IMetricOptions?)

Metric for the consumed read capacity units.

Metric MetricConsumedReadCapacityUnits(IMetricOptions? props = null)

Parameters

props IMetricOptions

properties of a metric.

Returns

Metric

MetricConsumedWriteCapacityUnits(IMetricOptions?)

Metric for the consumed write capacity units.

Metric MetricConsumedWriteCapacityUnits(IMetricOptions? props = null)

Parameters

props IMetricOptions

properties of a metric.

Returns

Metric

MetricSuccessfulRequestLatency(IMetricOptions?)

Metric for the successful request latency.

Metric MetricSuccessfulRequestLatency(IMetricOptions? props = null)

Parameters

props IMetricOptions

properties of a metric.

Returns

Metric

MetricSystemErrorsForOperations(ISystemErrorsForOperationsMetricOptions?)

Metric for the system errors this table.

IMetric MetricSystemErrorsForOperations(ISystemErrorsForOperationsMetricOptions? props = null)

Parameters

props ISystemErrorsForOperationsMetricOptions

properties of a metric.

Returns

IMetric

MetricThrottledRequests(IMetricOptions?)

(deprecated) Metric for throttled requests.

[Obsolete("use `metricThrottledRequestsForOperations`")]
Metric MetricThrottledRequests(IMetricOptions? props = null)

Parameters

props IMetricOptions

properties of a metric.

Returns

Metric

Remarks

Stability: Deprecated

MetricThrottledRequestsForOperations(IOperationsMetricOptions?)

Metric for throttled requests.

IMetric MetricThrottledRequestsForOperations(IOperationsMetricOptions? props = null)

Parameters

props IOperationsMetricOptions

properties of a metric.

Returns

IMetric

MetricUserErrors(IMetricOptions?)

Metric for the user errors.

Metric MetricUserErrors(IMetricOptions? props = null)

Parameters

props IMetricOptions

properties of a metric.

Returns

Metric