AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.IoT.Model.DynamoDBAction

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public class DynamoDBAction

The DynamoDBAction type exposes the following members

Constructors

NameDescription
Public Method DynamoDBAction()

Properties

NameTypeDescription
Public Property HashKeyField System.String

Gets and sets the property HashKeyField.

The hash key name.

Public Property HashKeyType Amazon.IoT.DynamoKeyType

Gets and sets the property HashKeyType.

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

Public Property HashKeyValue System.String

Gets and sets the property HashKeyValue.

The hash key value.

Public Property Operation System.String

Gets and sets the property Operation.

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.

Public Property PayloadField System.String

Gets and sets the property PayloadField.

The action payload. This name can be customized.

Public Property RangeKeyField System.String

Gets and sets the property RangeKeyField.

The range key name.

Public Property RangeKeyType Amazon.IoT.DynamoKeyType

Gets and sets the property RangeKeyType.

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

Public Property RangeKeyValue System.String

Gets and sets the property RangeKeyValue.

The range key value.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

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

Public Property TableName System.String

Gets and sets the property TableName.

The name of the DynamoDB table.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5