aws-cdk-lib.aws_iot.CfnTopicRule.KafkaActionProperty

interface KafkaActionProperty

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnTopicRule.KafkaActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnTopicRule_KafkaActionProperty
Javasoftware.amazon.awscdk.services.iot.CfnTopicRule.KafkaActionProperty
Pythonaws_cdk.aws_iot.CfnTopicRule.KafkaActionProperty
TypeScript aws-cdk-lib » aws_iot » CfnTopicRule » KafkaActionProperty

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 { aws_iot as iot } from 'aws-cdk-lib';
const kafkaActionProperty: iot.CfnTopicRule.KafkaActionProperty = {
  clientProperties: {
    clientPropertiesKey: 'clientProperties',
  },
  destinationArn: 'destinationArn',
  topic: 'topic',

  // the properties below are optional
  key: 'key',
  partition: 'partition',
};

Properties

NameTypeDescription
clientPropertiesIResolvable | { [string]: string }Properties of the Apache Kafka producer client.
destinationArnstringThe ARN of Kafka action's VPC TopicRuleDestination .
topicstringThe Kafka topic for messages to be sent to the Kafka broker.
key?stringThe Kafka message key.
partition?stringThe Kafka message partition.

clientProperties

Type: IResolvable | { [string]: string }

Properties of the Apache Kafka producer client.


destinationArn

Type: string

The ARN of Kafka action's VPC TopicRuleDestination .


topic

Type: string

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


key?

Type: string (optional)

The Kafka message key.


partition?

Type: string (optional)

The Kafka message partition.