Documentation

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

See: newDynamoDBAction smart constructor.

Create a value of DynamoDBAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hashKeyType:DynamoDBAction', dynamoDBAction_hashKeyType - The hash key type. Valid values are "STRING" or "NUMBER"

$sel:operation:DynamoDBAction', dynamoDBAction_operation - 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.

$sel:rangeKeyType:DynamoDBAction', dynamoDBAction_rangeKeyType - The range key type. Valid values are "STRING" or "NUMBER"

$sel:payloadField:DynamoDBAction', dynamoDBAction_payloadField - The action payload. This name can be customized.

$sel:rangeKeyField:DynamoDBAction', dynamoDBAction_rangeKeyField - The range key name.

$sel:rangeKeyValue:DynamoDBAction', dynamoDBAction_rangeKeyValue - The range key value.

$sel:tableName:DynamoDBAction', dynamoDBAction_tableName - The name of the DynamoDB table.

$sel:roleArn:DynamoDBAction', dynamoDBAction_roleArn - The ARN of the IAM role that grants access to the DynamoDB table.

$sel:hashKeyField:DynamoDBAction', dynamoDBAction_hashKeyField - The hash key name.

$sel:hashKeyValue:DynamoDBAction', dynamoDBAction_hashKeyValue - The hash key value.

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

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.

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

The action payload. This name can be customized.

The range key name.

The range key value.

The name of the DynamoDB table.

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

The hash key name.

The hash key value.