In this article
Overview
You can use this account type to connect Kafka Snaps with data sources that use Kafka MSK IAM Account.
Prerequisites
Kafka MSK Cluster Setup
IAM access control
Cross IAM role permissions
Limitations and Known Issues
None.
Account Settings
Asterisk ( * ): Indicates a mandatory field.
Suggestion icon ( ): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the field set.
Remove icon ( ): Indicates that you can remove fields from the field set.
Field Name | Field Type | Description | |
---|---|---|---|
Label* Default Value: Kafka MSK IAM Account | String | Specify a unique label for the account. | |
Bootstrap servers* | Use this field set to specify the ordered list of host-port pairs to establish an initial connection to the Kafka cluster. | ||
Bootstrap server Default Value: N/A b-1.kafka-cluster-name.abcde.c5.kafka.us-west-2.amazonaws.com:9092 | String/Expression | Specify a host-port pair that you use to establish an initial connection to the Kafka cluster. | |
Schema registry URL Default Value: N/A | String/Expression | Specify the URL for the schema registry server. | |
Advanced Kafka properties | Use this field set to specify any additional properties for connection to the Kafka server that are not explicitly provided in the Snap. These properties are directly passed to the Kafka server and not tested by SnapLogic, Inc. | ||
Key Default Value: N/A | String/Expression | Specify the key for the Kafka property that Snap does not explicitly support. | |
Value Default Value: N/A | Integer/Expression | Specify the value for the Kafka property that Snap does not explicitly support. | |
Security protocol Default Value: SASL_SSL | Select one of the following security protocols from the suggestions:
| ||
IAM Role Default Value: Deselected | Checkbox | Select this checkbox to use the IAM role associated with the EC2 instance to access the MSK cluster. This feature applies only to EC2-type Groundplexes. For the required configuration, refer to the IAM Access Control for Amazon Managed Streaming for Apache Kafka. | |
Cross account IAM properties | |||
AWS role ARN Default Value: N/A | String/Expression | Specify the ARN of the cross-account IAM role. This ARN defines the permissions and trust policies for assuming the role. | |
External ID Default Value: N/A | String/Expression | Specify the external ID to add an extra layer of security by preventing ‘confused deputy’ attacks. You must configure this field when a third party assumes the role. | |
AWS region Default Value: N/A | String/Expression | Specify the AWS region where the application is running.
| |
Session duration (seconds) Default Value: N/A | String/Expression | Specify the duration in seconds for which the assumed role session is valid.
| |
Session name Default Value: N/A | String/Expression | Specify an identifier for the assumed role session. This identifier helps to uniquely identify a session when the same role is assumed by different entities. |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Account validation failed. | The Pipeline ended before the batch could complete execution due to a connection error. | Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open. |
Related Links
Endpoint Doc Link 1
Endpoint Doc Link 2
Endpoint Doc Link 3