You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::DynamoDBAction
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::DynamoDBAction
- Defined in:
- (unknown)
Overview
When passing DynamoDBAction as input to an Aws::Client method, you can use a vanilla Hash:
{
table_name: "TableName", # required
role_arn: "AwsArn", # required
operation: "DynamoOperation",
hash_key_field: "HashKeyField", # required
hash_key_value: "HashKeyValue", # required
hash_key_type: "STRING", # accepts STRING, NUMBER
range_key_field: "RangeKeyField",
range_key_value: "RangeKeyValue",
range_key_type: "STRING", # accepts STRING, NUMBER
payload_field: "PayloadField",
}
Describes an action to write to a DynamoDB table.
The tableName
, hashKeyField
, and rangeKeyField
values must match the values used when you created the table.
The hashKeyValue
and rangeKeyvalue
fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${<i>sql-expression</i>}
.
You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:
"hashKeyValue": "$
{topic(3)}
"
The following field uses the timestamp:
"rangeKeyValue": "$
{timestamp()}
"
Returned by:
Instance Attribute Summary collapse
-
#hash_key_field ⇒ String
The hash key name.
-
#hash_key_type ⇒ String
The hash key type.
-
#hash_key_value ⇒ String
The hash key value.
-
#operation ⇒ String
The type of operation to be performed.
-
#payload_field ⇒ String
The action payload.
-
#range_key_field ⇒ String
The range key name.
-
#range_key_type ⇒ String
The range key type.
-
#range_key_value ⇒ String
The range key value.
-
#role_arn ⇒ String
The ARN of the IAM role that grants access to the DynamoDB table.
-
#table_name ⇒ String
The name of the DynamoDB table.
Instance Attribute Details
#hash_key_field ⇒ String
The hash key name.
#hash_key_type ⇒ String
The hash key type. Valid values are \"STRING\" or \"NUMBER\"
Possible values:
- STRING
- NUMBER
#hash_key_value ⇒ String
The hash key value.
#operation ⇒ String
The type of operation to be performed. This follows the substitution
template, so it can be $`{operation}`
, but the substitution must
result in one of the following: INSERT
, UPDATE
, or DELETE
.
#payload_field ⇒ String
The action payload. This name can be customized.
#range_key_field ⇒ String
The range key name.
#range_key_type ⇒ String
The range key type. Valid values are \"STRING\" or \"NUMBER\"
Possible values:
- STRING
- NUMBER
#range_key_value ⇒ String
The range key value.
#role_arn ⇒ String
The ARN of the IAM role that grants access to the DynamoDB table.
#table_name ⇒ String
The name of the DynamoDB table.