Optional ReadonlyencryptionKMS encryption key, if this table uses a customer-managed encryption key.
ReadonlyenvThe 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.
ReadonlynodeThe tree node.
Protected ReadonlyphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationProtected ReadonlyregionalOptionalresourceResource policy to assign to DynamoDB Table.
ReadonlystackThe stack in which this resource is defined.
ReadonlytableReadonlytableReadonlytableStatic ReadonlyPROPERTY_Uniquely identifies this class.
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
Add a global secondary index of table.
the property of global secondary index
Add a local secondary index of table.
the property of local secondary index
Adds a statement to the resource policy associated with this file system.
A resource policy will be automatically created upon the first call to addToResourcePolicy.
Note that this does not work with imported file systems.
The policy statement to add
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).
Enable read capacity scaling for the given GSI
An object to configure additional AutoScaling settings for this attribute
Enable write capacity scaling for the given GSI
An object to configure additional AutoScaling settings for this attribute
Enable read capacity scaling for this table
An object to configure additional AutoScaling settings
Enable write capacity scaling for this table
An object to configure additional AutoScaling settings for this attribute
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
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.
The principal (no-op if undefined)
The set of actions to allow (i.e. "dynamodb:PutItem", "dynamodb:GetItem", ...)
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.
The principal to grant access to
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.
The principal to grant access to
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.
The principal to grant access to
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.
The principal (no-op if undefined)
The set of actions to allow (i.e. "dynamodb:DescribeStream", "dynamodb:GetRecords", ...)
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.
The principal to grant access to
Permits an IAM Principal to list streams attached to current dynamodb table.
The principal (no-op if undefined)
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.
The principal to grant access to
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.
Optionalprops: MetricOptionsMetric 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.
Optionalprops: MetricOptionsMetric 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.
Optionalprops: MetricOptionsMetric 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.
Optionalprops: MetricOptionsMetric 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.
Optionalprops: MetricOptionsMetric 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.
Optionalprops: SystemErrorsForOperationsMetricOptionsHow many requests are throttled on this table, for the given operation
Default: sum over 5 minutes
Optionalprops: MetricOptionsHow 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.
Optionalprops: OperationsMetricOptionsMetric 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.
Optionalprops: MetricOptionsGet schema attributes of table or index.
OptionalindexName: stringSchema of table or index.
Returns a string representation of this construct.
StaticfromCreates a Table construct that represents an external table via table arn.
The parent creating construct (usually this).
The construct's name.
The table's ARN.
StaticfromCreates a Table construct that represents an external table.
The parent creating construct (usually this).
The construct's name.
A TableAttributes object.
StaticfromCreates a Table construct that represents an external table via table name.
The parent creating construct (usually this).
The construct's name.
The table's name.
StaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
DeletionProtection is enabled by default for this Table. We recommend enabling this enabled for all active DynamoDB tables. The default can be overridden in the GuDynamoTable instantiation if needed eg: for table deletion.