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(value=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
         .key("key")
         .partition("partition")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 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 Detail

getClientProperties

@Stability(value=Stable)
 @NotNull
Object getClientProperties()

Properties of the Apache Kafka producer client.

getDestinationArn

@Stability(value=Stable)
 @NotNull
String getDestinationArn()

The ARN of Kafka action's VPC `TopicRuleDestination` .

getTopic

@Stability(value=Stable)
 @NotNull
String getTopic()

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

getKey

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

The Kafka message key.

getPartition

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

The Kafka message partition.

builder

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

Returns:

a CfnTopicRule.KafkaActionProperty.Builder of CfnTopicRule.KafkaActionProperty