Skip navigation links

Package software.amazon.awscdk.services.msk

Amazon Managed Streaming for Apache Kafka Construct Library

See: Description

Package software.amazon.awscdk.services.msk Description

Amazon Managed Streaming for Apache Kafka Construct Library

Amazon MSK is a fully managed service that makes it easy for you to build and run applications that use Apache Kafka to process streaming data.

The following example creates an MSK Cluster. 

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.*;
 
 
 Object cluster = Cluster.Builder.create(this, "Cluster")
         .kafkaVersion(KafkaVersion.V2_8_1)
         .vpc(vpc)
         .build();

Allowing Connections

To control who can access the Cluster, use the .connections attribute. For a list of ports used by MSK, refer to the MSK documentation. 

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 
 
 Cluster cluster = Cluster.Builder.create(this, "Cluster")....build();
 
 cluster.connections.allowFrom(Peer.ipv4("1.2.3.4/8"), Port.tcp(2181));
 cluster.connections.allowFrom(Peer.ipv4("1.2.3.4/8"), Port.tcp(9094));

Cluster Endpoints

You can use the following attributes to get a list of the Kafka broker or ZooKeeper node endpoints 

 // Example automatically generated from non-compiling source. May contain errors.
 CfnOutput.Builder.create(this, "BootstrapBrokers").value(cluster.getBootstrapBrokers()).build();
 CfnOutput.Builder.create(this, "BootstrapBrokersTls").value(cluster.getBootstrapBrokersTls()).build();
 CfnOutput.Builder.create(this, "BootstrapBrokersSaslScram").value(cluster.getBootstrapBrokersSaslScram()).build();
 CfnOutput.Builder.create(this, "ZookeeperConnection").value(cluster.getZookeeperConnectionString()).build();
 CfnOutput.Builder.create(this, "ZookeeperConnectionTls").value(cluster.getZookeeperConnectionStringTls()).build();

Importing an existing Cluster

To import an existing MSK cluster into your CDK app use the .fromClusterArn() method. 

 // Example automatically generated from non-compiling source. May contain errors.
 Object cluster = msk.Cluster.fromClusterArn(this, "Cluster", "arn:aws:kafka:us-west-2:1234567890:cluster/a-cluster/11111111-1111-1111-1111-111111111111-1");

Client Authentication

MSK supports the following authentication mechanisms.

Only one authentication method can be enabled.

TLS

To enable client authentication with TLS set the certificateAuthorityArns property to reference your ACM Private CA. More info on Private CAs. 

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 
 
 Cluster cluster = new Cluster(this, "Cluster", ClusterProps.builder()
         (SpreadAssignment ...
             encryptionInTransit
           encryptionInTransit)
         .build(), Map.of(
         "clientBroker", ClientBrokerEncryption.TLS), clientAuthentication, ClientAuthentication.tls(TlsAuthProps.builder()
         .certificateAuthorities(List.of(CertificateAuthority.fromCertificateAuthorityArn(stack, "CertificateAuthority", "arn:aws:acm-pca:us-west-2:1234567890:certificate-authority/11111111-1111-1111-1111-111111111111")))
         .build()));

SASL/SCRAM

Enable client authentication with SASL/SCRAM: 

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.*;
 
 
 Object cluster = new cluster(this, "cluster", Map.of(
         (SpreadAssignment ...
           encryptionInTransit
           encryptionInTransit)), Map.of(
         "clientBroker", ClientBrokerEncryption.TLS), clientAuthentication, ClientAuthentication.sasl(SaslAuthProps.builder()
         .scram(true)
         .build()));

SASL/IAM

Enable client authentication with IAM: 

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.*;
 
 
 Object cluster = new cluster(this, "cluster", Map.of(
         (SpreadAssignment ...
           encryptionInTransit
           encryptionInTransit)), Map.of(
         "clientBroker", ClientBrokerEncryption.TLS), clientAuthentication, ClientAuthentication.sasl(SaslAuthProps.builder()
         .iam(true)
         .build()));
Skip navigation links

Copyright © 2022. All rights reserved.