Package software.amazon.awscdk.services.iot

Interface CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnTopicRuleDestination

@Stability(Stable)
public static interface CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 InfluxDBDestinationPropertiesProperty influxDBDestinationPropertiesProperty = InfluxDBDestinationPropertiesProperty.builder()
         .endpoint("endpoint")
         .influxDbVersion("influxDbVersion")
         .secretId("secretId")
         // the properties below are optional
         .secretKey("secretKey")
         .secretType("secretType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-influxdbdestinationproperties.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty.Builder	A builder for CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty
static final class	CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty.Jsii$Proxy	An implementation for CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty

Method Summary

Modifier and Type	Method	Description
static CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty.Builder	builder()
String	getEndpoint()	The endpoint URL of the InfluxDB database.
String	getInfluxDbVersion()	The version of the InfluxDB database (for example, V2 or V3).
String	getSecretId()	The ARN or name of the Secrets Manager secret containing the InfluxDB API token.
default String	getSecretKey()	The key name within the secret that contains the InfluxDB token.
default String	getSecretType()	The type of the secret value (SecretString or SecretBinary).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpoint

@Stability(Stable)
@NotNull
String getEndpoint()

The endpoint URL of the InfluxDB database.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-influxdbdestinationproperties.html#cfn-iot-topicruledestination-influxdbdestinationproperties-endpoint

getInfluxDbVersion

@Stability(Stable)
@NotNull
String getInfluxDbVersion()

The version of the InfluxDB database (for example, V2 or V3).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-influxdbdestinationproperties.html#cfn-iot-topicruledestination-influxdbdestinationproperties-influxdbversion

getSecretId

@Stability(Stable)
@NotNull
String getSecretId()

The ARN or name of the Secrets Manager secret containing the InfluxDB API token.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-influxdbdestinationproperties.html#cfn-iot-topicruledestination-influxdbdestinationproperties-secretid

getSecretKey

@Stability(Stable)
@Nullable
default String getSecretKey()

The key name within the secret that contains the InfluxDB token.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-influxdbdestinationproperties.html#cfn-iot-topicruledestination-influxdbdestinationproperties-secretkey

getSecretType

@Stability(Stable)
@Nullable
default String getSecretType()

The type of the secret value (SecretString or SecretBinary).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-influxdbdestinationproperties.html#cfn-iot-topicruledestination-influxdbdestinationproperties-secrettype

builder

@Stability(Stable)
static CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty.Builder builder()

Returns:

a CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty.Builder of CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty