Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS IoT DynamoDB Action

DynamoDB is a property of the Actions property that describes an AWS IoT action that writes data to a DynamoDB table.

The HashKeyField, RangeKeyField, and TableName values must match the values you used when you initially created the table.

The HashKeyValue and RangeKeyValue fields use the ${sql-expression} substitution template syntax. You can specify any valid expression in a WHERE or SELECT clause. This expression can include JSON properties, comparisons, calculations, and functions, for example:

  • The "HashKeyValue" : "${topic(3)} field uses the third level of the topic.

  • The "RangeKeyValue" : "${timestamp()} field uses the timestamp.

Syntax

JSON

Copy
{ "HashKeyField": String, "HashKeyValue": String, "PayloadField": String, "RangeKeyField": String, "RangeKeyValue": String, "RoleArn": String, "TableName": String }

YAML

Copy
HashKeyField: String HashKeyValue: String PayloadField: String RangeKeyField: String RangeKeyValue: String RoleArn: String TableName: String

Properties

HashKeyField

The name of the hash key.

Required: Yes

Type: String

HashKeyValue

The value of the hash key.

Required: Yes

Type: String

PayloadField

The name of the column in the DynamoDB table that contains the result of the query. You can customize this name.

Required: No

Type: String

RangeKeyField

The name of the range key.

Required: Yes

Type: String

RangeKeyValue

The value of the range key.

Required: Yes

Type: String

RoleArn

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

Required: Yes

Type: String

TableName

The name of the DynamoDB table.

Required: Yes

Type: String

On this page: