AWS::IoT::TopicRule KafkaAction - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IoT::TopicRule KafkaAction

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ClientProperties" : {Key: Value, ...},
  "DestinationArn" : String,
  "Headers" : [ KafkaActionHeader, ... ],
  "Key" : String,
  "Partition" : String,
  "Topic" : String
}

YAML

  ClientProperties: 
    Key: Value
  DestinationArn: String
  Headers: 
    - KafkaActionHeader
  Key: String
  Partition: String
  Topic: String

Properties

ClientProperties

Properties of the Apache Kafka producer client.

Required: Yes

Type: Object of String

Pattern: .*

Update requires: No interruption

DestinationArn

The ARN of Kafka action's VPC TopicRuleDestination.

Required: Yes

Type: String

Update requires: No interruption

Headers

The list of Kafka headers that you specify.

Required: No

Type: Array of KafkaActionHeader

Update requires: No interruption

Key

The Kafka message key.

Required: No

Type: String

Update requires: No interruption

Partition

The Kafka message partition.

Required: No

Type: String

Update requires: No interruption

Topic

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

Required: Yes

Type: String

Update requires: No interruption