Kafka MSK IAM Account
In this article
Overview
You can use this account type to connect Kafka Snaps with data sources that use the Kafka MSK IAM Account.
This account detects an IAM role in the environment and uses an IAM role assigned to an EC2 Groundplex. It also supports Amazon Elastic Container Service (ECS) and Amazon Elastic Kubernetes Service (EKS), both of which require additional configuration. Learn more. The IAM role either must have sufficient permissions to access the MSK cluster or can assume another IAM role with these permissions. If the role has sufficient permissions, then none of the Cross Account IAM fields need to be set.
Prerequisites
IAM access
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 to connect to the Kafka server 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 | ย String/Expression | Select one of the following security protocols from the suggestions:
| |
Cross account IAM properties | The IAM role either must have sufficient permissions to access the MSK cluster or can assume another IAM role with these permissions. If the role has sufficient permissions, then none of the Cross Account IAM fields need to be set. | ||
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. Learn more about ARNs. | |
External ID ย Default Value:ย N/A | String/Expression | Specify the external ID to add an extra layer of security by preventing โconfused deputyโ attacks. Learn more - confused deputy attacks. | |
AWS region ย Default Value:ย N/A | String/Expression | Specify the AWS region where the application is running. ย | |
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 different entities assume the same role. |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
| The Role ARN, External ID, or the session duration has incorrect information. | Ensure that the role configuration, ARN, external ID, and session duration are correct, check AWS service status, handle exceptions properly, and consult customer support if needed. |
Debugging IAM Permissions
The Kafka MSK IAM Account contains an IAM debug property, which, when enabled logs the IAM credential identity in the Snaplex log. To enable this property, you need to update the Snaplex configuration, specifically the logging level, and define a JVM system property.
On the Logging tab, set the logging level to Debug.
On the Node Properties tab, define a Global Property for JVM system properties as shown below or append a value to an existing property.
Key: jcc.jvm_options
Value: -Daws.msk.iam.debug=true
Restart the Snaplex node.
ย
Related information
Access from within AWS but outside cluster's VPC - Amazon Managed Streaming for Apache Kafka
IAM access control - Amazon Managed Streaming for Apache Kafka
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
ยฉ 2017-2024 SnapLogic, Inc.