Struct DynamoDbAction

#[non_exhaustive]
pub struct DynamoDbAction {
    pub table_name: String,
    pub role_arn: String,
    pub operation: Option<String>,
    pub hash_key_field: String,
    pub hash_key_value: String,
    pub hash_key_type: Option<DynamoKeyType>,
    pub range_key_field: Option<String>,
    pub range_key_value: Option<String>,
    pub range_key_type: Option<DynamoKeyType>,
    pub payload_field: Option<String>,
}

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()}"

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

table_name: String

The name of the DynamoDB table.

role_arn: String

The ARN of the IAM role that grants access to the DynamoDB table.

operation: Option<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.

hash_key_field: String

The hash key name.

hash_key_value: String

The hash key value.

hash_key_type: Option<DynamoKeyType>

The hash key type. Valid values are "STRING" or "NUMBER"

range_key_field: Option<String>

The range key name.

range_key_value: Option<String>

The range key value.

range_key_type: Option<DynamoKeyType>

The range key type. Valid values are "STRING" or "NUMBER"

payload_field: Option<String>

The action payload. This name can be customized.

Implementations

impl DynamoDbAction

pub fn table_name(&self) -> &str

The name of the DynamoDB table.

pub fn role_arn(&self) -> &str

The ARN of the IAM role that grants access to the DynamoDB table.

pub fn operation(&self) -> Option<&str>

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.

pub fn hash_key_field(&self) -> &str

The hash key name.

pub fn hash_key_value(&self) -> &str

The hash key value.

pub fn hash_key_type(&self) -> Option<&DynamoKeyType>

The hash key type. Valid values are "STRING" or "NUMBER"

pub fn range_key_field(&self) -> Option<&str>

The range key name.

pub fn range_key_value(&self) -> Option<&str>

The range key value.

pub fn range_key_type(&self) -> Option<&DynamoKeyType>

The range key type. Valid values are "STRING" or "NUMBER"

pub fn payload_field(&self) -> Option<&str>

The action payload. This name can be customized.

impl DynamoDbAction

pub fn builder() -> DynamoDbActionBuilder

Creates a new builder-style object to manufacture DynamoDbAction.

Trait Implementations

impl Clone for DynamoDbAction

fn clone(&self) -> DynamoDbAction

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DynamoDbAction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DynamoDbAction

fn eq(&self, other: &DynamoDbAction) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DynamoDbAction