Package software.amazon.awscdk.services.msk.alpha

Interface SaslAuthProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SaslTlsAuthProps

All Known Implementing Classes:

SaslAuthProps.Jsii$Proxy, SaslTlsAuthProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-15T14:52:10.243Z")
@Stability(Experimental)
public interface SaslAuthProps
extends software.amazon.jsii.JsiiSerializable

(experimental) SASL authentication properties.

Example:

 Vpc vpc;
 Cluster cluster = Cluster.Builder.create(this, "cluster")
         .clusterName("myCluster")
         .kafkaVersion(KafkaVersion.V4_0_X_KRAFT)
         .vpc(vpc)
         .encryptionInTransit(EncryptionInTransitConfig.builder()
                 .clientBroker(ClientBrokerEncryption.TLS)
                 .build())
         .clientAuthentication(ClientAuthentication.sasl(SaslAuthProps.builder()
                 .scram(true)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SaslAuthProps.Builder	A builder for SaslAuthProps
static final class	SaslAuthProps.Jsii$Proxy	An implementation for SaslAuthProps

Method Summary

Modifier and Type	Method	Description
static SaslAuthProps.Builder	builder()
default Boolean	getIam()	(experimental) Enable IAM access control.
default IKeyRef	getKey()	(experimental) KMS Key to encrypt SASL/SCRAM secrets.
default Boolean	getScram()	(experimental) Enable SASL/SCRAM authentication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIam

@Stability(Experimental)
@Nullable
default Boolean getIam()

(experimental) Enable IAM access control.

Default: false

getKey

@Stability(Experimental)
@Nullable
default IKeyRef getKey()

(experimental) KMS Key to encrypt SASL/SCRAM secrets.

You must use a customer master key (CMK) when creating users in secrets manager. You cannot use a Secret with Amazon MSK that uses the default Secrets Manager encryption key.

Default: - CMK will be created with alias msk/{clusterName}/sasl/scram

getScram

@Stability(Experimental)
@Nullable
default Boolean getScram()

(experimental) Enable SASL/SCRAM authentication.

Default: false

builder

@Stability(Experimental)
static SaslAuthProps.Builder builder()

Returns:

a SaslAuthProps.Builder of SaslAuthProps