software.amazon.awscdk.services.msk

Interface SaslAuthProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SaslAuthProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:11.379Z")
 @Stability(value=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.V2_8_1)
         .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 and Description
static class	SaslAuthProps.Builder A builder for SaslAuthProps
static class	SaslAuthProps.Jsii$Proxy An implementation for SaslAuthProps

Method Summary

Modifier and Type	Method and Description
static SaslAuthProps.Builder	builder()
default Boolean	getIam() (experimental) Enable IAM access control.
default IKey	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 Detail

getIam

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

(experimental) Enable IAM access control.

Default: false

getKey

@Stability(value=Experimental)
 @Nullable
default IKey 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(value=Experimental)
 @Nullable
default Boolean getScram()

(experimental) Enable SASL/SCRAM authentication.

Default: false

builder

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

Returns:

a SaslAuthProps.Builder of SaslAuthProps