software.amazon.awscdk.services.iot

Interface CfnTopicRule.TimestreamActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.TimestreamActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

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

Describes an action that writes records into an Amazon Timestream table.

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.*;
 TimestreamActionProperty timestreamActionProperty = TimestreamActionProperty.builder()
         .databaseName("databaseName")
         .dimensions(List.of(TimestreamDimensionProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .roleArn("roleArn")
         .tableName("tableName")
         // the properties below are optional
         .batchMode(false)
         .timestamp(TimestreamTimestampProperty.builder()
                 .unit("unit")
                 .value("value")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnTopicRule.TimestreamActionProperty.Builder	builder()
default Object	getBatchMode() Whether to process the action as a batch.
String	getDatabaseName() The name of an Amazon Timestream database that has the table to write records into.
Object	getDimensions() Metadata attributes of the time series that are written in each measure record.
String	getRoleArn() The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
String	getTableName() The table where the message data will be written.
default Object	getTimestamp() The value to use for the entry's timestamp.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDatabaseName

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

The name of an Amazon Timestream database that has the table to write records into.

getDimensions

@Stability(value=Stable)
 @NotNull
Object getDimensions()

Metadata attributes of the time series that are written in each measure record.

getRoleArn

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

The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.

getTableName

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

The table where the message data will be written.

getBatchMode

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

Whether to process the action as a batch.

getTimestamp

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

The value to use for the entry's timestamp.

If blank, the time that the entry was processed is used.

builder

@Stability(value=Stable)
static CfnTopicRule.TimestreamActionProperty.Builder builder()

Returns:

a CfnTopicRule.TimestreamActionProperty.Builder of CfnTopicRule.TimestreamActionProperty