Class TableBase
Inherited Members
Namespace: Amazon.CDK.AWS.DynamoDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public abstract class TableBase : Resource, ITable, IResource
Syntax (vb)
Public MustInherit Class TableBase
Inherits Resource
Implements ITable, IResource
Synopsis
Constructors
TableBase(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
TableBase(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
TableBase(Construct, String, IResourceProps) |
Properties
EncryptionKey | KMS encryption key, if this table uses a customer-managed encryption key. |
HasIndex | |
RegionalArns | |
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, 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, DescribeTable. |
GrantReadWriteData(IGrantable) | Permits an IAM principal to all data read/write operations to this table. |
GrantStream(IGrantable, 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, DescribeTable. |
Metric(String, IMetricOptions) | Return the given named metric for this Table. |
MetricConditionalCheckFailedRequests(IMetricOptions) | Metric for the conditional check failed requests this table. |
MetricConsumedReadCapacityUnits(IMetricOptions) | Metric for the consumed read capacity units this table. |
MetricConsumedWriteCapacityUnits(IMetricOptions) | Metric for the consumed write capacity units this table. |
MetricSuccessfulRequestLatency(IMetricOptions) | Metric for the successful request latency this table. |
MetricSystemErrors(IMetricOptions) | (deprecated) Metric for the system errors this table. |
MetricSystemErrorsForOperations(ISystemErrorsForOperationsMetricOptions) | Metric for the system errors this table. |
MetricThrottledRequests(IMetricOptions) | (deprecated) How many requests are throttled on this table. |
MetricThrottledRequestsForOperation(String, IMetricOptions) | How many requests are throttled on this table, for the given operation. |
MetricThrottledRequestsForOperations(IOperationsMetricOptions) | How many requests are throttled on this table. |
MetricUserErrors(IMetricOptions) | Metric for the user errors. |
Constructors
TableBase(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected TableBase(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
TableBase(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected TableBase(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
TableBase(Construct, String, IResourceProps)
protected TableBase(Construct scope, string id, IResourceProps props = null)
Parameters
- scope Constructs.Construct
- id System.String
- props IResourceProps
Properties
EncryptionKey
KMS encryption key, if this table uses a customer-managed encryption key.
public abstract IKey EncryptionKey { get; }
Property Value
HasIndex
protected abstract bool HasIndex { get; }
Property Value
System.Boolean
RegionalArns
protected virtual string[] RegionalArns { get; }
Property Value
System.String[]
TableArn
Arn of the dynamodb table.
public abstract string TableArn { get; }
Property Value
System.String
Remarks
Attribute: true
TableName
Table name of the dynamodb table.
public abstract string TableName { get; }
Property Value
System.String
Remarks
Attribute: true
TableStreamArn
ARN of the table's stream, if there is one.
public abstract string TableStreamArn { get; }
Property Value
System.String
Remarks
Attribute: true
Methods
Grant(IGrantable, String[])
Adds an IAM policy statement associated with this table to an IAM principal's policy.
public virtual Grant Grant(IGrantable grantee, params string[] actions)
Parameters
- grantee IGrantable
The principal (no-op if undefined).
- actions System.String[]
The set of actions to allow (i.e. "dynamodb:PutItem", "dynamodb:GetItem", ...).
Returns
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.
public virtual Grant GrantFullAccess(IGrantable grantee)
Parameters
- grantee IGrantable
The principal to grant access to.
Returns
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, DescribeTable.
public virtual Grant GrantReadData(IGrantable grantee)
Parameters
- grantee IGrantable
The principal to grant access to.
Returns
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.
public virtual Grant GrantReadWriteData(IGrantable grantee)
Parameters
- grantee IGrantable
The principal to grant access to.
Returns
Remarks
BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, BatchWriteItem, PutItem, UpdateItem, DeleteItem, DescribeTable
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
GrantStream(IGrantable, String[])
Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.
public virtual Grant GrantStream(IGrantable grantee, params string[] actions)
Parameters
- grantee IGrantable
The principal (no-op if undefined).
- actions System.String[]
The set of actions to allow (i.e. "dynamodb:DescribeStream", "dynamodb:GetRecords", ...).
Returns
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.
public virtual Grant GrantStreamRead(IGrantable grantee)
Parameters
- grantee IGrantable
The principal to grant access to.
Returns
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.
public virtual Grant GrantTableListStreams(IGrantable grantee)
Parameters
- grantee IGrantable
The principal (no-op if undefined).
Returns
GrantWriteData(IGrantable)
Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem, DescribeTable.
public virtual Grant GrantWriteData(IGrantable grantee)
Parameters
- grantee IGrantable
The principal to grant access to.
Returns
Remarks
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
Metric(String, IMetricOptions)
Return the given named metric for this Table.
public virtual Metric Metric(string metricName, IMetricOptions props = null)
Parameters
- metricName System.String
- props IMetricOptions
Returns
Remarks
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.
MetricConditionalCheckFailedRequests(IMetricOptions)
Metric for the conditional check failed requests this table.
public virtual Metric MetricConditionalCheckFailedRequests(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
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.
MetricConsumedReadCapacityUnits(IMetricOptions)
Metric for the consumed read capacity units this table.
public virtual Metric MetricConsumedReadCapacityUnits(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
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.
MetricConsumedWriteCapacityUnits(IMetricOptions)
Metric for the consumed write capacity units this table.
public virtual Metric MetricConsumedWriteCapacityUnits(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
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.
MetricSuccessfulRequestLatency(IMetricOptions)
Metric for the successful request latency this table.
public virtual Metric MetricSuccessfulRequestLatency(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
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.
MetricSystemErrors(IMetricOptions)
(deprecated) Metric for the system errors this table.
public virtual Metric MetricSystemErrors(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Stability: Deprecated
MetricSystemErrorsForOperations(ISystemErrorsForOperationsMetricOptions)
Metric for the system errors this table.
public virtual IMetric MetricSystemErrorsForOperations(ISystemErrorsForOperationsMetricOptions props = null)
Parameters
Returns
Remarks
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.
MetricThrottledRequests(IMetricOptions)
(deprecated) How many requests are throttled on this table.
public virtual Metric MetricThrottledRequests(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: sum over 5 minutes
Stability: Deprecated
MetricThrottledRequestsForOperation(String, IMetricOptions)
How many requests are throttled on this table, for the given operation.
public virtual Metric MetricThrottledRequestsForOperation(string operation, IMetricOptions props = null)
Parameters
- operation System.String
- props IMetricOptions
Returns
Remarks
Default: sum over 5 minutes
MetricThrottledRequestsForOperations(IOperationsMetricOptions)
How many requests are throttled on this table.
public virtual IMetric MetricThrottledRequestsForOperations(IOperationsMetricOptions props = null)
Parameters
- props IOperationsMetricOptions
Returns
Remarks
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.
MetricUserErrors(IMetricOptions)
Metric for the user errors.
public virtual Metric MetricUserErrors(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
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.