CfnClusterProps

class aws_cdk.aws_msk.CfnClusterProps(*, broker_node_group_info, cluster_name, kafka_version, number_of_broker_nodes, client_authentication=None, configuration_info=None, current_version=None, encryption_info=None, enhanced_monitoring=None, logging_info=None, open_monitoring=None, tags=None)

Bases: object

Properties for defining a CfnCluster.

Parameters
  • broker_node_group_info (Union[BrokerNodeGroupInfoProperty, Dict[str, Any], IResolvable]) – The setup to be used for brokers in the cluster. AWS CloudFormation may replace the cluster when you update certain BrokerNodeGroupInfo properties. To understand the update behavior for your use case, you should review the child properties for `BrokerNodeGroupInfo <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#aws-properties-msk-cluster-brokernodegroupinfo-properties>`_ .

  • cluster_name (str) – The name of the cluster.

  • kafka_version (str) – The version of Apache Kafka. For more information, see Supported Apache Kafka versions in the Amazon MSK Developer Guide.

  • number_of_broker_nodes (Union[int, float]) – The number of broker nodes you want in the Amazon MSK cluster. You can submit an update to increase the number of broker nodes in a cluster.

  • client_authentication (Union[IResolvable, ClientAuthenticationProperty, Dict[str, Any], None]) – Includes information related to client authentication.

  • configuration_info (Union[IResolvable, ConfigurationInfoProperty, Dict[str, Any], None]) – The Amazon MSK configuration to use for the cluster.

  • current_version (Optional[str]) – The version of the cluster that you want to update.

  • encryption_info (Union[IResolvable, EncryptionInfoProperty, Dict[str, Any], None]) – Includes all encryption-related information.

  • enhanced_monitoring (Optional[str]) – Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT , PER_BROKER , and PER_TOPIC_PER_BROKER .

  • logging_info (Union[IResolvable, LoggingInfoProperty, Dict[str, Any], None]) – You can configure your Amazon MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

  • open_monitoring (Union[IResolvable, OpenMonitoringProperty, Dict[str, Any], None]) – The settings for open monitoring.

  • tags (Optional[Mapping[str, str]]) – A map of key:value pairs to apply to this resource. Both key and value are of type String.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_msk as msk

cfn_cluster_props = msk.CfnClusterProps(
    broker_node_group_info=msk.CfnCluster.BrokerNodeGroupInfoProperty(
        client_subnets=["clientSubnets"],
        instance_type="instanceType",

        # the properties below are optional
        broker_az_distribution="brokerAzDistribution",
        connectivity_info=msk.CfnCluster.ConnectivityInfoProperty(
            public_access=msk.CfnCluster.PublicAccessProperty(
                type="type"
            )
        ),
        security_groups=["securityGroups"],
        storage_info=msk.CfnCluster.StorageInfoProperty(
            ebs_storage_info=msk.CfnCluster.EBSStorageInfoProperty(
                provisioned_throughput=msk.CfnCluster.ProvisionedThroughputProperty(
                    enabled=False,
                    volume_throughput=123
                ),
                volume_size=123
            )
        )
    ),
    cluster_name="clusterName",
    kafka_version="kafkaVersion",
    number_of_broker_nodes=123,

    # the properties below are optional
    client_authentication=msk.CfnCluster.ClientAuthenticationProperty(
        sasl=msk.CfnCluster.SaslProperty(
            iam=msk.CfnCluster.IamProperty(
                enabled=False
            ),
            scram=msk.CfnCluster.ScramProperty(
                enabled=False
            )
        ),
        tls=msk.CfnCluster.TlsProperty(
            certificate_authority_arn_list=["certificateAuthorityArnList"],
            enabled=False
        ),
        unauthenticated=msk.CfnCluster.UnauthenticatedProperty(
            enabled=False
        )
    ),
    configuration_info=msk.CfnCluster.ConfigurationInfoProperty(
        arn="arn",
        revision=123
    ),
    current_version="currentVersion",
    encryption_info=msk.CfnCluster.EncryptionInfoProperty(
        encryption_at_rest=msk.CfnCluster.EncryptionAtRestProperty(
            data_volume_kms_key_id="dataVolumeKmsKeyId"
        ),
        encryption_in_transit=msk.CfnCluster.EncryptionInTransitProperty(
            client_broker="clientBroker",
            in_cluster=False
        )
    ),
    enhanced_monitoring="enhancedMonitoring",
    logging_info=msk.CfnCluster.LoggingInfoProperty(
        broker_logs=msk.CfnCluster.BrokerLogsProperty(
            cloud_watch_logs=msk.CfnCluster.CloudWatchLogsProperty(
                enabled=False,

                # the properties below are optional
                log_group="logGroup"
            ),
            firehose=msk.CfnCluster.FirehoseProperty(
                enabled=False,

                # the properties below are optional
                delivery_stream="deliveryStream"
            ),
            s3=msk.CfnCluster.S3Property(
                enabled=False,

                # the properties below are optional
                bucket="bucket",
                prefix="prefix"
            )
        )
    ),
    open_monitoring=msk.CfnCluster.OpenMonitoringProperty(
        prometheus=msk.CfnCluster.PrometheusProperty(
            jmx_exporter=msk.CfnCluster.JmxExporterProperty(
                enabled_in_broker=False
            ),
            node_exporter=msk.CfnCluster.NodeExporterProperty(
                enabled_in_broker=False
            )
        )
    ),
    tags={
        "tags_key": "tags"
    }
)

Attributes

broker_node_group_info

The setup to be used for brokers in the cluster.

AWS CloudFormation may replace the cluster when you update certain BrokerNodeGroupInfo properties. To understand the update behavior for your use case, you should review the child properties for `BrokerNodeGroupInfo <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#aws-properties-msk-cluster-brokernodegroupinfo-properties>`_ .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-brokernodegroupinfo

Return type

Union[BrokerNodeGroupInfoProperty, IResolvable]

client_authentication

Includes information related to client authentication.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-clientauthentication

Return type

Union[IResolvable, ClientAuthenticationProperty, None]

cluster_name

The name of the cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-clustername

Return type

str

configuration_info

The Amazon MSK configuration to use for the cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-configurationinfo

Return type

Union[IResolvable, ConfigurationInfoProperty, None]

current_version

The version of the cluster that you want to update.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-currentversion

Return type

Optional[str]

encryption_info

Includes all encryption-related information.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-encryptioninfo

Return type

Union[IResolvable, EncryptionInfoProperty, None]

enhanced_monitoring

Specifies the level of monitoring for the MSK cluster.

The possible values are DEFAULT , PER_BROKER , and PER_TOPIC_PER_BROKER .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-enhancedmonitoring

Return type

Optional[str]

kafka_version

The version of Apache Kafka.

For more information, see Supported Apache Kafka versions in the Amazon MSK Developer Guide.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-kafkaversion

Return type

str

logging_info

You can configure your Amazon MSK cluster to send broker logs to different destination types.

This is a container for the configuration details related to broker logs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-logginginfo

Return type

Union[IResolvable, LoggingInfoProperty, None]

number_of_broker_nodes

The number of broker nodes you want in the Amazon MSK cluster.

You can submit an update to increase the number of broker nodes in a cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-numberofbrokernodes

Return type

Union[int, float]

open_monitoring

The settings for open monitoring.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-openmonitoring

Return type

Union[IResolvable, OpenMonitoringProperty, None]

tags

value pairs to apply to this resource.

Both key and value are of type String.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html#cfn-msk-cluster-tags

Type

A map of key

Return type

Optional[Mapping[str, str]]