Class: Aws::IoT::Types::DynamoDBAction
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::DynamoDBAction
- Defined in:
- gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb
Overview
When making an API call, you may pass DynamoDBAction data as a 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: ${sql-expression\}.
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()\}"
Constant Summary collapse
- SENSITIVE =
[]
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.
8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8699 class DynamoDBAction < Struct.new( :table_name, :role_arn, :operation, :hash_key_field, :hash_key_value, :hash_key_type, :range_key_field, :range_key_value, :range_key_type, :payload_field) SENSITIVE = [] include Aws::Structure end |
#hash_key_type ⇒ String
The hash key type. Valid values are "STRING" or "NUMBER"
8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8699 class DynamoDBAction < Struct.new( :table_name, :role_arn, :operation, :hash_key_field, :hash_key_value, :hash_key_type, :range_key_field, :range_key_value, :range_key_type, :payload_field) SENSITIVE = [] include Aws::Structure end |
#hash_key_value ⇒ String
The hash key value.
8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8699 class DynamoDBAction < Struct.new( :table_name, :role_arn, :operation, :hash_key_field, :hash_key_value, :hash_key_type, :range_key_field, :range_key_value, :range_key_type, :payload_field) SENSITIVE = [] include Aws::Structure end |
#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
.
8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8699 class DynamoDBAction < Struct.new( :table_name, :role_arn, :operation, :hash_key_field, :hash_key_value, :hash_key_type, :range_key_field, :range_key_value, :range_key_type, :payload_field) SENSITIVE = [] include Aws::Structure end |
#payload_field ⇒ String
The action payload. This name can be customized.
8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8699 class DynamoDBAction < Struct.new( :table_name, :role_arn, :operation, :hash_key_field, :hash_key_value, :hash_key_type, :range_key_field, :range_key_value, :range_key_type, :payload_field) SENSITIVE = [] include Aws::Structure end |
#range_key_field ⇒ String
The range key name.
8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8699 class DynamoDBAction < Struct.new( :table_name, :role_arn, :operation, :hash_key_field, :hash_key_value, :hash_key_type, :range_key_field, :range_key_value, :range_key_type, :payload_field) SENSITIVE = [] include Aws::Structure end |
#range_key_type ⇒ String
The range key type. Valid values are "STRING" or "NUMBER"
8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8699 class DynamoDBAction < Struct.new( :table_name, :role_arn, :operation, :hash_key_field, :hash_key_value, :hash_key_type, :range_key_field, :range_key_value, :range_key_type, :payload_field) SENSITIVE = [] include Aws::Structure end |
#range_key_value ⇒ String
The range key value.
8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8699 class DynamoDBAction < Struct.new( :table_name, :role_arn, :operation, :hash_key_field, :hash_key_value, :hash_key_type, :range_key_field, :range_key_value, :range_key_type, :payload_field) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The ARN of the IAM role that grants access to the DynamoDB table.
8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8699 class DynamoDBAction < Struct.new( :table_name, :role_arn, :operation, :hash_key_field, :hash_key_value, :hash_key_type, :range_key_field, :range_key_value, :range_key_type, :payload_field) SENSITIVE = [] include Aws::Structure end |
#table_name ⇒ String
The name of the DynamoDB table.
8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8699 class DynamoDBAction < Struct.new( :table_name, :role_arn, :operation, :hash_key_field, :hash_key_value, :hash_key_type, :range_key_field, :range_key_value, :range_key_type, :payload_field) SENSITIVE = [] include Aws::Structure end |