software.amazon.awscdk.services.iotevents

Interface CfnDetectorModel.DynamoDBv2Property

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDetectorModel.DynamoDBv2Property.Jsii$Proxy

Enclosing class:

CfnDetectorModel

@Stability(value=Stable)
public static interface CfnDetectorModel.DynamoDBv2Property
extends software.amazon.jsii.JsiiSerializable

Defines an action to write to the Amazon DynamoDB table that you created.

The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action . The expressions accept literals, operators, functions, references, and substitution templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable' .

• For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName .
• For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the contentExpression parameter in Payload uses a substitution template.

'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'

• For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the tableName parameter uses a string concatenation.

'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide .

The value for the type parameter in Payload must be JSON .

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.iotevents.*;
 DynamoDBv2Property dynamoDBv2Property = DynamoDBv2Property.builder()
         .tableName("tableName")
         // the properties below are optional
         .payload(PayloadProperty.builder()
                 .contentExpression("contentExpression")
                 .type("type")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDetectorModel.DynamoDBv2Property.Builder A builder for CfnDetectorModel.DynamoDBv2Property
static class	CfnDetectorModel.DynamoDBv2Property.Jsii$Proxy An implementation for CfnDetectorModel.DynamoDBv2Property

Method Summary

Modifier and Type	Method and Description
static CfnDetectorModel.DynamoDBv2Property.Builder	builder()
default Object	getPayload() Information needed to configure the payload.
String	getTableName() The name of the DynamoDB table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTableName

@Stability(value=Stable)
 @NotNull
String getTableName()

The name of the DynamoDB table.

getPayload

@Stability(value=Stable)
 @Nullable
default Object getPayload()

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression .

builder

@Stability(value=Stable)
static CfnDetectorModel.DynamoDBv2Property.Builder builder()

Returns:

a CfnDetectorModel.DynamoDBv2Property.Builder of CfnDetectorModel.DynamoDBv2Property