DynamoDbAction

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'.

  • For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the hashKeyValue parameter uses a substitution template. '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'

  • For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the tableName parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw.

Types

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

Properties

Link copied to clipboard

The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.

Link copied to clipboard

The data type for the hash key (also called the partition key). You can specify the following values:

Link copied to clipboard

The value of the hash key (also called the partition key).

Link copied to clipboard

The type of operation to perform. You can specify the following values:

Link copied to clipboard

Information needed to configure the payload.

Link copied to clipboard

The name of the DynamoDB column that receives the action payload.

Link copied to clipboard

The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.

Link copied to clipboard

The data type for the range key (also called the sort key), You can specify the following values:

Link copied to clipboard

The value of the range key (also called the sort key).

Link copied to clipboard

The name of the DynamoDB table. The tableName value must match the table name of the target 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