Skip to main content

AmazonMSKConnectionService

Description

Provides and manages connections to AWS MSK Kafka Brokers for producer or consumer operations.

Tags

AWS, Kafka, MSK, Managed, Streaming

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Bootstrap Servers *bootstrap.serversComma-separated list of Kafka Bootstrap Servers in the format host:port. Corresponds to Kafka bootstrap.servers property
Security Protocol *security.protocolPLAINTEXT
  • PLAINTEXT
  • SSL
  • SASL_PLAINTEXT
  • SASL_SSL
Security protocol used to communicate with brokers. Corresponds to Kafka Client security.protocol property
SASL Mechanism *sasl.mechanismAWS_MSK_IAM
  • AWS_MSK_IAM
  • SCRAM-SHA-256
SASL mechanism used for authentication. Corresponds to Kafka Client sasl.mechanism property
AWS Profile Nameaws.profile.nameThe Amazon Web Services Profile to select when multiple profiles are available.

Supports Expression Language, using FlowFile attributes and Environment variables.

This property is only considered if:
  • the property SASL Mechanism has a value of AWS_MSK_IAM
SASL Username *sasl.usernameUsername provided with configured password when using PLAIN or SCRAM SASL Mechanisms

Supports Expression Language, using Environment variables.

This property is only considered if:
  • the property SASL Mechanism has a value of PLAIN or SCRAM-SHA-512 or SCRAM-SHA-256
SASL Password *sasl.passwordPassword provided with configured username when using PLAIN or SCRAM SASL Mechanisms

Supports Expression Language, using Environment variables.

This property is only considered if:
  • the property SASL Mechanism has a value of PLAIN or SCRAM-SHA-512 or SCRAM-SHA-256
SSL Context ServiceSSL Context ServiceController Service:
SSLContextService

Implementations:
StandardRestrictedSSLContextService
StandardSSLContextService
Service supporting SSL communication with Kafka brokers
Transaction Isolation Level *isolation.levelRead Committed
  • Read Committed
  • Read Uncommitted
Specifies how the service should handle transaction isolation levels when communicating with Kafka.
The uncommited option means that messages will be received as soon as they are written to Kafka but will be pulled, even if the producer cancels the transactions.
The committed option configures the service to not receive any messages for which the producer's transaction was canceled, but this can result in some latency since the
consumer must wait for the producer to finish its entire transaction instead of pulling as the messages become available.
Corresponds to Kafka isolation.level property.
Max Poll Records *max.poll.records10000Maximum number of records Kafka should return in a single poll.
Client Timeout *default.api.timeout.ms60 secDefault timeout for Kafka client operations. Mapped to Kafka default.api.timeout.ms. The Kafka request.timeout.ms property is derived from half of the configured timeout
Max Metadata Wait Time *max.block.ms5 secThe amount of time publisher will wait to obtain metadata or wait for the buffer to flush during the 'send' call before failing the
entire 'send' call. Corresponds to Kafka max.block.ms property

Supports Expression Language, using Environment variables.
Acknowledgment Wait Time *ack.wait.time5 secAfter sending a message to Kafka, this indicates the amount of time that the service will wait for a response from Kafka.
If Kafka does not acknowledge the message within this time period, the service will throw an exception.

State Management

This component does not store state.

Restricted

This component is not restricted.

System Resource Considerations

This component does not specify system resource considerations.

See Also