AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.IoT.Model.InfluxDBAction

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public class InfluxDBAction

The InfluxDBAction type exposes the following members

Constructors

NameDescription
Public Method InfluxDBAction()

Properties

NameTypeDescription
Public Property BatchConfig Amazon.IoT.Model.InfluxDBBatchConfig

Gets and sets the property BatchConfig.

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

If omitted, each message is written to InfluxDB in its own request.

Public Property DatabaseName System.String

Gets and sets the property DatabaseName.

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

Public Property DestinationArn System.String

Gets and sets the property DestinationArn.

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

Public Property Organization System.String

Gets and sets the property Organization.

The name of the InfluxDB organization that owns the database.

A write to an InfluxDB 2 instance fails if this value isn't set. This value isn't used when the destination is an InfluxDB 3 instance.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

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

Public Property TableName System.String

Gets and sets the property TableName.

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

Accepts substitution templates.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

The set of tags to write with each data point. Tags are the indexed metadata of an InfluxDB data point.

Tag names and tag values accept substitution templates. A tag name can't use the @{...} per-element form. A tag name must resolve to the same value for every element of an array payload.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property TimestampUnit Amazon.IoT.InfluxDBTimestampUnit

Gets and sets the property TimestampUnit.

The precision of the timestamp written with each data point. Valid values are s (seconds), ms (milliseconds), us (microseconds), and ns (nanoseconds).

If omitted, the topic rule action uses ms.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer