You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTEvents::Types::DynamoDBAction

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DynamoDBAction as input to an Aws::Client method, you can use a vanilla Hash:

{
  hash_key_type: "DynamoKeyType",
  hash_key_field: "DynamoKeyField", # required
  hash_key_value: "DynamoKeyValue", # required
  range_key_type: "DynamoKeyType",
  range_key_field: "DynamoKeyField",
  range_key_value: "DynamoKeyValue",
  operation: "DynamoOperation",
  payload_field: "DynamoKeyField",
  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 standard action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

The tableName and hashKeyField values must match the table name and the partition key of the DynamoDB table.

If the DynamoDB table also has a sort key, you must specify rangeKeyField. The rangeKeyField value must match the sort key.

The hashKeyValue and rangeKeyValue use substitution templates. These templates provide data at runtime. The syntax is ${sql-expression}.

You can use expressions for parameters that are string data type. 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 payloadField is <payload-field>_raw.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#hash_key_field ⇒ String

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

Returns:

  • (String) —

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

#hash_key_type ⇒ String

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.

Returns:

  • (String) —

    The data type for the hash key (also called the partition key).

#hash_key_value ⇒ String

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

Returns:

  • (String) —

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

#operation ⇒ String

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.

Returns:

  • (String) —

    The type of operation to perform.

#payload ⇒ Types::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:

  • (Types::Payload) —

    Information needed to configure the payload.

    By default, AWS IoT Events generates a standard payload in JSON for any action.

#payload_field ⇒ String

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.

Returns:

  • (String) —

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

#range_key_field ⇒ String

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

Returns:

  • (String) —

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

#range_key_type ⇒ String

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.

Returns:

  • (String) —

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

#range_key_value ⇒ String

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

Returns:

  • (String) —

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

#table_name ⇒ String

The name of the DynamoDB table.

Returns:

  • (String) —

    The name of the DynamoDB table.