class TableBase
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.DynamoDB.TableBase |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#TableBase |
Java | software.amazon.awscdk.services.dynamodb.TableBase |
Python | aws_cdk.aws_dynamodb.TableBase |
TypeScript (source) | aws-cdk-lib » aws_dynamodb » TableBase |
Implements
IConstruct
, IDependable
, IResource
, ITable
Extends
Resource
Implemented by
Table
Initializer
new TableBase(scope: Construct, id: string, props?: ResourceProps)
Parameters
- scope
Construct
- id
string
- props
Resource
Props
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
has | boolean | |
node | Node | The tree node. |
regional | string[] | |
stack | Stack | The stack in which this resource is defined. |
table | string | Arn of the dynamodb table. |
table | string | Table name of the dynamodb table. |
encryption | IKey | KMS encryption key, if this table uses a customer-managed encryption key. |
table | string | ARN of the table's stream, if there is one. |
env
Type:
Resource
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.
hasIndex
Type:
boolean
node
Type:
Node
The tree node.
regionalArns
Type:
string[]
stack
Type:
Stack
The stack in which this resource is defined.
tableArn
Type:
string
Arn of the dynamodb table.
tableName
Type:
string
Table name of the dynamodb table.
encryptionKey?
Type:
IKey
(optional)
KMS encryption key, if this table uses a customer-managed encryption key.
tableStreamArn?
Type:
string
(optional)
ARN of the table's stream, if there is one.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
grant(grantee, ...actions) | Adds an IAM policy statement associated with this table to an IAM principal's policy. |
grant | Permits all DynamoDB operations ("dynamodb:*") to an IAM principal. |
grant | Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, DescribeTable. |
grant | Permits an IAM principal to all data read/write operations to this table. |
grant | Adds an IAM policy statement associated with this table's stream to an IAM principal's policy. |
grant | Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams. |
grant | Permits an IAM Principal to list streams attached to current dynamodb table. |
grant | Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem, DescribeTable. |
metric(metricName, props?) | Return the given named metric for this Table. |
metric | Metric for the conditional check failed requests this table. |
metric | Metric for the consumed read capacity units this table. |
metric | Metric for the consumed write capacity units this table. |
metric | Metric for the successful request latency this table. |
metric | Metric for the system errors this table. |
metric | Metric for the system errors this table. |
metric | How many requests are throttled on this table. |
metric | How many requests are throttled on this table, for the given operation. |
metric | How many requests are throttled on this table. |
metric | Metric for the user errors. |
to | Returns a string representation of this construct. |
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
grant(grantee, ...actions)
public grant(grantee: IGrantable, ...actions: string[]): Grant
Parameters
- grantee
IGrantable
— The principal (no-op if undefined). - actions
string
— The set of actions to allow (i.e. "dynamodb:PutItem", "dynamodb:GetItem", ...).
Returns
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.
FullAccess(grantee)
grantpublic grantFullAccess(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— The principal to grant access to.
Returns
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.
ReadData(grantee)
grantpublic grantReadData(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— The principal to grant access to.
Returns
Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, DescribeTable.
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
ReadWriteData(grantee)
grantpublic grantReadWriteData(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— The principal to grant access to.
Returns
Permits an IAM principal to all data read/write operations to this table.
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.
Stream(grantee, ...actions)
grantpublic grantStream(grantee: IGrantable, ...actions: string[]): Grant
Parameters
- grantee
IGrantable
— The principal (no-op if undefined). - actions
string
— The set of actions to allow (i.e. "dynamodb:DescribeStream", "dynamodb:GetRecords", ...).
Returns
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.
StreamRead(grantee)
grantpublic grantStreamRead(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— The principal to grant access to.
Returns
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.
TableListStreams(grantee)
grantpublic grantTableListStreams(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— The principal (no-op if undefined).
Returns
Permits an IAM Principal to list streams attached to current dynamodb table.
WriteData(grantee)
grantpublic grantWriteData(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— The principal to grant access to.
Returns
Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem, DescribeTable.
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
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.
ConditionalCheckFailedRequests(props?)
metricpublic metricConditionalCheckFailedRequests(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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.
ConsumedReadCapacityUnits(props?)
metricpublic metricConsumedReadCapacityUnits(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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.
ConsumedWriteCapacityUnits(props?)
metricpublic metricConsumedWriteCapacityUnits(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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.
SuccessfulRequestLatency(props?)
metricpublic metricSuccessfulRequestLatency(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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.
SystemErrors(props?)
metricpublic metricSystemErrors(props?: MetricOptions): Metric
⚠️ Deprecated: use metricSystemErrorsForOperations
.
Parameters
- props
Metric
Options
Returns
Metric for the system errors this table.
SystemErrorsForOperations(props?)
metricpublic metricSystemErrorsForOperations(props?: SystemErrorsForOperationsMetricOptions): IMetric
Parameters
Returns
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.
ThrottledRequests(props?)
metricpublic metricThrottledRequests(props?: MetricOptions): Metric
⚠️ Deprecated: Do not use this function. It returns an invalid metric. Use metricThrottledRequestsForOperation
instead.
Parameters
- props
Metric
Options
Returns
How many requests are throttled on this table.
Default: sum over 5 minutes
ThrottledRequestsForOperation(operation, props?)
metricpublic metricThrottledRequestsForOperation(operation: string, props?: MetricOptions): Metric
Parameters
- operation
string
- props
Metric
Options
Returns
How many requests are throttled on this table, for the given operation.
Default: sum over 5 minutes
ThrottledRequestsForOperations(props?)
metricpublic metricThrottledRequestsForOperations(props?: OperationsMetricOptions): IMetric
Parameters
- props
Operations
Metric Options
Returns
How many requests are throttled on 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.
UserErrors(props?)
metricpublic metricUserErrors(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.