@aws-cdk_aws-msk-alpha.SaslAuthProps

interface SaslAuthProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.MSK.Alpha.SaslAuthProps
Gogithub.com/aws/aws-cdk-go/awscdkmskalpha/v2#SaslAuthProps
Javasoftware.amazon.awscdk.services.msk.alpha.SaslAuthProps
Pythonaws_cdk.aws_msk_alpha.SaslAuthProps
TypeScript (source)@aws-cdk/aws-msk-alpha ยป SaslAuthProps

SASL authentication properties.

Example

declare const vpc: ec2.Vpc;
const cluster = new msk.Cluster(this, 'cluster', {
  clusterName: 'myCluster',
  kafkaVersion: msk.KafkaVersion.V2_8_1,
  vpc,
  encryptionInTransit: {
    clientBroker: msk.ClientBrokerEncryption.TLS,
  },
  clientAuthentication: msk.ClientAuthentication.sasl({
    scram: true,
  }),
});

Properties

NameTypeDescription
iam?๐Ÿ”นbooleanEnable IAM access control.
key?๐Ÿ”นIKeyKMS Key to encrypt SASL/SCRAM secrets.
scram?๐Ÿ”นbooleanEnable SASL/SCRAM authentication.

iam?๐Ÿ”น

Type: boolean (optional, default: false)

Enable IAM access control.


key?๐Ÿ”น

Type: IKey (optional, default: CMK will be created with alias msk/{clusterName}/sasl/scram)

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.


scram?๐Ÿ”น

Type: boolean (optional, default: false)

Enable SASL/SCRAM authentication.