AlarmModelDynamoDbArgs

data class AlarmModelDynamoDbArgs(val hashKeyField: Output<String>, val hashKeyType: Output<String>? = null, val hashKeyValue: Output<String>, val operation: Output<String>? = null, val payload: Output<AlarmModelPayloadArgs>? = null, val payloadField: Output<String>? = null, val rangeKeyField: Output<String>? = null, val rangeKeyType: Output<String>? = null, val rangeKeyValue: Output<String>? = null, val tableName: Output<String>) : ConvertibleToJava<AlarmModelDynamoDbArgs>

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 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`.

Constructors

Link copied to clipboard
constructor(hashKeyField: Output<String>, hashKeyType: Output<String>? = null, hashKeyValue: Output<String>, operation: Output<String>? = null, payload: Output<AlarmModelPayloadArgs>? = null, payloadField: Output<String>? = null, rangeKeyField: Output<String>? = null, rangeKeyType: Output<String>? = null, rangeKeyValue: Output<String>? = null, tableName: Output<String>)

Properties

Link copied to clipboard
val hashKeyField: Output<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.

Link copied to clipboard
val hashKeyType: Output<String>? = null

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

Link copied to clipboard
val hashKeyValue: Output<String>

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

Link copied to clipboard
val operation: Output<String>? = null

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

Link copied to clipboard
val payload: Output<AlarmModelPayloadArgs>? = null

Information needed to configure the payload. By default, ITE 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`.

Link copied to clipboard
val payloadField: Output<String>? = null

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`.

Link copied to clipboard
val rangeKeyField: Output<String>? = null

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
val rangeKeyType: Output<String>? = null

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

Link copied to clipboard
val rangeKeyValue: Output<String>? = null

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

Link copied to clipboard
val tableName: Output<String>

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

Functions

Link copied to clipboard
open override fun toJava(): AlarmModelDynamoDbArgs