/AWS1/CL_IOTDYNAMODBACTION¶
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()}"
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_tablename TYPE /AWS1/IOTTABLENAME /AWS1/IOTTABLENAME¶
The name of the DynamoDB table.
iv_rolearn TYPE /AWS1/IOTAWSARN /AWS1/IOTAWSARN¶
The ARN of the IAM role that grants access to the DynamoDB table.
iv_hashkeyfield TYPE /AWS1/IOTHASHKEYFIELD /AWS1/IOTHASHKEYFIELD¶
The hash key name.
iv_hashkeyvalue TYPE /AWS1/IOTHASHKEYVALUE /AWS1/IOTHASHKEYVALUE¶
The hash key value.
Optional arguments:¶
iv_operation TYPE /AWS1/IOTDYNAMOOPERATION /AWS1/IOTDYNAMOOPERATION¶
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, orDELETE.
iv_hashkeytype TYPE /AWS1/IOTDYNAMOKEYTYPE /AWS1/IOTDYNAMOKEYTYPE¶
The hash key type. Valid values are "STRING" or "NUMBER"
iv_rangekeyfield TYPE /AWS1/IOTRANGEKEYFIELD /AWS1/IOTRANGEKEYFIELD¶
The range key name.
iv_rangekeyvalue TYPE /AWS1/IOTRANGEKEYVALUE /AWS1/IOTRANGEKEYVALUE¶
The range key value.
iv_rangekeytype TYPE /AWS1/IOTDYNAMOKEYTYPE /AWS1/IOTDYNAMOKEYTYPE¶
The range key type. Valid values are "STRING" or "NUMBER"
iv_payloadfield TYPE /AWS1/IOTPAYLOADFIELD /AWS1/IOTPAYLOADFIELD¶
The action payload. This name can be customized.
Queryable Attributes¶
tableName¶
The name of the DynamoDB table.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TABLENAME() |
Getter for TABLENAME, with configurable default |
ASK_TABLENAME() |
Getter for TABLENAME w/ exceptions if field has no value |
HAS_TABLENAME() |
Determine if TABLENAME has a value |
roleArn¶
The ARN of the IAM role that grants access to the DynamoDB table.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
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, orDELETE.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OPERATION() |
Getter for OPERATION, with configurable default |
ASK_OPERATION() |
Getter for OPERATION w/ exceptions if field has no value |
HAS_OPERATION() |
Determine if OPERATION has a value |
hashKeyField¶
The hash key name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HASHKEYFIELD() |
Getter for HASHKEYFIELD, with configurable default |
ASK_HASHKEYFIELD() |
Getter for HASHKEYFIELD w/ exceptions if field has no value |
HAS_HASHKEYFIELD() |
Determine if HASHKEYFIELD has a value |
hashKeyValue¶
The hash key value.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HASHKEYVALUE() |
Getter for HASHKEYVALUE, with configurable default |
ASK_HASHKEYVALUE() |
Getter for HASHKEYVALUE w/ exceptions if field has no value |
HAS_HASHKEYVALUE() |
Determine if HASHKEYVALUE has a value |
hashKeyType¶
The hash key type. Valid values are "STRING" or "NUMBER"
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HASHKEYTYPE() |
Getter for HASHKEYTYPE, with configurable default |
ASK_HASHKEYTYPE() |
Getter for HASHKEYTYPE w/ exceptions if field has no value |
HAS_HASHKEYTYPE() |
Determine if HASHKEYTYPE has a value |
rangeKeyField¶
The range key name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RANGEKEYFIELD() |
Getter for RANGEKEYFIELD, with configurable default |
ASK_RANGEKEYFIELD() |
Getter for RANGEKEYFIELD w/ exceptions if field has no value |
HAS_RANGEKEYFIELD() |
Determine if RANGEKEYFIELD has a value |
rangeKeyValue¶
The range key value.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RANGEKEYVALUE() |
Getter for RANGEKEYVALUE, with configurable default |
ASK_RANGEKEYVALUE() |
Getter for RANGEKEYVALUE w/ exceptions if field has no value |
HAS_RANGEKEYVALUE() |
Determine if RANGEKEYVALUE has a value |
rangeKeyType¶
The range key type. Valid values are "STRING" or "NUMBER"
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RANGEKEYTYPE() |
Getter for RANGEKEYTYPE, with configurable default |
ASK_RANGEKEYTYPE() |
Getter for RANGEKEYTYPE w/ exceptions if field has no value |
HAS_RANGEKEYTYPE() |
Determine if RANGEKEYTYPE has a value |
payloadField¶
The action payload. This name can be customized.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PAYLOADFIELD() |
Getter for PAYLOADFIELD, with configurable default |
ASK_PAYLOADFIELD() |
Getter for PAYLOADFIELD w/ exceptions if field has no value |
HAS_PAYLOADFIELD() |
Determine if PAYLOADFIELD has a value |