DynamoDBAction class

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()}"

Constructors

DynamoDBAction({required String hashKeyField, required String hashKeyValue, required String roleArn, required String tableName, DynamoKeyType? hashKeyType, String? operation, String? payloadField, String? rangeKeyField, DynamoKeyType? rangeKeyType, String? rangeKeyValue})
DynamoDBAction.fromJson(Map<String, dynamic> json)
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
hashKeyField → String
The hash key name.
final
hashKeyType → DynamoKeyType?
The hash key type. Valid values are "STRING" or "NUMBER"
final
hashKeyValue → String
The hash key value.
final
operation → String?
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.
final
payloadField → String?
The action payload. This name can be customized.
final
rangeKeyField → String?
The range key name.
final
rangeKeyType → DynamoKeyType?
The range key type. Valid values are "STRING" or "NUMBER"
final
rangeKeyValue → String?
The range key value.
final
roleArn → String
The ARN of the IAM role that grants access to the DynamoDB table.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tableName → String
The name of the DynamoDB table.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited