aws-cdk-lib.aws_iot.CfnTopicRule.TimestreamActionProperty

interface TimestreamActionProperty

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnTopicRule.TimestreamActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnTopicRule_TimestreamActionProperty
Javasoftware.amazon.awscdk.services.iot.CfnTopicRule.TimestreamActionProperty
Pythonaws_cdk.aws_iot.CfnTopicRule.TimestreamActionProperty
TypeScript aws-cdk-lib » aws_iot » CfnTopicRule » TimestreamActionProperty

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 { aws_iot as iot } from 'aws-cdk-lib';
const timestreamActionProperty: iot.CfnTopicRule.TimestreamActionProperty = {
  databaseName: 'databaseName',
  dimensions: [{
    name: 'name',
    value: 'value',
  }],
  roleArn: 'roleArn',
  tableName: 'tableName',

  // the properties below are optional
  timestamp: {
    unit: 'unit',
    value: 'value',
  },
};

Properties

NameTypeDescription
databaseNamestringThe name of an Amazon Timestream database that has the table to write records into.
dimensionsIResolvable | IResolvable | TimestreamDimensionProperty[]Metadata attributes of the time series that are written in each measure record.
roleArnstringThe Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
tableNamestringThe table where the message data will be written.
timestamp?IResolvable | TimestreamTimestampPropertyThe value to use for the entry's timestamp.

databaseName

Type: string

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


dimensions

Type: IResolvable | IResolvable | TimestreamDimensionProperty[]

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


roleArn

Type: string

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


tableName

Type: string

The table where the message data will be written.


timestamp?

Type: IResolvable | TimestreamTimestampProperty (optional)

The value to use for the entry's timestamp.

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