Struct rusoto_iotevents::DynamoDBAction
source · [−]pub struct DynamoDBAction {
pub hash_key_field: String,
pub hash_key_type: Option<String>,
pub hash_key_value: String,
pub operation: Option<String>,
pub payload: Option<Payload>,
pub payload_field: Option<String>,
pub range_key_field: Option<String>,
pub range_key_type: Option<String>,
pub range_key_value: Option<String>,
pub table_name: String,
}
Expand description
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
.
Fields
hash_key_field: String
The name of the hash key (also called the partition key). The hashKeyField
value must match the partition key of the target DynamoDB table.
hash_key_type: Option<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'
.
hash_key_value: String
The value of the hash key (also called the partition key).
operation: Option<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.
payload: Option<Payload>
payload_field: Option<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
.
range_key_field: Option<String>
The name of the range key (also called the sort key). The rangeKeyField
value must match the sort key of the target DynamoDB table.
range_key_type: Option<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'
.
range_key_value: Option<String>
The value of the range key (also called the sort key).
table_name: String
The name of the DynamoDB table. The tableName
value must match the table name of the target DynamoDB table.
Trait Implementations
sourceimpl Clone for DynamoDBAction
impl Clone for DynamoDBAction
sourcefn clone(&self) -> DynamoDBAction
fn clone(&self) -> DynamoDBAction
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for DynamoDBAction
impl Debug for DynamoDBAction
sourceimpl Default for DynamoDBAction
impl Default for DynamoDBAction
sourcefn default() -> DynamoDBAction
fn default() -> DynamoDBAction
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for DynamoDBAction
impl<'de> Deserialize<'de> for DynamoDBAction
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<DynamoDBAction> for DynamoDBAction
impl PartialEq<DynamoDBAction> for DynamoDBAction
sourcefn eq(&self, other: &DynamoDBAction) -> bool
fn eq(&self, other: &DynamoDBAction) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DynamoDBAction) -> bool
fn ne(&self, other: &DynamoDBAction) -> bool
This method tests for !=
.
sourceimpl Serialize for DynamoDBAction
impl Serialize for DynamoDBAction
impl StructuralPartialEq for DynamoDBAction
Auto Trait Implementations
impl RefUnwindSafe for DynamoDBAction
impl Send for DynamoDBAction
impl Sync for DynamoDBAction
impl Unpin for DynamoDBAction
impl UnwindSafe for DynamoDBAction
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more