Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.KafkaActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.KafkaActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(Stable)
public static interface CfnTopicRule.KafkaActionProperty
extends software.amazon.jsii.JsiiSerializable

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

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.*;
 KafkaActionProperty kafkaActionProperty = KafkaActionProperty.builder()
         .clientProperties(Map.of(
                 "clientPropertiesKey", "clientProperties"))
         .destinationArn("destinationArn")
         .topic("topic")
         // the properties below are optional
         .headers(List.of(KafkaActionHeaderProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .key("key")
         .partition("partition")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.KafkaActionProperty.Builder	builder()
Object	getClientProperties()	Properties of the Apache Kafka producer client.
String	getDestinationArn()	The ARN of Kafka action's VPC TopicRuleDestination .
default Object	getHeaders()	The list of Kafka headers that you specify.
default String	getKey()	The Kafka message key.
default String	getPartition()	The Kafka message partition.
String	getTopic()	The Kafka topic for messages to be sent to the Kafka broker.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientProperties

@Stability(Stable)
@NotNull
Object getClientProperties()

Properties of the Apache Kafka producer client.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-clientproperties

getDestinationArn

@Stability(Stable)
@NotNull
String getDestinationArn()

The ARN of Kafka action's VPC TopicRuleDestination .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-destinationarn

getTopic

@Stability(Stable)
@NotNull
String getTopic()

The Kafka topic for messages to be sent to the Kafka broker.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-topic

getHeaders

@Stability(Stable)
@Nullable
default Object getHeaders()

The list of Kafka headers that you specify.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-headers

getKey

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

The Kafka message key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-key

getPartition

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

The Kafka message partition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html#cfn-iot-topicrule-kafkaaction-partition

builder

@Stability(Stable)
static CfnTopicRule.KafkaActionProperty.Builder builder()

Returns:

a CfnTopicRule.KafkaActionProperty.Builder of CfnTopicRule.KafkaActionProperty