aws-cdk-lib.aws_msk

Amazon Managed Streaming for Apache Kafka Construct Library

This module is part of the AWS Cloud Development Kit project.

import * as msk from 'aws-cdk-lib/aws-msk';

import aws_cdk.aws_msk as msk

import software.amazon.awscdk.services.msk.*;

using Amazon.CDK.AWS.MSK;

import msk "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for MSK construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::MSK resources directly.

An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed as a separate package so that you can pin its version independently of the rest of the CDK. See the package:

<span class="package-reference">@aws-cdk/aws-msk-alpha</span>

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::MSK.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types

Name	Kind	Summary
CfnBatchScramSecret	Construct (L1)	Represents a secret stored in the AWS Secrets Manager that can be used to authenticate with a cluster using a user name and a password.
CfnChannel	Construct (L1)	Resource Type definition for AWS::MSK::Channel.
CfnCluster	Construct (L1)	Creates a new MSK cluster.
CfnClusterPolicy	Construct (L1)	Create or update cluster policy.
CfnConfiguration	Construct (L1)	Creates a new MSK configuration.
CfnReplicator	Construct (L1)	Creates the replicator.
CfnServerlessCluster	Construct (L1)	Specifies the properties required for creating a serverless cluster.
CfnTopic	Construct (L1)	Resource Type definition for AWS::MSK::Topic.
CfnVpcConnection	Construct (L1)	Create remote VPC connection.
CfnBatchScramSecretProps	Struct	Properties for defining a CfnBatchScramSecret.
CfnChannel.CatalogProperty	Struct	Catalog configuration of the destination.
CfnChannel.ChannelLoggingInfoProperty	Struct	Log configuration details for Channel.
CfnChannel.ChannelStateInfoProperty	Struct	Includes information about the channel state.
CfnChannel.CloudWatchLogsLogDestinationProperty	Struct	CloudWatch Logs log destination details.
CfnChannel.DeadLetterQueueS3Property	Struct	Dead letter queue S3 configuration of the destination.
CfnChannel.DestinationTableProperty	Struct	Destination table configuration.
CfnChannel.EncryptionConfigurationProperty	Struct	Encryption configuration.
CfnChannel.FirehoseLogDestinationProperty	Struct	Firehose log destination details.
CfnChannel.IcebergDestinationConfigurationProperty	Struct	Iceberg destination configuration.
CfnChannel.PartitionSourceProperty	Struct	Partition source configuration.
CfnChannel.PartitionSpecProperty	Struct	Partition specification.
CfnChannel.RecordConverterProperty	Struct	Record converter configuration for a topic.
CfnChannel.RecordSchemaProperty	Struct	Record schema configuration for a topic.
CfnChannel.S3DestinationConfigurationProperty	Struct	S3 destination configuration.
CfnChannel.S3LogDestinationProperty	Struct	S3 log destination details.
CfnChannel.S3StorageProperty	Struct	S3 storage configuration.
CfnChannel.SchemaEvolutionProperty	Struct	Schema evolution configuration of the destination.
CfnChannel.TableCreationProperty	Struct	Table creation configuration of the destination.
CfnChannel.TopicConfigurationProperty	Struct	Configuration of topic in a channel.
CfnChannelProps	Struct	Properties for defining a CfnChannel.
CfnCluster.AuthorizerLogsProperty	Struct
CfnCluster.BrokerLogsProperty	Struct	The broker logs configuration for this MSK cluster.
CfnCluster.BrokerNodeGroupInfoProperty	Struct	Describes the setup to be used for the broker nodes in the cluster.
CfnCluster.ClientAuthenticationProperty	Struct
CfnCluster.CloudWatchLogsProperty	Struct	Details of the CloudWatch Logs destination for broker logs.
CfnCluster.ConfigurationInfoProperty	Struct	Specifies the configuration to use for the brokers.
CfnCluster.ConnectivityInfoProperty	Struct	Broker access controls.
CfnCluster.EBSStorageInfoProperty	Struct	Contains information about the EBS storage volumes attached to the broker nodes.
CfnCluster.EncryptionAtRestProperty	Struct	The data-volume encryption details.
CfnCluster.EncryptionInfoProperty	Struct	Includes encryption-related information, such as the Amazon KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.
CfnCluster.EncryptionInTransitProperty	Struct	The settings for encrypting data in transit.
CfnCluster.FirehoseProperty	Struct	Firehose details for BrokerLogs.
CfnCluster.IamProperty	Struct	Details for SASL/IAM client authentication.
CfnCluster.JmxExporterProperty	Struct	Indicates whether you want to enable or disable the JMX Exporter.
CfnCluster.LoggingInfoProperty	Struct	You can configure your MSK cluster to send broker logs to different destination types.
CfnCluster.NodeExporterProperty	Struct	Indicates whether you want to enable or disable the Node Exporter.
CfnCluster.OpenMonitoringProperty	Struct	JMX and Node monitoring for the MSK cluster.
CfnCluster.PrometheusProperty	Struct	Prometheus settings for open monitoring.
CfnCluster.ProvisionedThroughputProperty	Struct	Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
CfnCluster.PublicAccessProperty	Struct	Broker access controls.
CfnCluster.RebalancingProperty	Struct
CfnCluster.S3Property	Struct	The details of the Amazon S3 destination for broker logs.
CfnCluster.SaslProperty	Struct	Details for client authentication using SASL.
CfnCluster.ScramProperty	Struct	Details for SASL/SCRAM client authentication.
CfnCluster.StorageInfoProperty	Struct	Contains information about storage volumes attached to Amazon MSK broker nodes.
CfnCluster.TlsProperty	Struct	Details for client authentication using TLS.
CfnCluster.UnauthenticatedProperty	Struct	Details for allowing no client authentication.
CfnCluster.VpcConnectivityClientAuthenticationProperty	Struct	Includes all client authentication information for VpcConnectivity.
CfnCluster.VpcConnectivityIamProperty	Struct	Details for SASL/IAM client authentication for VpcConnectivity.
CfnCluster.VpcConnectivityProperty	Struct	VPC connection control settings for brokers.
CfnCluster.VpcConnectivitySaslProperty	Struct	Details for client authentication using SASL for VpcConnectivity.
CfnCluster.VpcConnectivityScramProperty	Struct	Details for SASL/SCRAM client authentication for VpcConnectivity.
CfnCluster.VpcConnectivityTlsProperty	Struct	Details for client authentication using TLS for VpcConnectivity.
CfnCluster.ZookeeperAccessProperty	Struct
CfnClusterPolicyProps	Struct	Properties for defining a CfnClusterPolicy.
CfnClusterProps	Struct	Properties for defining a CfnCluster.
CfnConfiguration.LatestRevisionProperty	Struct	Describes a configuration revision.
CfnConfigurationProps	Struct	Properties for defining a CfnConfiguration.
CfnReplicator.AmazonMskClusterProperty	Struct	Details of an Amazon MSK Cluster.
CfnReplicator.ApacheKafkaClusterProperty	Struct	Details of an Apache Kafka cluster.
CfnReplicator.CloudWatchLogsProperty	Struct	Details about delivering logs to CloudWatch Logs.
CfnReplicator.ConsumerGroupReplicationProperty	Struct	Details about consumer group replication.
CfnReplicator.FirehoseProperty	Struct	Details about delivering logs to Firehose.
CfnReplicator.KafkaClusterClientAuthenticationProperty	Struct	Details of the client authentication used by the Apache Kafka cluster.
CfnReplicator.KafkaClusterClientVpcConfigProperty	Struct	Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
CfnReplicator.KafkaClusterEncryptionInTransitProperty	Struct	Details of encryption in transit to the Apache Kafka cluster.
CfnReplicator.KafkaClusterMtlsAuthenticationProperty	Struct	Details for mTLS client authentication.
CfnReplicator.KafkaClusterOAuthClientCredentialsAssertionProperty	Struct	Details for SASL/OAUTHBEARER using the client credentials grant with a JWT client assertion (RFC 7521/7523 Section 2.2). An STS-vended JWT is used as the client_assertion.
CfnReplicator.KafkaClusterOAuthClientCredentialsProperty	Struct	Details for SASL/OAUTHBEARER using the standard client_credentials grant.
CfnReplicator.KafkaClusterOAuthIamJwtBearerProperty	Struct	Details for SASL/OAUTHBEARER using the JWT Bearer assertion grant (RFC 7523).
CfnReplicator.KafkaClusterProperty	Struct	Information about Kafka Cluster to be used as source / target for replication.
CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty	Struct	Details for client authentication using SASL/OAUTHBEARER.
CfnReplicator.KafkaClusterSaslScramAuthenticationProperty	Struct	Details for SASL/SCRAM client authentication.
CfnReplicator.LogDeliveryProperty	Struct	Configuration for log delivery for the replicator.
CfnReplicator.ReplicationInfoProperty	Struct	Specifies configuration for replication between a source and target Kafka cluster.
CfnReplicator.ReplicationStartingPositionProperty	Struct	Specifies the position in the topics to start replicating from.
CfnReplicator.ReplicationTopicNameConfigurationProperty	Struct	Configuration for specifying replicated topic names will be the same as their corresponding upstream topics or prefixed with source cluster alias.
CfnReplicator.ReplicatorLogDeliveryProperty	Struct	Details of the log delivery for the replicator.
CfnReplicator.S3Property	Struct	Details about delivering logs to S3.
CfnReplicator.TopicReplicationProperty	Struct	Details about topic replication.
CfnReplicatorProps	Struct	Properties for defining a CfnReplicator.
CfnServerlessCluster.ClientAuthenticationProperty	Struct	Includes all client authentication information.
CfnServerlessCluster.IamProperty	Struct	Details for SASL/IAM client authentication.
CfnServerlessCluster.SaslProperty	Struct	Details for client authentication using SASL.
CfnServerlessCluster.VpcConfigProperty	Struct
CfnServerlessClusterProps	Struct	Properties for defining a CfnServerlessCluster.
CfnTopicProps	Struct	Properties for defining a CfnTopic.
CfnVpcConnectionProps	Struct	Properties for defining a CfnVpcConnection.