CfnClusterPropsMixin

class aws_cdk.mixins_preview.aws_msk.mixins.CfnClusterPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a new MSK cluster.

See:

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

CloudformationResource:

AWS::MSK::Cluster

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

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

cfn_cluster_props_mixin = msk_mixins.CfnClusterPropsMixin(msk_mixins.CfnClusterMixinProps(
    broker_node_group_info=msk_mixins.CfnClusterPropsMixin.BrokerNodeGroupInfoProperty(
        broker_az_distribution="brokerAzDistribution",
        client_subnets=["clientSubnets"],
        connectivity_info=msk_mixins.CfnClusterPropsMixin.ConnectivityInfoProperty(
            public_access=msk_mixins.CfnClusterPropsMixin.PublicAccessProperty(
                type="type"
            ),
            vpc_connectivity=msk_mixins.CfnClusterPropsMixin.VpcConnectivityProperty(
                client_authentication=msk_mixins.CfnClusterPropsMixin.VpcConnectivityClientAuthenticationProperty(
                    sasl=msk_mixins.CfnClusterPropsMixin.VpcConnectivitySaslProperty(
                        iam=msk_mixins.CfnClusterPropsMixin.VpcConnectivityIamProperty(
                            enabled=False
                        ),
                        scram=msk_mixins.CfnClusterPropsMixin.VpcConnectivityScramProperty(
                            enabled=False
                        )
                    ),
                    tls=msk_mixins.CfnClusterPropsMixin.VpcConnectivityTlsProperty(
                        enabled=False
                    )
                )
            )
        ),
        instance_type="instanceType",
        security_groups=["securityGroups"],
        storage_info=msk_mixins.CfnClusterPropsMixin.StorageInfoProperty(
            ebs_storage_info=msk_mixins.CfnClusterPropsMixin.EBSStorageInfoProperty(
                provisioned_throughput=msk_mixins.CfnClusterPropsMixin.ProvisionedThroughputProperty(
                    enabled=False,
                    volume_throughput=123
                ),
                volume_size=123
            )
        )
    ),
    client_authentication=msk_mixins.CfnClusterPropsMixin.ClientAuthenticationProperty(
        sasl=msk_mixins.CfnClusterPropsMixin.SaslProperty(
            iam=msk_mixins.CfnClusterPropsMixin.IamProperty(
                enabled=False
            ),
            scram=msk_mixins.CfnClusterPropsMixin.ScramProperty(
                enabled=False
            )
        ),
        tls=msk_mixins.CfnClusterPropsMixin.TlsProperty(
            certificate_authority_arn_list=["certificateAuthorityArnList"],
            enabled=False
        ),
        unauthenticated=msk_mixins.CfnClusterPropsMixin.UnauthenticatedProperty(
            enabled=False
        )
    ),
    cluster_name="clusterName",
    configuration_info=msk_mixins.CfnClusterPropsMixin.ConfigurationInfoProperty(
        arn="arn",
        revision=123
    ),
    current_version="currentVersion",
    encryption_info=msk_mixins.CfnClusterPropsMixin.EncryptionInfoProperty(
        encryption_at_rest=msk_mixins.CfnClusterPropsMixin.EncryptionAtRestProperty(
            data_volume_kms_key_id="dataVolumeKmsKeyId"
        ),
        encryption_in_transit=msk_mixins.CfnClusterPropsMixin.EncryptionInTransitProperty(
            client_broker="clientBroker",
            in_cluster=False
        )
    ),
    enhanced_monitoring="enhancedMonitoring",
    kafka_version="kafkaVersion",
    logging_info=msk_mixins.CfnClusterPropsMixin.LoggingInfoProperty(
        broker_logs=msk_mixins.CfnClusterPropsMixin.BrokerLogsProperty(
            cloud_watch_logs=msk_mixins.CfnClusterPropsMixin.CloudWatchLogsProperty(
                enabled=False,
                log_group="logGroup"
            ),
            firehose=msk_mixins.CfnClusterPropsMixin.FirehoseProperty(
                delivery_stream="deliveryStream",
                enabled=False
            ),
            s3=msk_mixins.CfnClusterPropsMixin.S3Property(
                bucket="bucket",
                enabled=False,
                prefix="prefix"
            )
        )
    ),
    number_of_broker_nodes=123,
    open_monitoring=msk_mixins.CfnClusterPropsMixin.OpenMonitoringProperty(
        prometheus=msk_mixins.CfnClusterPropsMixin.PrometheusProperty(
            jmx_exporter=msk_mixins.CfnClusterPropsMixin.JmxExporterProperty(
                enabled_in_broker=False
            ),
            node_exporter=msk_mixins.CfnClusterPropsMixin.NodeExporterProperty(
                enabled_in_broker=False
            )
        )
    ),
    rebalancing=msk_mixins.CfnClusterPropsMixin.RebalancingProperty(
        status="status"
    ),
    storage_mode="storageMode",
    tags={
        "tags_key": "tags"
    }
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::MSK::Cluster.

Parameters:

  • props (Union[CfnClusterMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['brokerNodeGroupInfo', 'clientAuthentication', 'clusterName', 'configurationInfo', 'currentVersion', 'encryptionInfo', 'enhancedMonitoring', 'kafkaVersion', 'loggingInfo', 'numberOfBrokerNodes', 'openMonitoring', 'rebalancing', 'storageMode', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

BrokerLogsProperty

class CfnClusterPropsMixin.BrokerLogsProperty(*, cloud_watch_logs=None, firehose=None, s3=None)

Bases: object

The broker logs configuration for this MSK cluster.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

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

broker_logs_property = msk_mixins.CfnClusterPropsMixin.BrokerLogsProperty(
    cloud_watch_logs=msk_mixins.CfnClusterPropsMixin.CloudWatchLogsProperty(
        enabled=False,
        log_group="logGroup"
    ),
    firehose=msk_mixins.CfnClusterPropsMixin.FirehoseProperty(
        delivery_stream="deliveryStream",
        enabled=False
    ),
    s3=msk_mixins.CfnClusterPropsMixin.S3Property(
        bucket="bucket",
        enabled=False,
        prefix="prefix"
    )
)

Attributes

cloud_watch_logs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokerlogs.html#cfn-msk-cluster-brokerlogs-cloudwatchlogs

Type:

see

firehose

Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokerlogs.html#cfn-msk-cluster-brokerlogs-firehose

s3

Details of the Amazon S3 destination for broker logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokerlogs.html#cfn-msk-cluster-brokerlogs-s3

BrokerNodeGroupInfoProperty

class CfnClusterPropsMixin.BrokerNodeGroupInfoProperty(*, broker_az_distribution=None, client_subnets=None, connectivity_info=None, instance_type=None, security_groups=None, storage_info=None)

Bases: object

Describes the setup to be used for the broker nodes in the cluster.

Parameters:

  • broker_az_distribution (Optional[str]) – This parameter is currently not in use.

  • client_subnets (Optional[Sequence[str]]) – The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs to produce and consume data. If you use the US West (N. California) Region, specify exactly two subnets. For other Regions where Amazon MSK is available, you can specify either two or three subnets. The subnets that you specify must be in distinct Availability Zones. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify. Client subnets can’t occupy the Availability Zone with ID use1-az3 .

  • connectivity_info (Union[IResolvable, ConnectivityInfoProperty, Dict[str, Any], None]) – Information about the cluster’s connectivity setting.

  • instance_type (Optional[str]) – The type of Amazon EC2 instances to use for brokers. Depending on the broker type , Amazon MSK supports the following broker sizes: Standard broker sizes - kafka.t3.small .. epigraph:: You can’t select the kafka.t3.small instance type when the metadata mode is KRaft. - kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge - kafka.m7g.large, kafka.m7g.xlarge, kafka.m7g.2xlarge, kafka.m7g.4xlarge, kafka.m7g.8xlarge, kafka.m7g.12xlarge, kafka.m7g.16xlarge Express broker sizes - express.m7g.large, express.m7g.xlarge, express.m7g.2xlarge, express.m7g.4xlarge, express.m7g.8xlarge, express.m7g.12xlarge, express.m7g.16xlarge .. epigraph:: Some broker sizes might not be available in certian AWS Regions. See the updated Pricing tools section on the Amazon MSK pricing page for the latest list of available instances by Region.

  • security_groups (Optional[Sequence[str]]) – The security groups to associate with the ENIs in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don’t specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the ec2:DescribeSecurityGroups permission.

  • storage_info (Union[IResolvable, StorageInfoProperty, Dict[str, Any], None]) – Contains information about storage volumes attached to Amazon MSK broker nodes.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

broker_node_group_info_property = msk_mixins.CfnClusterPropsMixin.BrokerNodeGroupInfoProperty(
    broker_az_distribution="brokerAzDistribution",
    client_subnets=["clientSubnets"],
    connectivity_info=msk_mixins.CfnClusterPropsMixin.ConnectivityInfoProperty(
        public_access=msk_mixins.CfnClusterPropsMixin.PublicAccessProperty(
            type="type"
        ),
        vpc_connectivity=msk_mixins.CfnClusterPropsMixin.VpcConnectivityProperty(
            client_authentication=msk_mixins.CfnClusterPropsMixin.VpcConnectivityClientAuthenticationProperty(
                sasl=msk_mixins.CfnClusterPropsMixin.VpcConnectivitySaslProperty(
                    iam=msk_mixins.CfnClusterPropsMixin.VpcConnectivityIamProperty(
                        enabled=False
                    ),
                    scram=msk_mixins.CfnClusterPropsMixin.VpcConnectivityScramProperty(
                        enabled=False
                    )
                ),
                tls=msk_mixins.CfnClusterPropsMixin.VpcConnectivityTlsProperty(
                    enabled=False
                )
            )
        )
    ),
    instance_type="instanceType",
    security_groups=["securityGroups"],
    storage_info=msk_mixins.CfnClusterPropsMixin.StorageInfoProperty(
        ebs_storage_info=msk_mixins.CfnClusterPropsMixin.EBSStorageInfoProperty(
            provisioned_throughput=msk_mixins.CfnClusterPropsMixin.ProvisionedThroughputProperty(
                enabled=False,
                volume_throughput=123
            ),
            volume_size=123
        )
    )
)

Attributes

broker_az_distribution

This parameter is currently not in use.

See:

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

client_subnets

The list of subnets to connect to in the client virtual private cloud (VPC).

Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs to produce and consume data.

If you use the US West (N. California) Region, specify exactly two subnets. For other Regions where Amazon MSK is available, you can specify either two or three subnets. The subnets that you specify must be in distinct Availability Zones. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify.

Client subnets can’t occupy the Availability Zone with ID use1-az3 .

See:

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

connectivity_info

Information about the cluster’s connectivity setting.

See:

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

instance_type

The type of Amazon EC2 instances to use for brokers.

Depending on the broker type , Amazon MSK supports the following broker sizes:

Standard broker sizes

  • kafka.t3.small

You can’t select the kafka.t3.small instance type when the metadata mode is KRaft.

  • kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge

  • kafka.m7g.large, kafka.m7g.xlarge, kafka.m7g.2xlarge, kafka.m7g.4xlarge, kafka.m7g.8xlarge, kafka.m7g.12xlarge, kafka.m7g.16xlarge

Express broker sizes

  • express.m7g.large, express.m7g.xlarge, express.m7g.2xlarge, express.m7g.4xlarge, express.m7g.8xlarge, express.m7g.12xlarge, express.m7g.16xlarge

Some broker sizes might not be available in certian AWS Regions. See the updated Pricing tools section on the Amazon MSK pricing page for the latest list of available instances by Region.

See:

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

security_groups

The security groups to associate with the ENIs in order to specify who can connect to and communicate with the Amazon MSK cluster.

If you don’t specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the ec2:DescribeSecurityGroups permission.

See:

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

storage_info

Contains information about storage volumes attached to Amazon MSK broker nodes.

See:

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

ClientAuthenticationProperty

class CfnClusterPropsMixin.ClientAuthenticationProperty(*, sasl=None, tls=None, unauthenticated=None)

Bases: object

Parameters:

  • sasl (Union[IResolvable, SaslProperty, Dict[str, Any], None]) – 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.

  • tls (Union[IResolvable, TlsProperty, Dict[str, Any], None]) – 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 .

  • unauthenticated (Union[IResolvable, UnauthenticatedProperty, Dict[str, Any], None]) – Details for ClientAuthentication using no authentication.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

client_authentication_property = msk_mixins.CfnClusterPropsMixin.ClientAuthenticationProperty(
    sasl=msk_mixins.CfnClusterPropsMixin.SaslProperty(
        iam=msk_mixins.CfnClusterPropsMixin.IamProperty(
            enabled=False
        ),
        scram=msk_mixins.CfnClusterPropsMixin.ScramProperty(
            enabled=False
        )
    ),
    tls=msk_mixins.CfnClusterPropsMixin.TlsProperty(
        certificate_authority_arn_list=["certificateAuthorityArnList"],
        enabled=False
    ),
    unauthenticated=msk_mixins.CfnClusterPropsMixin.UnauthenticatedProperty(
        enabled=False
    )
)

Attributes

sasl

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.

See:

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

tls

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 .

See:

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

unauthenticated

Details for ClientAuthentication using no authentication.

See:

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

CloudWatchLogsProperty

class CfnClusterPropsMixin.CloudWatchLogsProperty(*, enabled=None, log_group=None)

Bases: object

Details of the CloudWatch Logs destination for broker logs.

Parameters:

  • enabled (Union[bool, IResolvable, None]) – Specifies whether broker logs get sent to the specified CloudWatch Logs destination.

  • log_group (Optional[str]) – The CloudWatch log group that is the destination for broker logs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cloud_watch_logs_property = msk_mixins.CfnClusterPropsMixin.CloudWatchLogsProperty(
    enabled=False,
    log_group="logGroup"
)

Attributes

enabled

Specifies whether broker logs get sent to the specified CloudWatch Logs destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-cloudwatchlogs.html#cfn-msk-cluster-cloudwatchlogs-enabled

log_group

The CloudWatch log group that is the destination for broker logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-cloudwatchlogs.html#cfn-msk-cluster-cloudwatchlogs-loggroup

ConfigurationInfoProperty

class CfnClusterPropsMixin.ConfigurationInfoProperty(*, arn=None, revision=None)

Bases: object

Specifies the configuration to use for the brokers.

Parameters:

  • arn (Optional[str]) – ARN of the configuration to use.

  • revision (Union[int, float, None]) – The revision of the configuration to use.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

configuration_info_property = msk_mixins.CfnClusterPropsMixin.ConfigurationInfoProperty(
    arn="arn",
    revision=123
)

Attributes

arn

ARN of the configuration to use.

See:

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

revision

The revision of the configuration to use.

See:

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

ConnectivityInfoProperty

class CfnClusterPropsMixin.ConnectivityInfoProperty(*, public_access=None, vpc_connectivity=None)

Bases: object

Broker access controls.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

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

connectivity_info_property = msk_mixins.CfnClusterPropsMixin.ConnectivityInfoProperty(
    public_access=msk_mixins.CfnClusterPropsMixin.PublicAccessProperty(
        type="type"
    ),
    vpc_connectivity=msk_mixins.CfnClusterPropsMixin.VpcConnectivityProperty(
        client_authentication=msk_mixins.CfnClusterPropsMixin.VpcConnectivityClientAuthenticationProperty(
            sasl=msk_mixins.CfnClusterPropsMixin.VpcConnectivitySaslProperty(
                iam=msk_mixins.CfnClusterPropsMixin.VpcConnectivityIamProperty(
                    enabled=False
                ),
                scram=msk_mixins.CfnClusterPropsMixin.VpcConnectivityScramProperty(
                    enabled=False
                )
            ),
            tls=msk_mixins.CfnClusterPropsMixin.VpcConnectivityTlsProperty(
                enabled=False
            )
        )
    )
)

Attributes

public_access

Access control settings for the cluster’s brokers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-connectivityinfo.html#cfn-msk-cluster-connectivityinfo-publicaccess

vpc_connectivity

VPC connection control settings for brokers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-connectivityinfo.html#cfn-msk-cluster-connectivityinfo-vpcconnectivity

EBSStorageInfoProperty

class CfnClusterPropsMixin.EBSStorageInfoProperty(*, provisioned_throughput=None, volume_size=None)

Bases: object

Contains information about the EBS storage volumes attached to the broker nodes.

Parameters:

  • provisioned_throughput (Union[IResolvable, ProvisionedThroughputProperty, Dict[str, Any], None]) – EBS volume provisioned throughput information.

  • volume_size (Union[int, float, None]) – The size in GiB of the EBS volume for the data drive on each broker node.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

e_bSStorage_info_property = msk_mixins.CfnClusterPropsMixin.EBSStorageInfoProperty(
    provisioned_throughput=msk_mixins.CfnClusterPropsMixin.ProvisionedThroughputProperty(
        enabled=False,
        volume_throughput=123
    ),
    volume_size=123
)

Attributes

provisioned_throughput

EBS volume provisioned throughput information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-ebsstorageinfo.html#cfn-msk-cluster-ebsstorageinfo-provisionedthroughput

volume_size

The size in GiB of the EBS volume for the data drive on each broker node.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-ebsstorageinfo.html#cfn-msk-cluster-ebsstorageinfo-volumesize

EncryptionAtRestProperty

class CfnClusterPropsMixin.EncryptionAtRestProperty(*, data_volume_kms_key_id=None)

Bases: object

The data-volume encryption details.

You can’t update encryption at rest settings for existing clusters.

Parameters:

data_volume_kms_key_id (Optional[str]) – The ARN of the Amazon KMS key for encrypting data at rest. If you don’t specify a KMS key, MSK creates one for you and uses it.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

encryption_at_rest_property = msk_mixins.CfnClusterPropsMixin.EncryptionAtRestProperty(
    data_volume_kms_key_id="dataVolumeKmsKeyId"
)

Attributes

data_volume_kms_key_id

The ARN of the Amazon KMS key for encrypting data at rest.

If you don’t specify a KMS key, MSK creates one for you and uses it.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionatrest.html#cfn-msk-cluster-encryptionatrest-datavolumekmskeyid

EncryptionInTransitProperty

class CfnClusterPropsMixin.EncryptionInTransitProperty(*, client_broker=None, in_cluster=None)

Bases: object

The settings for encrypting data in transit.

Parameters:

  • client_broker (Optional[str]) – Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values. - TLS : Indicates that client-broker communication is enabled with TLS only. - TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. - PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only. The default value is TLS .

  • in_cluster (Union[bool, IResolvable, None]) – When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

encryption_in_transit_property = msk_mixins.CfnClusterPropsMixin.EncryptionInTransitProperty(
    client_broker="clientBroker",
    in_cluster=False
)

Attributes

client_broker

Indicates the encryption setting for data in transit between clients and brokers.

You must set it to one of the following values.

  • TLS : Indicates that client-broker communication is enabled with TLS only.

  • TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

  • PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

The default value is TLS .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionintransit.html#cfn-msk-cluster-encryptionintransit-clientbroker

in_cluster

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted.

When set to false, the communication happens in plaintext.

The default value is true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-encryptionintransit.html#cfn-msk-cluster-encryptionintransit-incluster

EncryptionInfoProperty

class CfnClusterPropsMixin.EncryptionInfoProperty(*, encryption_at_rest=None, encryption_in_transit=None)

Bases: object

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.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

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

encryption_info_property = msk_mixins.CfnClusterPropsMixin.EncryptionInfoProperty(
    encryption_at_rest=msk_mixins.CfnClusterPropsMixin.EncryptionAtRestProperty(
        data_volume_kms_key_id="dataVolumeKmsKeyId"
    ),
    encryption_in_transit=msk_mixins.CfnClusterPropsMixin.EncryptionInTransitProperty(
        client_broker="clientBroker",
        in_cluster=False
    )
)

Attributes

encryption_at_rest

The data-volume encryption details.

See:

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

encryption_in_transit

The details for encryption in transit.

See:

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

FirehoseProperty

class CfnClusterPropsMixin.FirehoseProperty(*, delivery_stream=None, enabled=None)

Bases: object

Firehose details for BrokerLogs.

Parameters:

  • delivery_stream (Optional[str]) – The Kinesis Data Firehose delivery stream that is the destination for broker logs.

  • enabled (Union[bool, IResolvable, None]) – Specifies whether broker logs get send to the specified Kinesis Data Firehose delivery stream.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

firehose_property = msk_mixins.CfnClusterPropsMixin.FirehoseProperty(
    delivery_stream="deliveryStream",
    enabled=False
)

Attributes

delivery_stream

The Kinesis Data Firehose delivery stream that is the destination for broker logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-firehose.html#cfn-msk-cluster-firehose-deliverystream

enabled

Specifies whether broker logs get send to the specified Kinesis Data Firehose delivery stream.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-firehose.html#cfn-msk-cluster-firehose-enabled

IamProperty

class CfnClusterPropsMixin.IamProperty(*, enabled=None)

Bases: object

Details for SASL/IAM client authentication.

Parameters:

enabled (Union[bool, IResolvable, None]) – SASL/IAM authentication is enabled or not.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

iam_property = msk_mixins.CfnClusterPropsMixin.IamProperty(
    enabled=False
)

Attributes

enabled

SASL/IAM authentication is enabled or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-iam.html#cfn-msk-cluster-iam-enabled

JmxExporterProperty

class CfnClusterPropsMixin.JmxExporterProperty(*, enabled_in_broker=None)

Bases: object

Indicates whether you want to enable or disable the JMX Exporter.

Parameters:

enabled_in_broker (Union[bool, IResolvable, None]) – Indicates whether you want to enable or disable the JMX Exporter.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

jmx_exporter_property = msk_mixins.CfnClusterPropsMixin.JmxExporterProperty(
    enabled_in_broker=False
)

Attributes

enabled_in_broker

Indicates whether you want to enable or disable the JMX Exporter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-jmxexporter.html#cfn-msk-cluster-jmxexporter-enabledinbroker

LoggingInfoProperty

class CfnClusterPropsMixin.LoggingInfoProperty(*, broker_logs=None)

Bases: object

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

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

Parameters:

broker_logs (Union[IResolvable, BrokerLogsProperty, Dict[str, Any], None]) – You can configure your MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

logging_info_property = msk_mixins.CfnClusterPropsMixin.LoggingInfoProperty(
    broker_logs=msk_mixins.CfnClusterPropsMixin.BrokerLogsProperty(
        cloud_watch_logs=msk_mixins.CfnClusterPropsMixin.CloudWatchLogsProperty(
            enabled=False,
            log_group="logGroup"
        ),
        firehose=msk_mixins.CfnClusterPropsMixin.FirehoseProperty(
            delivery_stream="deliveryStream",
            enabled=False
        ),
        s3=msk_mixins.CfnClusterPropsMixin.S3Property(
            bucket="bucket",
            enabled=False,
            prefix="prefix"
        )
    )
)

Attributes

broker_logs

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

This configuration specifies the details of these destinations.

See:

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

NodeExporterProperty

class CfnClusterPropsMixin.NodeExporterProperty(*, enabled_in_broker=None)

Bases: object

Indicates whether you want to enable or disable the Node Exporter.

Parameters:

enabled_in_broker (Union[bool, IResolvable, None]) – Indicates whether you want to enable or disable the Node Exporter.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

node_exporter_property = msk_mixins.CfnClusterPropsMixin.NodeExporterProperty(
    enabled_in_broker=False
)

Attributes

enabled_in_broker

Indicates whether you want to enable or disable the Node Exporter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-nodeexporter.html#cfn-msk-cluster-nodeexporter-enabledinbroker

OpenMonitoringProperty

class CfnClusterPropsMixin.OpenMonitoringProperty(*, prometheus=None)

Bases: object

JMX and Node monitoring for the MSK cluster.

Parameters:

prometheus (Union[IResolvable, PrometheusProperty, Dict[str, Any], None]) – Prometheus exporter settings.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

open_monitoring_property = msk_mixins.CfnClusterPropsMixin.OpenMonitoringProperty(
    prometheus=msk_mixins.CfnClusterPropsMixin.PrometheusProperty(
        jmx_exporter=msk_mixins.CfnClusterPropsMixin.JmxExporterProperty(
            enabled_in_broker=False
        ),
        node_exporter=msk_mixins.CfnClusterPropsMixin.NodeExporterProperty(
            enabled_in_broker=False
        )
    )
)

Attributes

prometheus

Prometheus exporter settings.

See:

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

PrometheusProperty

class CfnClusterPropsMixin.PrometheusProperty(*, jmx_exporter=None, node_exporter=None)

Bases: object

Prometheus settings for open monitoring.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

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

prometheus_property = msk_mixins.CfnClusterPropsMixin.PrometheusProperty(
    jmx_exporter=msk_mixins.CfnClusterPropsMixin.JmxExporterProperty(
        enabled_in_broker=False
    ),
    node_exporter=msk_mixins.CfnClusterPropsMixin.NodeExporterProperty(
        enabled_in_broker=False
    )
)

Attributes

jmx_exporter

Indicates whether you want to enable or disable the JMX Exporter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-prometheus.html#cfn-msk-cluster-prometheus-jmxexporter

node_exporter

Indicates whether you want to enable or disable the Node Exporter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-prometheus.html#cfn-msk-cluster-prometheus-nodeexporter

ProvisionedThroughputProperty

class CfnClusterPropsMixin.ProvisionedThroughputProperty(*, enabled=None, volume_throughput=None)

Bases: object

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

Parameters:

  • enabled (Union[bool, IResolvable, None]) – Provisioned throughput is on or off.

  • volume_throughput (Union[int, float, None]) – Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

provisioned_throughput_property = msk_mixins.CfnClusterPropsMixin.ProvisionedThroughputProperty(
    enabled=False,
    volume_throughput=123
)

Attributes

enabled

Provisioned throughput is on or off.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-provisionedthroughput.html#cfn-msk-cluster-provisionedthroughput-enabled

volume_throughput

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-provisionedthroughput.html#cfn-msk-cluster-provisionedthroughput-volumethroughput

PublicAccessProperty

class CfnClusterPropsMixin.PublicAccessProperty(*, type=None)

Bases: object

Broker access controls.

Parameters:

type (Optional[str]) – DISABLED means that public access is turned off. SERVICE_PROVIDED_EIPS means that public access is turned on.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

public_access_property = msk_mixins.CfnClusterPropsMixin.PublicAccessProperty(
    type="type"
)

Attributes

type

DISABLED means that public access is turned off.

SERVICE_PROVIDED_EIPS means that public access is turned on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-publicaccess.html#cfn-msk-cluster-publicaccess-type

RebalancingProperty

class CfnClusterPropsMixin.RebalancingProperty(*, status=None)

Bases: object

Parameters:

status (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

rebalancing_property = msk_mixins.CfnClusterPropsMixin.RebalancingProperty(
    status="status"
)

Attributes

status

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-rebalancing.html#cfn-msk-cluster-rebalancing-status

Type:

see

S3Property

class CfnClusterPropsMixin.S3Property(*, bucket=None, enabled=None, prefix=None)

Bases: object

The details of the Amazon S3 destination for broker logs.

Parameters:

  • bucket (Optional[str]) – The name of the S3 bucket that is the destination for broker logs.

  • enabled (Union[bool, IResolvable, None]) – Specifies whether broker logs get sent to the specified Amazon S3 destination.

  • prefix (Optional[str]) – The S3 prefix that is the destination for broker logs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

s3_property = msk_mixins.CfnClusterPropsMixin.S3Property(
    bucket="bucket",
    enabled=False,
    prefix="prefix"
)

Attributes

bucket

The name of the S3 bucket that is the destination for broker logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-s3.html#cfn-msk-cluster-s3-bucket

enabled

Specifies whether broker logs get sent to the specified Amazon S3 destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-s3.html#cfn-msk-cluster-s3-enabled

prefix

The S3 prefix that is the destination for broker logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-s3.html#cfn-msk-cluster-s3-prefix

SaslProperty

class CfnClusterPropsMixin.SaslProperty(*, iam=None, scram=None)

Bases: object

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.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

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

sasl_property = msk_mixins.CfnClusterPropsMixin.SaslProperty(
    iam=msk_mixins.CfnClusterPropsMixin.IamProperty(
        enabled=False
    ),
    scram=msk_mixins.CfnClusterPropsMixin.ScramProperty(
        enabled=False
    )
)

Attributes

iam

Details for ClientAuthentication using IAM.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-sasl.html#cfn-msk-cluster-sasl-iam

scram

Details for SASL/SCRAM client authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-sasl.html#cfn-msk-cluster-sasl-scram

ScramProperty

class CfnClusterPropsMixin.ScramProperty(*, enabled=None)

Bases: object

Details for SASL/SCRAM client authentication.

Parameters:

enabled (Union[bool, IResolvable, None]) – SASL/SCRAM authentication is enabled or not.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

scram_property = msk_mixins.CfnClusterPropsMixin.ScramProperty(
    enabled=False
)

Attributes

enabled

SASL/SCRAM authentication is enabled or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-scram.html#cfn-msk-cluster-scram-enabled

StorageInfoProperty

class CfnClusterPropsMixin.StorageInfoProperty(*, ebs_storage_info=None)

Bases: object

Contains information about storage volumes attached to Amazon MSK broker nodes.

Parameters:

ebs_storage_info (Union[IResolvable, EBSStorageInfoProperty, Dict[str, Any], None]) – EBS volume information.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

storage_info_property = msk_mixins.CfnClusterPropsMixin.StorageInfoProperty(
    ebs_storage_info=msk_mixins.CfnClusterPropsMixin.EBSStorageInfoProperty(
        provisioned_throughput=msk_mixins.CfnClusterPropsMixin.ProvisionedThroughputProperty(
            enabled=False,
            volume_throughput=123
        ),
        volume_size=123
    )
)

Attributes

ebs_storage_info

EBS volume information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-storageinfo.html#cfn-msk-cluster-storageinfo-ebsstorageinfo

TlsProperty

class CfnClusterPropsMixin.TlsProperty(*, certificate_authority_arn_list=None, enabled=None)

Bases: object

Details for client authentication using TLS.

Parameters:

  • certificate_authority_arn_list (Optional[Sequence[str]]) – List of AWS Private CA ARNs.

  • enabled (Union[bool, IResolvable, None]) – TLS authentication is enabled or not.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

tls_property = msk_mixins.CfnClusterPropsMixin.TlsProperty(
    certificate_authority_arn_list=["certificateAuthorityArnList"],
    enabled=False
)

Attributes

certificate_authority_arn_list

List of AWS Private CA ARNs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-tls.html#cfn-msk-cluster-tls-certificateauthorityarnlist

enabled

TLS authentication is enabled or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-tls.html#cfn-msk-cluster-tls-enabled

UnauthenticatedProperty

class CfnClusterPropsMixin.UnauthenticatedProperty(*, enabled=None)

Bases: object

Details for allowing no client authentication.

Parameters:

enabled (Union[bool, IResolvable, None]) – Unauthenticated is enabled or not.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

unauthenticated_property = msk_mixins.CfnClusterPropsMixin.UnauthenticatedProperty(
    enabled=False
)

Attributes

enabled

Unauthenticated is enabled or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-unauthenticated.html#cfn-msk-cluster-unauthenticated-enabled

VpcConnectivityClientAuthenticationProperty

class CfnClusterPropsMixin.VpcConnectivityClientAuthenticationProperty(*, sasl=None, tls=None)

Bases: object

Includes all client authentication information for VpcConnectivity.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

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

vpc_connectivity_client_authentication_property = msk_mixins.CfnClusterPropsMixin.VpcConnectivityClientAuthenticationProperty(
    sasl=msk_mixins.CfnClusterPropsMixin.VpcConnectivitySaslProperty(
        iam=msk_mixins.CfnClusterPropsMixin.VpcConnectivityIamProperty(
            enabled=False
        ),
        scram=msk_mixins.CfnClusterPropsMixin.VpcConnectivityScramProperty(
            enabled=False
        )
    ),
    tls=msk_mixins.CfnClusterPropsMixin.VpcConnectivityTlsProperty(
        enabled=False
    )
)

Attributes

sasl

Details for VpcConnectivity ClientAuthentication using SASL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityclientauthentication.html#cfn-msk-cluster-vpcconnectivityclientauthentication-sasl

tls

Details for VpcConnectivity ClientAuthentication using TLS.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityclientauthentication.html#cfn-msk-cluster-vpcconnectivityclientauthentication-tls

VpcConnectivityIamProperty

class CfnClusterPropsMixin.VpcConnectivityIamProperty(*, enabled=None)

Bases: object

Details for SASL/IAM client authentication for VpcConnectivity.

Parameters:

enabled (Union[bool, IResolvable, None]) – SASL/IAM authentication is enabled or not.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

vpc_connectivity_iam_property = msk_mixins.CfnClusterPropsMixin.VpcConnectivityIamProperty(
    enabled=False
)

Attributes

enabled

SASL/IAM authentication is enabled or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityiam.html#cfn-msk-cluster-vpcconnectivityiam-enabled

VpcConnectivityProperty

class CfnClusterPropsMixin.VpcConnectivityProperty(*, client_authentication=None)

Bases: object

VPC connection control settings for brokers.

Parameters:

client_authentication (Union[IResolvable, VpcConnectivityClientAuthenticationProperty, Dict[str, Any], None]) – VPC connection control settings for brokers.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

vpc_connectivity_property = msk_mixins.CfnClusterPropsMixin.VpcConnectivityProperty(
    client_authentication=msk_mixins.CfnClusterPropsMixin.VpcConnectivityClientAuthenticationProperty(
        sasl=msk_mixins.CfnClusterPropsMixin.VpcConnectivitySaslProperty(
            iam=msk_mixins.CfnClusterPropsMixin.VpcConnectivityIamProperty(
                enabled=False
            ),
            scram=msk_mixins.CfnClusterPropsMixin.VpcConnectivityScramProperty(
                enabled=False
            )
        ),
        tls=msk_mixins.CfnClusterPropsMixin.VpcConnectivityTlsProperty(
            enabled=False
        )
    )
)

Attributes

client_authentication

VPC connection control settings for brokers.

See:

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

VpcConnectivitySaslProperty

class CfnClusterPropsMixin.VpcConnectivitySaslProperty(*, iam=None, scram=None)

Bases: object

Details for client authentication using SASL for VpcConnectivity.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

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

vpc_connectivity_sasl_property = msk_mixins.CfnClusterPropsMixin.VpcConnectivitySaslProperty(
    iam=msk_mixins.CfnClusterPropsMixin.VpcConnectivityIamProperty(
        enabled=False
    ),
    scram=msk_mixins.CfnClusterPropsMixin.VpcConnectivityScramProperty(
        enabled=False
    )
)

Attributes

iam

Details for ClientAuthentication using IAM for VpcConnectivity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitysasl.html#cfn-msk-cluster-vpcconnectivitysasl-iam

scram

Details for SASL/SCRAM client authentication for VpcConnectivity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitysasl.html#cfn-msk-cluster-vpcconnectivitysasl-scram

VpcConnectivityScramProperty

class CfnClusterPropsMixin.VpcConnectivityScramProperty(*, enabled=None)

Bases: object

Details for SASL/SCRAM client authentication for VpcConnectivity.

Parameters:

enabled (Union[bool, IResolvable, None]) – SASL/SCRAM authentication is enabled or not.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

vpc_connectivity_scram_property = msk_mixins.CfnClusterPropsMixin.VpcConnectivityScramProperty(
    enabled=False
)

Attributes

enabled

SASL/SCRAM authentication is enabled or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityscram.html#cfn-msk-cluster-vpcconnectivityscram-enabled

VpcConnectivityTlsProperty

class CfnClusterPropsMixin.VpcConnectivityTlsProperty(*, enabled=None)

Bases: object

Details for client authentication using TLS for VpcConnectivity.

Parameters:

enabled (Union[bool, IResolvable, None]) – TLS authentication is enabled or not.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

vpc_connectivity_tls_property = msk_mixins.CfnClusterPropsMixin.VpcConnectivityTlsProperty(
    enabled=False
)

Attributes

enabled

TLS authentication is enabled or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitytls.html#cfn-msk-cluster-vpcconnectivitytls-enabled