Interface CfnTopicRule.DynamoDBActionProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTopicRule.DynamoDBActionProperty.Jsii$Proxy
- Enclosing class:
CfnTopicRule
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()}"
For more information, see DynamoDBv2 Action in the AWS IoT Developer Guide .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.iot.*; DynamoDBActionProperty dynamoDBActionProperty = DynamoDBActionProperty.builder() .hashKeyField("hashKeyField") .hashKeyValue("hashKeyValue") .roleArn("roleArn") .tableName("tableName") // the properties below are optional .hashKeyType("hashKeyType") .payloadField("payloadField") .rangeKeyField("rangeKeyField") .rangeKeyType("rangeKeyType") .rangeKeyValue("rangeKeyValue") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTopicRule.DynamoDBActionProperty
static final class
An implementation forCfnTopicRule.DynamoDBActionProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The hash key name.default String
The hash key type.The hash key value.default String
The action payload.default String
The range key name.default String
The range key type.default String
The range key value.The ARN of the IAM role that grants access to the DynamoDB table.The name of the DynamoDB table.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getHashKeyField
The hash key name.- See Also:
-
getHashKeyValue
The hash key value.- See Also:
-
getRoleArn
The ARN of the IAM role that grants access to the DynamoDB table.- See Also:
-
getTableName
The name of the DynamoDB table.- See Also:
-
getHashKeyType
The hash key type.Valid values are "STRING" or "NUMBER"
- See Also:
-
getPayloadField
The action payload.This name can be customized.
- See Also:
-
getRangeKeyField
The range key name.- See Also:
-
getRangeKeyType
The range key type.Valid values are "STRING" or "NUMBER"
- See Also:
-
getRangeKeyValue
The range key value.- See Also:
-
builder
-