InfluxDBAction ¶

class InfluxDBAction(TypedDict, closed=True):
    destination_arn: "capo_iot.types.aws_arn.AwsArn"
    """<p>The ARN of the InfluxDB topic rule destination that identifies the InfluxDB instance to write to.</p>"""
    role_arn: "capo_iot.types.aws_arn.AwsArn"
    """<p>The ARN of the role that grants permission to retrieve the InfluxDB API token from Amazon Web Services Secrets Manager.</p>"""
    database_name: "capo_iot.types.influx_db_database_name.InfluxDBDatabaseName"
    """<p>The name of the InfluxDB database to write to. In InfluxDB 2, this is the name of the bucket.</p>"""
    table_name: "capo_iot.types.influx_db_table_name.InfluxDBTableName"
    """<p>The name of the table to write the data point to. This is the measurement name of the InfluxDB line protocol record.</p> <p>Accepts substitution templates.</p>"""
    organization: NotRequired[
        "capo_iot.types.influx_db_organization.InfluxDBOrganization"
    ]
    """<p>The name of the InfluxDB organization that owns the database.</p> <p>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.</p>"""
    tags: NotRequired["capo_iot.types.influx_db_tag_map.InfluxDBTagMap"]
    """<p>The set of tags to write with each data point. Tags are the indexed metadata of an InfluxDB data point.</p> <p>Tag names and tag values accept substitution templates. A tag name can't use the <code>@{...}</code> per-element form. A tag name must resolve to the same value for every element of an array payload.</p>"""
    timestamp_unit: NotRequired[
        "capo_iot.types.influx_db_timestamp_unit.InfluxDBTimestampUnit"
    ]
    """<p>The precision of the timestamp written with each data point. Valid values are <code>s</code> (seconds), <code>ms</code> (milliseconds), <code>us</code> (microseconds), and <code>ns</code> (nanoseconds).</p> <p>If omitted, the topic rule action uses <code>ms</code>.</p>"""
    batch_config: NotRequired[
        "capo_iot.types.influx_db_batch_config.InfluxDBBatchConfig"
    ]
    """<p>The batching configuration for the action. When present, IoT collects data points from multiple messages and writes them to InfluxDB in a single request.</p> <p>If omitted, each message is written to InfluxDB in its own request.</p>"""