Package software.amazon.awscdk.services.msk

Interface CfnCluster.ClientAuthenticationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.ClientAuthenticationProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.ClientAuthenticationProperty
extends software.amazon.jsii.JsiiSerializable

Includes all client authentication information.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.msk.*;
 ClientAuthenticationProperty clientAuthenticationProperty = ClientAuthenticationProperty.builder()
         .sasl(SaslProperty.builder()
                 .iam(IamProperty.builder()
                         .enabled(false)
                         .build())
                 .scram(ScramProperty.builder()
                         .enabled(false)
                         .build())
                 .build())
         .tls(TlsProperty.builder()
                 .certificateAuthorityArnList(List.of("certificateAuthorityArnList"))
                 .enabled(false)
                 .build())
         .unauthenticated(UnauthenticatedProperty.builder()
                 .enabled(false)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCluster.ClientAuthenticationProperty.Builder	builder()
default Object	getSasl()	Details for client authentication using SASL.
default Object	getTls()	Details for ClientAuthentication using TLS.
default Object	getUnauthenticated()	Details for ClientAuthentication using no authentication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSasl

@Stability(Stable)
@Nullable
default Object getSasl()

Details for client authentication using SASL.

To turn on SASL, you must also turn on EncryptionInTransit by setting inCluster to true. You must set clientBroker to either TLS or TLS_PLAINTEXT . If you choose TLS_PLAINTEXT , then you must also set unauthenticated to true.

getTls

@Stability(Stable)
@Nullable
default Object getTls()

Details for ClientAuthentication using TLS.

To turn on TLS access control, you must also turn on EncryptionInTransit by setting inCluster to true and clientBroker to TLS .

getUnauthenticated

@Stability(Stable)
@Nullable
default Object getUnauthenticated()

Details for ClientAuthentication using no authentication.

builder

@Stability(Stable)
static CfnCluster.ClientAuthenticationProperty.Builder builder()

Returns:

a CfnCluster.ClientAuthenticationProperty.Builder of CfnCluster.ClientAuthenticationProperty