Amazonka.IoT.Types.DynamoDBAction

Documentation

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

See: newDynamoDBAction smart constructor.

Constructors

DynamoDBAction'

Fields

• hashKeyType :: Maybe DynamoKeyType

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

• operation :: Maybe Text

  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.

• payloadField :: Maybe Text

  The action payload. This name can be customized.

• rangeKeyField :: Maybe Text

  The range key name.

• rangeKeyType :: Maybe DynamoKeyType

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

• rangeKeyValue :: Maybe Text

  The range key value.

• tableName :: Text

  The name of the DynamoDB table.

• roleArn :: Text

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

• hashKeyField :: Text

  The hash key name.

• hashKeyValue :: Text

  The hash key value.

Instances

FromJSON DynamoDBAction

Defined in Amazonka.IoT.Types.DynamoDBAction

Methods

parseJSON :: Value -> Parser DynamoDBAction

parseJSONList :: Value -> Parser [DynamoDBAction]

ToJSON DynamoDBAction

Defined in Amazonka.IoT.Types.DynamoDBAction

Methods

toJSON :: DynamoDBAction -> Value

toEncoding :: DynamoDBAction -> Encoding

toJSONList :: [DynamoDBAction] -> Value

toEncodingList :: [DynamoDBAction] -> Encoding

Generic DynamoDBAction

Defined in Amazonka.IoT.Types.DynamoDBAction

Associated Types

type Rep DynamoDBAction :: Type -> Type

Methods

from :: DynamoDBAction -> Rep DynamoDBAction x

to :: Rep DynamoDBAction x -> DynamoDBAction

Read DynamoDBAction

Defined in Amazonka.IoT.Types.DynamoDBAction

Methods

readsPrec :: Int -> ReadS DynamoDBAction

readList :: ReadS [DynamoDBAction]

readPrec :: ReadPrec DynamoDBAction

readListPrec :: ReadPrec [DynamoDBAction]

Show DynamoDBAction

Defined in Amazonka.IoT.Types.DynamoDBAction

Methods

showsPrec :: Int -> DynamoDBAction -> ShowS

show :: DynamoDBAction -> String

showList :: [DynamoDBAction] -> ShowS

NFData DynamoDBAction

Defined in Amazonka.IoT.Types.DynamoDBAction

Methods

rnf :: DynamoDBAction -> ()

Eq DynamoDBAction

Defined in Amazonka.IoT.Types.DynamoDBAction

Methods

(==) :: DynamoDBAction -> DynamoDBAction -> Bool

(/=) :: DynamoDBAction -> DynamoDBAction -> Bool

Hashable DynamoDBAction

Defined in Amazonka.IoT.Types.DynamoDBAction

Methods

hashWithSalt :: Int -> DynamoDBAction -> Int

hash :: DynamoDBAction -> Int

type Rep DynamoDBAction

Defined in Amazonka.IoT.Types.DynamoDBAction

type Rep DynamoDBAction = D1 ('MetaData "DynamoDBAction" "Amazonka.IoT.Types.DynamoDBAction" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DynamoDBAction'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "hashKeyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamoKeyType)) :*: S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "payloadField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "rangeKeyField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rangeKeyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamoKeyType))))) :*: ((S1 ('MetaSel ('Just "rangeKeyValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "hashKeyField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hashKeyValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDynamoDBAction

Arguments

:: Text

$sel:tableName:DynamoDBAction'

-> Text

$sel:roleArn:DynamoDBAction'

-> Text

$sel:hashKeyField:DynamoDBAction'

-> Text

$sel:hashKeyValue:DynamoDBAction'

-> DynamoDBAction

Create a value of DynamoDBAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hashKeyType:DynamoDBAction', dynamoDBAction_hashKeyType - The hash key type. Valid values are "STRING" or "NUMBER"

$sel:operation:DynamoDBAction', dynamoDBAction_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.

$sel:payloadField:DynamoDBAction', dynamoDBAction_payloadField - The action payload. This name can be customized.

$sel:rangeKeyField:DynamoDBAction', dynamoDBAction_rangeKeyField - The range key name.

$sel:rangeKeyType:DynamoDBAction', dynamoDBAction_rangeKeyType - The range key type. Valid values are "STRING" or "NUMBER"

$sel:rangeKeyValue:DynamoDBAction', dynamoDBAction_rangeKeyValue - The range key value.

$sel:tableName:DynamoDBAction', dynamoDBAction_tableName - The name of the DynamoDB table.

$sel:roleArn:DynamoDBAction', dynamoDBAction_roleArn - The ARN of the IAM role that grants access to the DynamoDB table.

$sel:hashKeyField:DynamoDBAction', dynamoDBAction_hashKeyField - The hash key name.

$sel:hashKeyValue:DynamoDBAction', dynamoDBAction_hashKeyValue - The hash key value.

dynamoDBAction_hashKeyType :: Lens' DynamoDBAction (Maybe DynamoKeyType)

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

dynamoDBAction_operation :: Lens' DynamoDBAction (Maybe Text)

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.

dynamoDBAction_payloadField :: Lens' DynamoDBAction (Maybe Text)

The action payload. This name can be customized.

dynamoDBAction_rangeKeyField :: Lens' DynamoDBAction (Maybe Text)

The range key name.

dynamoDBAction_rangeKeyType :: Lens' DynamoDBAction (Maybe DynamoKeyType)

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

dynamoDBAction_rangeKeyValue :: Lens' DynamoDBAction (Maybe Text)

The range key value.

dynamoDBAction_tableName :: Lens' DynamoDBAction Text

The name of the DynamoDB table.

dynamoDBAction_roleArn :: Lens' DynamoDBAction Text

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

dynamoDBAction_hashKeyField :: Lens' DynamoDBAction Text

The hash key name.

dynamoDBAction_hashKeyValue :: Lens' DynamoDBAction Text

The hash key value.