Class: Aws::IoTEvents::Types::DynamoDBv2Action

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb

Overview

Note:

When making an API call, you may pass DynamoDBv2Action data as a hash:

{
  table_name: "DynamoTableName", # required
  payload: {
    content_expression: "ContentExpression", # required
    type: "STRING", # required, accepts STRING, JSON
  },
}

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

You must use expressions for all parameters in DynamoDBv2Action. 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 tableName parameter can be 'GreenhouseTemperatureTable'.

  • For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName.

  • 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 contentExpression parameter in Payload uses a substitution template.

    '\{"sensorID": "$\{$input.GreenhouseInput.sensor_id\}", "temperature": "$\{$input.GreenhouseInput.temperature * 9 / 5 + 32\}"\}'

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

The value for the type parameter in Payload must be JSON.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#payloadTypes::Payload

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.

Returns:



3297
3298
3299
3300
3301
3302
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 3297

class DynamoDBv2Action < Struct.new(
  :table_name,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end

#table_nameString

The name of the DynamoDB table.

Returns:

  • (String)


3297
3298
3299
3300
3301
3302
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 3297

class DynamoDBv2Action < Struct.new(
  :table_name,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end