DynamoDBAction (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.iot.model.DynamoDBAction

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<DynamoDBAction.Builder,DynamoDBAction>
```
@Generated("software.amazon.awssdk:codegen")
public class DynamoDBAction
extends Object
implements StructuredPojo, ToCopyableBuilder<DynamoDBAction.Builder,DynamoDBAction>
```
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()}"

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DynamoDBAction.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`DynamoDBAction.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DynamoDBAction.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`hashKeyField()`	The hash key name.
`String`	`hashKeyType()`	The hash key type.
`String`	`hashKeyValue()`	The hash key value.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`operation()`	The type of operation to be performed.
`String`	`payloadField()`	The action payload.
`String`	`rangeKeyField()`	The range key name.
`String`	`rangeKeyType()`	The range key type.
`String`	`rangeKeyValue()`	The range key value.
`String`	`roleArn()`	The ARN of the IAM role that grants access to the DynamoDB table.
`static Class<? extends DynamoDBAction.Builder>`	`serializableBuilderClass()`
`String`	`tableName()`	The name of the DynamoDB table.
`DynamoDBAction.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - tableName
```
public String tableName()
```
    The name of the DynamoDB table.
    
    Returns:
    
    The name of the DynamoDB table.
  - roleArn
```
public String roleArn()
```
    The ARN of the IAM role that grants access to the DynamoDB table.
    
    Returns:
    
    The ARN of the IAM role that grants access to the DynamoDB table.
  - operation
```
public String 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.
    
    Returns:
    
    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.
  - hashKeyField
```
public String hashKeyField()
```
    The hash key name.
    
    Returns:
    
    The hash key name.
  - hashKeyValue
```
public String hashKeyValue()
```
    The hash key value.
    
    Returns:
    
    The hash key value.
  - hashKeyType
```
public String hashKeyType()
```
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    Returns:
    
    The hash key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - rangeKeyField
```
public String rangeKeyField()
```
    The range key name.
    
    Returns:
    
    The range key name.
  - rangeKeyValue
```
public String rangeKeyValue()
```
    The range key value.
    
    Returns:
    
    The range key value.
  - rangeKeyType
```
public String rangeKeyType()
```
    The range key type. Valid values are "STRING" or "NUMBER"
    
    Returns:
    
    The range key type. Valid values are "STRING" or "NUMBER"
    
    See Also:
    
    DynamoKeyType
  - payloadField
```
public String payloadField()
```
    The action payload. This name can be customized.
    
    Returns:
    
    The action payload. This name can be customized.
  - toBuilder
```
public DynamoDBAction.Builder 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 interface ToCopyableBuilder<DynamoDBAction.Builder,DynamoDBAction>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DynamoDBAction.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DynamoDBAction.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class DynamoDBAction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

tableName

roleArn

operation

hashKeyField

hashKeyValue

hashKeyType

rangeKeyField

rangeKeyValue

rangeKeyType

payloadField

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall