AWSIoTDynamoDBAction Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSIoTModel.h
AWSIoTModel.m

Overview

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

Required parameters: [tableName, roleArn, hashKeyField, hashKeyValue]

  hashKeyField

The hash key name.

@property (nonatomic, strong) NSString *hashKeyField

Declared In

AWSIoTModel.h

  hashKeyType

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

@property (nonatomic, assign) AWSIoTDynamoKeyType hashKeyType

Declared In

AWSIoTModel.h

  hashKeyValue

The hash key value.

@property (nonatomic, strong) NSString *hashKeyValue

Declared In

AWSIoTModel.h

  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.

@property (nonatomic, strong) NSString *operation

Declared In

AWSIoTModel.h

  payloadField

The action payload. This name can be customized.

@property (nonatomic, strong) NSString *payloadField

Declared In

AWSIoTModel.h

  rangeKeyField

The range key name.

@property (nonatomic, strong) NSString *rangeKeyField

Declared In

AWSIoTModel.h

  rangeKeyType

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

@property (nonatomic, assign) AWSIoTDynamoKeyType rangeKeyType

Declared In

AWSIoTModel.h

  rangeKeyValue

The range key value.

@property (nonatomic, strong) NSString *rangeKeyValue

Declared In

AWSIoTModel.h

  roleArn

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

@property (nonatomic, strong) NSString *roleArn

Declared In

AWSIoTModel.h

  tableName

The name of the DynamoDB table.

@property (nonatomic, strong) NSString *tableName

Declared In

AWSIoTModel.h