iot/aws.sdk.kotlin.services.iot.model/InfluxDbAction

InfluxDbAction

The InfluxDB rule action converts the message payload into InfluxDB line protocol. It writes the result to a table in an InfluxDB database. The database can be an Amazon Timestream for InfluxDB instance or a self-managed InfluxDB cluster.

The action connects to InfluxDB through an InfluxDB topic rule destination, which must be in the ENABLED state before the action can write data.

Types

Builder

class Builder

Companion

object Companion

Properties

batchConfig

val batchConfig: InfluxDbBatchConfig?

The batching configuration for the action. When present, IoT collects data points from multiple messages and writes them to InfluxDB in a single request.

databaseName

val databaseName: String

The name of the InfluxDB database to write to. In InfluxDB 2, this is the name of the bucket.

destinationArn

val destinationArn: String

The ARN of the InfluxDB topic rule destination that identifies the InfluxDB instance to write to.

organization

val organization: String?

The name of the InfluxDB organization that owns the database.

roleArn

val roleArn: String

The ARN of the role that grants permission to retrieve the InfluxDB API token from Amazon Web Services Secrets Manager.

tableName

val tableName: String

The name of the table to write the data point to. This is the measurement name of the InfluxDB line protocol record.

Functions

copy

inline fun copy(block: InfluxDbAction.Builder.() -> Unit = {}): InfluxDbAction

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String