interface DynamoDBProperty

Language	Type name
.NET	`Amazon.CDK.AWS.IoTEvents.CfnDetectorModel.DynamoDBProperty`
Java	`software.amazon.awscdk.services.iotevents.CfnDetectorModel.DynamoDBProperty`
Python	`aws_cdk.aws_iotevents.CfnDetectorModel.DynamoDBProperty`
TypeScript	`@aws-cdk/aws-iotevents` » `CfnDetectorModel` » `DynamoDBProperty`

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iotevents from '@aws-cdk/aws-iotevents';
const dynamoDBProperty: iotevents.CfnDetectorModel.DynamoDBProperty = {
  hashKeyField: 'hashKeyField',
  hashKeyValue: 'hashKeyValue',
  tableName: 'tableName',

  // the properties below are optional
  hashKeyType: 'hashKeyType',
  operation: 'operation',
  payload: {
    contentExpression: 'contentExpression',
    type: 'type',
  },
  payloadField: 'payloadField',
  rangeKeyField: 'rangeKeyField',
  rangeKeyType: 'rangeKeyType',
  rangeKeyValue: 'rangeKeyValue',
};

Properties

Name	Type	Description
hashKeyField	`string`	The name of the hash key (also called the partition key).
hashKeyValue	`string`	The value of the hash key (also called the partition key).
tableName	`string`	The name of the DynamoDB table.
hashKeyType?	`string`	The data type for the hash key (also called the partition key). You can specify the following values:.
operation?	`string`	The type of operation to perform. You can specify the following values:.
payload?	`IResolvable` `\|` `PayloadProperty`	Information needed to configure the payload.
payloadField?	`string`	The name of the DynamoDB column that receives the action payload.
rangeKeyField?	`string`	The name of the range key (also called the sort key).
rangeKeyType?	`string`	The data type for the range key (also called the sort key), You can specify the following values:.
rangeKeyValue?	`string`	The value of the range key (also called the sort key).

hashKeyField

Type: string

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

The hashKeyField value must match the partition key of the target DynamoDB table.

hashKeyValue

Type: string

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

tableName

Type: string

The name of the DynamoDB table.

The tableName value must match the table name of the target DynamoDB table.

hashKeyType?

Type: string (optional)

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

'STRING' - The hash key is a string.
'NUMBER' - The hash key is a number.

If you don't specify hashKeyType , the default value is 'STRING' .

operation?

Type: string (optional)

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

'INSERT' - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
'UPDATE' - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
'DELETE' - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.

If you don't specify this parameter, AWS IoT Events triggers the 'INSERT' operation.

payload?

Type: IResolvable | PayloadProperty (optional)

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression .

payloadField?

Type: string (optional)

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

If you don't specify this parameter, the name of the DynamoDB column is payload .

rangeKeyField?

Type: string (optional)

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

The rangeKeyField value must match the sort key of the target DynamoDB table.

rangeKeyType?

Type: string (optional)

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

'STRING' - The range key is a string.
'NUMBER' - The range key is number.

If you don't specify rangeKeyField , the default value is 'STRING' .

rangeKeyValue?

Type: string (optional)

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