Struct aws_sdk_iotevents::types::DynamoDbAction
source · #[non_exhaustive]pub struct DynamoDbAction {
pub hash_key_type: Option<String>,
pub hash_key_field: String,
pub hash_key_value: String,
pub range_key_type: Option<String>,
pub range_key_field: Option<String>,
pub range_key_value: Option<String>,
pub operation: Option<String>,
pub payload_field: Option<String>,
pub table_name: String,
pub payload: Option<Payload>,
}
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
.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.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_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_value: String
The value of the hash key (also called the partition key).
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_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_value: Option<String>
The value of the range key (also called the sort 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_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
.
table_name: String
The name of the DynamoDB table. The tableName
value must match the table name of the target DynamoDB table.
payload: Option<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
.
Implementations§
source§impl DynamoDbAction
impl DynamoDbAction
sourcepub fn hash_key_type(&self) -> Option<&str>
pub fn hash_key_type(&self) -> Option<&str>
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'
.
sourcepub fn hash_key_field(&self) -> &str
pub fn hash_key_field(&self) -> &str
The name of the hash key (also called the partition key). The hashKeyField
value must match the partition key of the target DynamoDB table.
sourcepub fn hash_key_value(&self) -> &str
pub fn hash_key_value(&self) -> &str
The value of the hash key (also called the partition key).
sourcepub fn range_key_type(&self) -> Option<&str>
pub fn range_key_type(&self) -> Option<&str>
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'
.
sourcepub fn range_key_field(&self) -> Option<&str>
pub fn range_key_field(&self) -> Option<&str>
The name of the range key (also called the sort key). The rangeKeyField
value must match the sort key of the target DynamoDB table.
sourcepub fn range_key_value(&self) -> Option<&str>
pub fn range_key_value(&self) -> Option<&str>
The value of the range key (also called the sort key).
sourcepub fn operation(&self) -> Option<&str>
pub fn operation(&self) -> Option<&str>
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.
sourcepub fn payload_field(&self) -> Option<&str>
pub fn payload_field(&self) -> Option<&str>
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
.
sourcepub fn table_name(&self) -> &str
pub fn table_name(&self) -> &str
The name of the DynamoDB table. The tableName
value must match the table name of the target DynamoDB table.
sourcepub fn payload(&self) -> Option<&Payload>
pub fn payload(&self) -> Option<&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
.
source§impl DynamoDbAction
impl DynamoDbAction
sourcepub fn builder() -> DynamoDbActionBuilder
pub fn builder() -> DynamoDbActionBuilder
Creates a new builder-style object to manufacture DynamoDbAction
.
Trait Implementations§
source§impl Clone for DynamoDbAction
impl Clone for DynamoDbAction
source§fn clone(&self) -> DynamoDbAction
fn clone(&self) -> DynamoDbAction
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DynamoDbAction
impl Debug for DynamoDbAction
source§impl PartialEq for DynamoDbAction
impl PartialEq for DynamoDbAction
source§fn eq(&self, other: &DynamoDbAction) -> bool
fn eq(&self, other: &DynamoDbAction) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for DynamoDbAction
Auto Trait Implementations§
impl Freeze for DynamoDbAction
impl RefUnwindSafe for DynamoDbAction
impl Send for DynamoDbAction
impl Sync for DynamoDbAction
impl Unpin for DynamoDbAction
impl UnwindSafe for DynamoDbAction
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more