Package 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(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
         .timestamp(TimestreamTimestampProperty.builder()
                 .unit("unit")
                 .value("value")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.TimestreamActionProperty.Builder	builder()
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 Details

getDatabaseName

@Stability(Stable)
@NotNull
String getDatabaseName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html#cfn-iot-topicrule-timestreamaction-databasename

getDimensions

@Stability(Stable)
@NotNull
Object getDimensions()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html#cfn-iot-topicrule-timestreamaction-dimensions

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html#cfn-iot-topicrule-timestreamaction-rolearn

getTableName

@Stability(Stable)
@NotNull
String getTableName()

The table where the message data will be written.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html#cfn-iot-topicrule-timestreamaction-tablename

getTimestamp

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamaction.html#cfn-iot-topicrule-timestreamaction-timestamp

builder

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

Returns:

a CfnTopicRule.TimestreamActionProperty.Builder of CfnTopicRule.TimestreamActionProperty