AWS CDK Reference

Appearance

v2.273.0

ClientAuthentication Class ​

Configuration properties for client authentication.

Stability
Experimental
Source
lib/cluster.ts

Example ​

ts
import * as acmpca from 'aws-cdk-lib/aws-acmpca';

declare const vpc: ec2.Vpc;
const cluster = new msk.Cluster(this, 'Cluster', {
  clusterName: 'myCluster',
  kafkaVersion: msk.KafkaVersion.V4_1_X_KRAFT,
  vpc,
  encryptionInTransit: {
    clientBroker: msk.ClientBrokerEncryption.TLS,
  },
  clientAuthentication: msk.ClientAuthentication.tls({
    certificateAuthorities: [
      acmpca.CertificateAuthority.fromCertificateAuthorityArn(
        this,
        'CertificateAuthority',
        'arn:aws:acm-pca:us-west-2:1234567890:certificate-authority/11111111-1111-1111-1111-111111111111',
      ),
    ],
  }),
});

Properties ​

saslPropsSaslAuthPropssasl_propsSaslAuthPropssaslPropsSaslAuthPropsSaslPropsSaslAuthPropsSaslPropsSaslAuthProps#
- properties for SASL authentication.
tlsPropsTlsAuthPropstls_propsTlsAuthPropstlsPropsTlsAuthPropsTlsPropsTlsAuthPropsTlsPropsTlsAuthProps#
- properties for TLS authentication.

Methods ​

sasl(props: SaslAuthProps): ClientAuthentication // chainable@staticmethod def sasl(props: SaslAuthProps) -> ClientAuthenticationpublic static ClientAuthentication sasl(SaslAuthProps props)public static ClientAuthentication Sasl(SaslAuthProps props)func Sasl(Props SaslAuthProps) ClientAuthenticationstatic#
SASL authentication.
saslTls(saslTlsProps: SaslTlsAuthProps): ClientAuthentication // chainable@staticmethod def sasl_tls(sasl_tls_props: SaslTlsAuthProps) -> ClientAuthenticationpublic static ClientAuthentication saslTls(SaslTlsAuthProps saslTlsProps)public static ClientAuthentication SaslTls(SaslTlsAuthProps saslTlsProps)func SaslTls(SaslTlsProps SaslTlsAuthProps) ClientAuthenticationstatic#
SASL + TLS authentication.
tls(props: TlsAuthProps): ClientAuthentication // chainable@staticmethod def tls(props: TlsAuthProps) -> ClientAuthenticationpublic static ClientAuthentication tls(TlsAuthProps props)public static ClientAuthentication Tls(TlsAuthProps props)func Tls(Props TlsAuthProps) ClientAuthenticationstatic#
TLS authentication.