DynamoDbAction

Describes an action to write to a DynamoDB table.

The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.

The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.

You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

"hashKeyValue": "${topic(3)}"

The following field uses the timestamp:

"rangeKeyValue": "${timestamp()}"

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The hash key name.

Link copied to clipboard

The hash key type. Valid values are "STRING" or "NUMBER"

Link copied to clipboard

The hash key value.

Link copied to clipboard

The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.

Link copied to clipboard

The action payload. This name can be customized.

Link copied to clipboard

The range key name.

Link copied to clipboard

The range key type. Valid values are "STRING" or "NUMBER"

Link copied to clipboard

The range key value.

Link copied to clipboard

The ARN of the IAM role that grants access to the DynamoDB table.

Link copied to clipboard

The name of the DynamoDB table.

Functions

Link copied to clipboard
inline fun copy(block: DynamoDbAction.Builder.() -> Unit = {}): DynamoDbAction
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String