Official
aws-lite
plugin for DynamoDB
Maintained by: @architect
npm i @aws-lite/dynamodb
Optionally install types:
npm i -D @aws-lite/dynamodb-types
Reference documentation with examples at aws-lite.org
Properties:
-
Statements
(array) [required]- Array of PartiQL statements representing the batch being run
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
Properties:
-
RequestItems
(object) [required]- An object containing >=1 table names and, for each table, an object describing >=1 items to get
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
Properties:
-
RequestItems
(object) [required]- An object containing >=1 table names and, for each table, an object describing >=1 items to write
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
-
ReturnItemCollectionMetrics
(string)- Return collection metrics in response, can be set to:
SIZE
, orNONE
(default)
- Return collection metrics in response, can be set to:
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
BackupName
(string) [required]- Specified name of the backup
Properties:
-
GlobalTableName
(string) [required]- DynamoDB table name
-
ReplicationGroup
(array) [required]- AWS regions where the global table needs to be created
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
AttributeDefinitions
(array) [required]- Array of attributes that describe the primary (and sort) schema for the table
-
KeySchema
(array) [required]- Attributes that make up the primary key for a table or index. The attributes in
KeySchema
must also be defined in theAttributeDefinitions
array
- Attributes that make up the primary key for a table or index. The attributes in
-
BillingMode
(string)- Set how the table is charged for read/write throughput:
PROVISIONED
, orPAY_PER_REQUEST
- Set how the table is charged for read/write throughput:
-
DeletionProtectionEnabled
(boolean)- Enable or disable deletion protection
-
GlobalSecondaryIndexes
(array)- 1-20 global secondary indexes to be created on the table
- More details (AWS)
-
LocalSecondaryIndexes
(array)- 1-5 local secondary indexes to be created on the table
- More details (AWS)
-
ProvisionedThroughput
(object)- Provisioned throughput setting
-
SSESpecification
(object)- Server-side encryption settings
-
StreamSpecification
(object)- Settings for Streams, including:
StreamEnabled
(boolean), andStreamViewType
(KEYS_ONLY
,NEW_IMAGE
,OLD_IMAGE
, orNEW_AND_OLD_IMAGES
)
- Settings for Streams, including:
-
TableClass
(string)- Class of the table, can be set to:
STANDARD
, orSTANDARD_INFREQUENT_ACCESS
- Class of the table, can be set to:
-
Tags
(array)- Array of pairs to label the table
Properties:
-
BackupArn
(string) [required]- ARN of the specified backup
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
Key
(object) [required]- Primary (and sort) key of the item in question
-
ConditionalOperator
(string)- Legacy parameter, use
FilterExpression
instead
- Legacy parameter, use
-
ConditionExpression
(string)- Condition that must be satisfied in order to complete the operation
- More details (AWS)
-
Expected
(object)- Legacy parameter, use
ConditionExpression
instead
- Legacy parameter, use
-
ExpressionAttributeNames
(object)- Substitution tokens for attribute names in an expression
- More details (AWS)
-
ExpressionAttributeValues
(object)- Values that can be substituted in an expression
- More details (AWS)
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
-
ReturnItemCollectionMetrics
(string)- Return collection metrics in response, can be set to:
SIZE
, orNONE
(default)
- Return collection metrics in response, can be set to:
-
ReturnValues
(string)- Return the item as it was prior to the operation taking place, can be set to
NONE
(default), orALL_OLD
- Return the item as it was prior to the operation taking place, can be set to
-
ReturnValuesOnConditionCheckFailure
(string)- Return the item attributes that failed a condition check, can be set to
NONE
, orALL_OLD
- Return the item attributes that failed a condition check, can be set to
Properties:
-
TableName
(string) [required]- DynamoDB table name
Properties:
-
BackupArn
(string) [required]- ARN of the specified backup
Properties:
-
TableName
(string) [required]- DynamoDB table name
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
IndexName
(string)- DynamoDB global secondary index name (if applicable)
Properties:
Properties:
-
ExportArn
(string) [required]- ARN of the specified export
Properties:
-
GlobalTableName
(string) [required]- DynamoDB global table name
Properties:
-
GlobalTableName
(string) [required]- DynamoDB global table name
Properties:
-
ImportArn
(string) [required]- ARN of the specified import
Properties:
-
TableName
(string) [required]- DynamoDB table name
Properties:
Properties:
-
TableName
(string) [required]- DynamoDB table name
Properties:
-
TableName
(string) [required]- DynamoDB table name
Properties:
-
TableName
(string) [required]- DynamoDB table name
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
StreamArn
(string) [required]- ARN of the specified Kinesis data stream
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
StreamArn
(string) [required]- ARN of the specified Kinesis data stream
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
Statement
(string) [required]- PartiQL statement representing the operation to run
-
ConsistentRead
(boolean)- Enable strongly consistent reads; by default eventually consistent reads are used
-
Limit
(number)- Maximum number of items to evaluate and return
-
NextToken
(string)- Pagination cursor token to be used if
NextToken
was returned in a previous response
- Pagination cursor token to be used if
-
Parameters
(array)- PartiQL statement parameters, if any
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
-
ReturnValuesOnConditionCheckFailure
(string)- Return the item attributes that failed a condition check, can be set to
NONE
, orALL_OLD
- Return the item attributes that failed a condition check, can be set to
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
TransactStatements
(array) [required]- PartiQL statement parameters representing the transaction to run
-
ClientRequestToken
(string)- Pagination cursor token to be used if
NextToken
was returned in a previous response
- Pagination cursor token to be used if
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
Properties:
-
S3Bucket
(string) [required]- Destination S3 bucket of the snapshot export
-
TableArn
(string) [required]- ARN of the table being exported
-
ClientToken
(string)- Ensures operation request is idempotent
-
ExportFormat
(string)- Format for the exported data, can be set to:
DYNAMODB_JSON
, orIO
- Format for the exported data, can be set to:
-
ExportTime
(number)- Point in time (in epoch seconds) from which to export table data
-
S3BucketOwner
(string)- AWS account ID that owns the destination S3 bucket
-
S3Prefix
(string)- S3 bucket prefix to use as the file name and path of the exported snapshot
-
S3SseAlgorithm
(string)- Type of encryption used on the bucket where export data will be stored, can be set to
AES256
, orKMS
- Type of encryption used on the bucket where export data will be stored, can be set to
-
S3SseKmsKeyId
(string)- AWS KMS managed key ID used to encrypt the destination S3 bucket (if applicable)
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
Key
(object) [required]- Primary (and sort) key of the item in question
-
AttributesToGet
(array)- Legacy parameter, use
ProjectionExpression
instead
- Legacy parameter, use
-
ConsistentRead
(boolean)- Enable strongly consistent reads; by default eventually consistent reads are used
-
ExpressionAttributeNames
(object)- Substitution tokens for attribute names in an expression
- More details (AWS)
-
ProjectionExpression
(string)- Comma separated string that identifies one or more attributes to retrieve from the table
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
Properties:
-
InputFormat
(string) [required]- Source data format, can be set to:
CSV
,DYNAMODB_JSON
, orION
- Source data format, can be set to:
-
S3BucketSource
(object) [required]- Destination S3 bucket of the snapshot import
-
TableCreationParameters
(object) [required]- Parameters for the table to import the data
- More details (AWS)
-
ClientToken
(string)- Ensures operation request is idempotent
-
InputCompressionType
(string)- Input compression type, can be set to:
GZIP
,ZSTD
, orNONE
- Input compression type, can be set to:
-
InputFormatOptions
(object)- Additional input formatting options
Properties:
-
BackupType
(string)- Limit backups by type, can be set to:
USER
SYSTEM
,AWS_BACKUP
, orALL
- Limit backups by type, can be set to:
-
ExclusiveStartBackupArn
(string)- Pagination cursor token ARN to be used if
LastEvaluatedBackupArn
was returned in a previous response
- Pagination cursor token ARN to be used if
-
Limit
(number)- Maximum number of items to evaluate and return
-
TableName
(string)- List backups by DynamoDB table name
-
TimeRangeLowerBound
(number)- Inclusively return backups created after this time
-
TimeRangeUpperBound
(number)- Exclusively return backups created before this time
-
paginate
(boolean, string)- Enable automatic result pagination; use this instead of making your own individual pagination requests
Properties:
-
MaxResults
(number)- Maximum number of items to evaluate and return
-
NextToken
(string)- Pagination cursor token to be used if
NextToken
was returned in a previous response
- Pagination cursor token to be used if
-
TableName
(string)- DynamoDB table name
Properties:
-
MaxResults
(number)- Maximum number of items to evaluate and return
-
NextToken
(string)- Pagination cursor token to be used if
NextToken
was returned in a previous response
- Pagination cursor token to be used if
-
TableArn
(string)- ARN of the exported table
Properties:
-
ExclusiveStartGlobalTableName
(string)- Pagination cursor token to be used if
LastEvaluatedGlobalTableName
was returned in a previous response
- Pagination cursor token to be used if
-
Limit
(number)- Maximum number of items to evaluate and return
-
RegionName
(string)- List the global tables in a specific region
Properties:
-
NextToken
(string)- Pagination cursor token to be used if
NextToken
was returned in a previous response
- Pagination cursor token to be used if
-
PageSize
(number)- Maximum number of items to evaluate and return
-
TableArn
(string)- ARN of the table imported to
Properties:
-
ExclusiveStartTableName
(string)- Pagination cursor token to be used if
LastEvaluatedTableName
was returned in a previous response
- Pagination cursor token to be used if
-
Limit
(number)- Maximum number of items to evaluate and return
Properties:
-
NextToken
(string)- Pagination cursor token to be used if
NextToken
was returned in a previous response
- Pagination cursor token to be used if
-
ResourceArn
(string) [required]- Resource tags to be returned
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
Item
(object) [required]- Item to be written to DynamoDB
-
ConditionalOperator
(string)- Legacy parameter, use
FilterExpression
instead
- Legacy parameter, use
-
ConditionExpression
(string)- Condition that must be satisfied in order to complete the operation
- More details (AWS)
-
Expected
(object)- Legacy parameter, use
ConditionExpression
instead
- Legacy parameter, use
-
ExpressionAttributeNames
(object)- Substitution tokens for attribute names in an expression
- More details (AWS)
-
ExpressionAttributeValues
(object)- Values that can be substituted in an expression
- More details (AWS)
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
-
ReturnItemCollectionMetrics
(string)- Return collection metrics in response, can be set to:
SIZE
, orNONE
(default)
- Return collection metrics in response, can be set to:
-
ReturnValues
(string)- Return the item as it was prior to the operation taking place, can be set to
NONE
(default), orALL_OLD
- Return the item as it was prior to the operation taking place, can be set to
-
ReturnValuesOnConditionCheckFailure
(string)- Return the item attributes that failed a condition check, can be set to
NONE
, orALL_OLD
- Return the item attributes that failed a condition check, can be set to
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
AttributesToGet
(array)- Legacy parameter, use
ProjectionExpression
instead
- Legacy parameter, use
-
ConditionalOperator
(string)- Legacy parameter, use
FilterExpression
instead
- Legacy parameter, use
-
ConsistentRead
(boolean)- Enable strongly consistent reads; by default eventually consistent reads are used
-
ExclusiveStartKey
(object)- Pagination cursor token ARN to be used if
LastEvaluatedKey
was returned in a previous response
- Pagination cursor token ARN to be used if
-
ExpressionAttributeNames
(object)- Substitution tokens for attribute names in an expression
- More details (AWS)
-
ExpressionAttributeValues
(object)- Values that can be substituted in an expression
- More details (AWS)
-
FilterExpression
(string)- String of filter conditions applied before data is returned
- More details (AWS)
-
IndexName
(string)- DynamoDB global secondary index name (if applicable)
-
KeyConditionExpression
(string)- Condition specifying the key values for items to be retrieved; the condition must perform an equality test on a single partition key value
- More details (AWS)
-
KeyConditions
(object)- Legacy parameter, use
KeyConditionExpression
instead
- Legacy parameter, use
-
Limit
(number)- Maximum number of items to evaluate and return
-
ProjectionExpression
(string)- Comma separated string that identifies one or more attributes to retrieve from the table
-
QueryFilter
(object)- Legacy parameter, use
FilterExpression
instead
- Legacy parameter, use
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
-
ScanIndexForward
(boolean)- Index traversal order:
true
(default) for ascending,false
for descending order
- Index traversal order:
-
Select
(string)- Attributes to be returned in the result, can be set to:
ALL_ATTRIBUTES
,ALL_PROJECTED_ATTRIBUTES
,COUNT
, orSPECIFIC_ATTRIBUTES
- More details (AWS)
- Attributes to be returned in the result, can be set to:
-
paginate
(boolean, string)- Enable automatic result pagination; use this instead of making your own individual pagination requests
Properties:
-
BackupArn
(string) [required]- ARN of the specified backup
-
TargetTableName
(string) [required]- Name of the new table into which the backup will be restored
-
BillingModeOverride
(string)- Set how the table is charged for read/write throughput:
PROVISIONED
, orPAY_PER_REQUEST
- Set how the table is charged for read/write throughput:
-
GlobalSecondaryIndexOverride
(array)- List of global secondary indexes for the restored table; included indexes should match existing secondary indexes, although indexes can be excluded
-
LocalSecondaryIndexOverride
(array)- List of local secondary indexes for the restored table; included indexes should match existing secondary indexes, although indexes can be excluded
-
ProvisionedThroughputOverride
(object)- Provisioned throughput setting
-
SSESpecificationOverride
(object)- Server-side encryption settings
Properties:
-
TargetTableName
(string) [required]- Name of the new table into which the backup will be restored
-
BillingModeOverride
(string)- Set how the table is charged for read/write throughput:
PROVISIONED
, orPAY_PER_REQUEST
- Set how the table is charged for read/write throughput:
-
GlobalSecondaryIndexOverride
(array)- List of global secondary indexes for the restored table; included indexes should match existing secondary indexes, although indexes can be excluded
-
LocalSecondaryIndexOverride
(array)- List of local secondary indexes for the restored table; included indexes should match existing secondary indexes, although indexes can be excluded
-
ProvisionedThroughputOverride
(object)- Provisioned throughput setting
-
RestoreDateTime
(number)- Past time to restore the table to
-
SourceTableArn
(string)- ARN of the specified backup
-
SourceTableName
(string)- Name of the source table being restored
-
SSESpecificationOverride
(object)- Server-side encryption settings
-
UseLatestRestorableTime
(boolean)- Restore to the latest possible time; typically 5 minutes before the current time
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
AttributesToGet
(array)- Legacy parameter, use
ProjectionExpression
instead
- Legacy parameter, use
-
ConditionalOperator
(string)- Legacy parameter, use
FilterExpression
instead
- Legacy parameter, use
-
ConsistentRead
(boolean)- Enable strongly consistent reads; by default eventually consistent reads are used
-
ExclusiveStartKey
(object)- Pagination cursor token ARN to be used if
LastEvaluatedKey
was returned in a previous response
- Pagination cursor token ARN to be used if
-
ExpressionAttributeNames
(object)- Substitution tokens for attribute names in an expression
- More details (AWS)
-
ExpressionAttributeValues
(object)- Values that can be substituted in an expression
- More details (AWS)
-
FilterExpression
(string)- String of filter conditions applied before data is returned
- More details (AWS)
-
IndexName
(string)- DynamoDB global secondary index name (if applicable)
-
Limit
(number)- Maximum number of items to evaluate and return
-
ProjectionExpression
(string)- Comma separated string that identifies one or more attributes to retrieve from the table
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
-
ScanFilter
(object)- Legacy parameter, use
FilterExpression
instead
- Legacy parameter, use
-
Segment
(number)- Individual segment to be scanned in a parallel
Scan
request - More details (AWS)
- Individual segment to be scanned in a parallel
-
Select
(string)- Attributes to be returned in the result, can be set to:
ALL_ATTRIBUTES
,ALL_PROJECTED_ATTRIBUTES
,COUNT
, orSPECIFIC_ATTRIBUTES
- More details (AWS)
- Attributes to be returned in the result, can be set to:
-
TotalSegments
(number)- Total number of segments to be scanned in a parallel
Scan
request - More details (AWS)
- Total number of segments to be scanned in a parallel
-
paginate
(boolean, string)- Enable automatic result pagination; use this instead of making your own individual pagination requests
Properties:
-
ResourceArn
(string) [required]- Resource to add tags to
-
Tags
(array) [required]- Tags to be assigned
Properties:
-
TransactItems
(array) [required]- Ordered array of up to 100
TransactGetItem
objects, each of which containing aGet
object - More details (AWS)
- Ordered array of up to 100
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
Properties:
-
TransactItems
(array) [required]- Ordered array of up to 100
TransactWriteItem
objects, each of which containing aConditionCheck
,Put
,Update
, orDelete
object - More details (AWS)
- Ordered array of up to 100
-
ClientRequestToken
(string)- Ensures operation request is idempotent
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
-
ReturnItemCollectionMetrics
(string)- Return collection metrics in response, can be set to:
SIZE
, orNONE
(default)
- Return collection metrics in response, can be set to:
Properties:
-
ResourceArn
(string) [required]- Resource to remove tags from
-
TagKeys
(array) [required]- Tags to be removed
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
PointInTimeRecoverySpecification
(object)- Point in time recovery settings
- More details (AWS)
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
ContributorInsightsAction
(string)- Contributor insights action, can be set to:
ENABLE
orDISABLE
- Contributor insights action, can be set to:
-
IndexName
(string)- DynamoDB global secondary index name (if applicable)
Properties:
-
GlobalTableName
(string) [required]- DynamoDB global table name
-
ReplicaUpdates
(array)- List of regions to be added or removed from the global table
Properties:
-
GlobalTableName
(string) [required]- DynamoDB global table name
-
GlobalTableBillingMode
(string)- Set how the table is charged for read/write throughput:
PROVISIONED
, orPAY_PER_REQUEST
- Set how the table is charged for read/write throughput:
-
GlobalTableGlobalSecondaryIndexSettingsUpdate
(array)- 1-20 global secondary indexes to be modified
- More details (AWS)
-
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate
(object)- Auto-scaling settings for managing provisioned write capacity
- More details (AWS)
-
GlobalTableProvisionedWriteCapacityUnits
(number)- Maximum number of writes per second before returning a
ThrottlingException
- Maximum number of writes per second before returning a
-
ReplicaSettingsUpdate
(array)- Global table settings to be modified
- More details (AWS)
Properties:
-
Key
(object) [required]- Primary (and sort) key of the item in question
-
TableName
(string) [required]- DynamoDB table name
-
AttributeUpdates
(object)- Legacy parameter, use
UpdateExpression
instead
- Legacy parameter, use
-
ConditionalOperator
(string)- Legacy parameter, use
ConditionExpression
instead
- Legacy parameter, use
-
ConditionExpression
(string)- Condition that must be satisfied in order to complete the operation
- More details (AWS)
-
Expected
(object)- Legacy parameter, use
ConditionExpression
instead
- Legacy parameter, use
-
ExpressionAttributeNames
(object)- Substitution tokens for attribute names in an expression
- More details (AWS)
-
ExpressionAttributeValues
(object)- Values that can be substituted in an expression
- More details (AWS)
-
ReturnConsumedCapacity
(string)- Return throughput consumption in response, can be set to one of:
INDEXES
,TOTAL
, orNONE
- Return throughput consumption in response, can be set to one of:
-
ReturnItemCollectionMetrics
(string)- Return collection metrics in response, can be set to:
SIZE
, orNONE
(default)
- Return collection metrics in response, can be set to:
-
ReturnValues
(string)- Return the item as it was prior to the operation taking place, can be set to
NONE
(default),ALL_OLD
,UPDATED_OLD
,ALL_NEW
,UPDATED_NEW
- Return the item as it was prior to the operation taking place, can be set to
-
ReturnValuesOnConditionCheckFailure
(string)- Return the item attributes that failed a condition check, can be set to
NONE
, orALL_OLD
- Return the item attributes that failed a condition check, can be set to
-
UpdateExpression
(string)- Expression that defines attributes to be updated, the action to be performed on each, and their new values
- More details (AWS)
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
AttributeDefinitions
(array)- Array of attributes that describe the primary (and sort) schema for the table
-
BillingMode
(string)- Set how the table is charged for read/write throughput:
PROVISIONED
, orPAY_PER_REQUEST
- Set how the table is charged for read/write throughput:
-
DeletionProtectionEnabled
(boolean)- Enable or disable deletion protection
-
GlobalSecondaryIndexUpdates
(array)- Global secondary index updates, each of which may be:
Create
,Update
, orDelete
- More details (AWS)
- Global secondary index updates, each of which may be:
-
ProvisionedThroughput
(object)- Provisioned throughput setting
-
ReplicaUpdates
(array)- Table replica updates, each of which may be:
Create
,Update
, orDelete
- More details (AWS)
- Table replica updates, each of which may be:
-
SSESpecification
(object)- Server-side encryption settings
-
StreamSpecification
(object)- Settings for Streams, including:
StreamEnabled
(boolean), andStreamViewType
(KEYS_ONLY
,NEW_IMAGE
,OLD_IMAGE
, orNEW_AND_OLD_IMAGES
)
- Settings for Streams, including:
-
TableClass
(string)- Class of the table, can be set to:
STANDARD
, orSTANDARD_INFREQUENT_ACCESS
- Class of the table, can be set to:
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
GlobalSecondaryIndexUpdates
(array)- Auto-scaling settings of the global secondary indexes of the replica
- More details (AWS)
-
ProvisionedWriteCapacityAutoScalingUpdate
(object)- Auto-scaling settings for a global table or global secondary index
- More details (AWS)
-
ReplicaUpdates
(array)- Auto=scaling settings of table replicas
- More details (AWS)
Properties:
-
TableName
(string) [required]- DynamoDB table name
-
TimeToLiveSpecification
(object)- TTL settings for the specified table
This plugin covers all DynamoDB methods (listed & linked below), utilizing DynamoDB's semantics.
By default, with the exception of certain legacy properties (noted below), this plugin will automatically (de)serialize AWS-flavored JSON in requests and responses, so you do not have to treat that as a concern.
Legacy properties (which DynamoDB discourages the use of) that will not be automatically (de)serialized:
DeleteItem.Expected
,PutItem.Expected
,Query.KeyConditions
,Query.QueryFilter
,Scan.ScanFilter
,UpdateItem.Expected
import awsLite from '@aws-lite/client'
const aws = await awsLite()
// See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html
await aws.dynamodb.PutItem({
TableName: 'your-table-name',
Item: { id: 'hello', ts: new Date().toISOString() }
})
BatchExecuteStatement
BatchGetItem
BatchWriteItem
CreateBackup
CreateGlobalTable
CreateTable
DeleteBackup
DeleteItem
DeleteTable
DescribeBackup
DescribeContinuousBackups
DescribeContributorInsights
DescribeEndpoints
DescribeExport
DescribeGlobalTable
DescribeGlobalTableSettings
DescribeImport
DescribeKinesisStreamingDestination
DescribeLimits
DescribeTable
DescribeTableReplicaAutoScaling
DescribeTimeToLive
DisableKinesisStreamingDestination
EnableKinesisStreamingDestination
ExecuteStatement
ExecuteTransaction
ExportTableToPointInTime
GetItem
ImportTable
ListBackups
ListContributorInsights
ListExports
ListGlobalTables
ListImports
ListTables
ListTagsOfResource
PutItem
Query
RestoreTableFromBackup
RestoreTableToPointInTime
Scan
TagResource
TransactGetItems
TransactWriteItems
UntagResource
UpdateContinuousBackups
UpdateContributorInsights
UpdateGlobalTable
UpdateGlobalTableSettings
UpdateItem
UpdateTable
UpdateTableReplicaAutoScaling
UpdateTimeToLive