Skip to content

InfluxDBDestinationConfiguration

Source code in docs_src/capo_iot/types/influx_db_destination_configuration.py 
17
18
19
20
21
22
23
24
25
26
27
class InfluxDBDestinationConfiguration(TypedDict, closed=True):
    endpoint: "capo_iot.types.url.Url"
    """<p>The URL of the InfluxDB instance to write to.</p>"""
    influx_db_version: "capo_iot.types.influx_db_version.InfluxDBVersion"
    """<p>The major version of the InfluxDB instance. Valid values are <code>V2</code> and <code>V3</code>.</p>"""
    secret_id: "capo_iot.types.influx_db_secret_id.InfluxDBSecretId"
    """<p>The ARN or name of the Amazon Web Services Secrets Manager secret that contains the InfluxDB API token.</p>"""
    secret_type: NotRequired["capo_iot.types.influx_db_secret_type.InfluxDBSecretType"]
    """<p>The type of the secret that contains the InfluxDB API token. Valid values are <code>SecretString</code> and <code>SecretBinary</code>.</p> <p>If omitted, IoT reads the secret as a string.</p>"""
    secret_key: NotRequired["capo_iot.types.influx_db_secret_key.InfluxDBSecretKey"]
    """<p>The key to read from the secret value when the secret contains a JSON object. If omitted, IoT uses the entire secret value as the InfluxDB API token.</p>"""

endpoint instance-attribute 

endpoint: Url

The URL of the InfluxDB instance to write to.

influx_db_version instance-attribute 

influx_db_version: InfluxDBVersion

The major version of the InfluxDB instance. Valid values are V2 and V3.

secret_id instance-attribute 

secret_id: InfluxDBSecretId

The ARN or name of the Amazon Web Services Secrets Manager secret that contains the InfluxDB API token.

secret_key instance-attribute 

secret_key: NotRequired[InfluxDBSecretKey]

The key to read from the secret value when the secret contains a JSON object. If omitted, IoT uses the entire secret value as the InfluxDB API token.

secret_type instance-attribute 

secret_type: NotRequired[InfluxDBSecretType]

The type of the secret that contains the InfluxDB API token. Valid values are SecretString and SecretBinary.

If omitted, IoT reads the secret as a string.