Class DynamoDBAction
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DynamoDBAction.Builder,
DynamoDBAction>
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 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 value for the
payloadField
parameter is <payload-field>_raw
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DynamoDBAction.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The name of the hash key (also called the partition key).final String
The data type for the hash key (also called the partition key).final String
The value of the hash key (also called the partition key).final String
The type of operation to perform.final Payload
payload()
Returns the value of the Payload property for this object.final String
The name of the DynamoDB column that receives the action payload.final String
The name of the range key (also called the sort key).final String
The data type for the range key (also called the sort key), You can specify the following values:final String
The value of the range key (also called the sort key).static Class
<? extends DynamoDBAction.Builder> final String
The name of the DynamoDB table.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hashKeyType
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:
- 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'
. -
-
-
hashKeyField
The name of the hash key (also called the partition key). The
hashKeyField
value must match the partition key of the target DynamoDB table.- Returns:
- The name of the hash key (also called the partition key). The
hashKeyField
value must match the partition key of the target DynamoDB table.
-
hashKeyValue
The value of the hash key (also called the partition key).
- Returns:
- The value of the hash key (also called the partition key).
-
rangeKeyType
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:
- 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'
. -
-
-
rangeKeyField
The name of the range key (also called the sort key). The
rangeKeyField
value must match the sort key of the target DynamoDB table.- Returns:
- The name of the range key (also called the sort key). The
rangeKeyField
value must match the sort key of the target DynamoDB table.
-
rangeKeyValue
The value of the range key (also called the sort key).
- Returns:
- The value of the range key (also called the sort key).
-
operation
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:
- 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. -
-
-
payloadField
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:
- 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
.
-
tableName
The name of the DynamoDB table. The
tableName
value must match the table name of the target DynamoDB table.- Returns:
- The name of the DynamoDB table. The
tableName
value must match the table name of the target DynamoDB table.
-
payload
Returns the value of the Payload property for this object.- Returns:
- The value of the Payload property for this object.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DynamoDBAction.Builder,
DynamoDBAction> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-