CfnCluster

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

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::MSK::Cluster.

CloudformationResource

AWS::MSK::Cluster

Link

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

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

# tags is of type object

cfn_cluster = msk.CfnCluster(self, "MyCfnCluster",
    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(
                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
    ),
    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
)

Create a new AWS::MSK::Cluster.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::MSK::Cluster'
broker_node_group_info

AWS::MSK::Cluster.BrokerNodeGroupInfo.

Link

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

Return type

Union[BrokerNodeGroupInfoProperty, IResolvable]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

client_authentication

AWS::MSK::Cluster.ClientAuthentication.

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

AWS::MSK::Cluster.ClusterName.

Link

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

Return type

str

configuration_info

AWS::MSK::Cluster.ConfigurationInfo.

Link

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

Return type

Union[IResolvable, ConfigurationInfoProperty, None]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

encryption_info

AWS::MSK::Cluster.EncryptionInfo.

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

AWS::MSK::Cluster.EnhancedMonitoring.

Link

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

Return type

Optional[str]

kafka_version

AWS::MSK::Cluster.KafkaVersion.

Link

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

Return type

str

logging_info

AWS::MSK::Cluster.LoggingInfo.

Link

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

Return type

Union[IResolvable, LoggingInfoProperty, None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

number_of_broker_nodes

AWS::MSK::Cluster.NumberOfBrokerNodes.

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

AWS::MSK::Cluster.OpenMonitoring.

Link

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

Return type

Union[IResolvable, OpenMonitoringProperty, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::MSK::Cluster.Tags.

Link

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

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

BrokerLogsProperty

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

Bases: object

Parameters
Link

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

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

broker_logs_property = 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"
    )
)

Attributes

cloud_watch_logs

CfnCluster.BrokerLogsProperty.CloudWatchLogs.

Link

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

Return type

Union[IResolvable, CloudWatchLogsProperty, None]

firehose

CfnCluster.BrokerLogsProperty.Firehose.

Link

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

Return type

Union[IResolvable, FirehoseProperty, None]

s3

CfnCluster.BrokerLogsProperty.S3.

Link

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

Return type

Union[IResolvable, S3Property, None]

BrokerNodeGroupInfoProperty

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

Bases: object

Parameters
  • broker_az_distribution (Optional[str]) – CfnCluster.BrokerNodeGroupInfoProperty.BrokerAZDistribution.

  • client_subnets (Sequence[str]) – CfnCluster.BrokerNodeGroupInfoProperty.ClientSubnets.

  • connectivity_info (Union[IResolvable, ConnectivityInfoProperty, None]) – CfnCluster.BrokerNodeGroupInfoProperty.ConnectivityInfo.

  • instance_type (str) – CfnCluster.BrokerNodeGroupInfoProperty.InstanceType.

  • security_groups (Optional[Sequence[str]]) – CfnCluster.BrokerNodeGroupInfoProperty.SecurityGroups.

  • storage_info (Union[IResolvable, StorageInfoProperty, None]) – CfnCluster.BrokerNodeGroupInfoProperty.StorageInfo.

Link

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

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

broker_node_group_info_property = 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(
            volume_size=123
        )
    )
)

Attributes

broker_az_distribution

CfnCluster.BrokerNodeGroupInfoProperty.BrokerAZDistribution.

Link

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

Return type

Optional[str]

client_subnets

CfnCluster.BrokerNodeGroupInfoProperty.ClientSubnets.

Link

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

Return type

List[str]

connectivity_info

CfnCluster.BrokerNodeGroupInfoProperty.ConnectivityInfo.

Link

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

Return type

Union[IResolvable, ConnectivityInfoProperty, None]

instance_type

CfnCluster.BrokerNodeGroupInfoProperty.InstanceType.

Link

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

Return type

str

security_groups

CfnCluster.BrokerNodeGroupInfoProperty.SecurityGroups.

Link

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

Return type

Optional[List[str]]

storage_info

CfnCluster.BrokerNodeGroupInfoProperty.StorageInfo.

Link

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

Return type

Union[IResolvable, StorageInfoProperty, None]

ClientAuthenticationProperty

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

Bases: object

Parameters
Link

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

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

client_authentication_property = 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
    )
)

Attributes

sasl

CfnCluster.ClientAuthenticationProperty.Sasl.

Link

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

Return type

Union[IResolvable, SaslProperty, None]

tls

CfnCluster.ClientAuthenticationProperty.Tls.

Link

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

Return type

Union[IResolvable, TlsProperty, None]

unauthenticated

CfnCluster.ClientAuthenticationProperty.Unauthenticated.

Link

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

Return type

Union[IResolvable, UnauthenticatedProperty, None]

CloudWatchLogsProperty

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

Bases: object

Parameters
  • enabled (Union[bool, IResolvable]) – CfnCluster.CloudWatchLogsProperty.Enabled.

  • log_group (Optional[str]) – CfnCluster.CloudWatchLogsProperty.LogGroup.

Link

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

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

cloud_watch_logs_property = msk.CfnCluster.CloudWatchLogsProperty(
    enabled=False,

    # the properties below are optional
    log_group="logGroup"
)

Attributes

enabled

CfnCluster.CloudWatchLogsProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable]

log_group

CfnCluster.CloudWatchLogsProperty.LogGroup.

Link

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

Return type

Optional[str]

ConfigurationInfoProperty

class CfnCluster.ConfigurationInfoProperty(*, arn, revision)

Bases: object

Parameters
  • arn (str) – CfnCluster.ConfigurationInfoProperty.Arn.

  • revision (Union[int, float]) – CfnCluster.ConfigurationInfoProperty.Revision.

Link

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

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

configuration_info_property = msk.CfnCluster.ConfigurationInfoProperty(
    arn="arn",
    revision=123
)

Attributes

arn

CfnCluster.ConfigurationInfoProperty.Arn.

Link

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

Return type

str

revision

CfnCluster.ConfigurationInfoProperty.Revision.

Link

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

Return type

Union[int, float]

ConnectivityInfoProperty

class CfnCluster.ConnectivityInfoProperty(*, public_access=None)

Bases: object

Parameters

public_access (Union[IResolvable, PublicAccessProperty, None]) – CfnCluster.ConnectivityInfoProperty.PublicAccess.

Link

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

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

connectivity_info_property = msk.CfnCluster.ConnectivityInfoProperty(
    public_access=msk.CfnCluster.PublicAccessProperty(
        type="type"
    )
)

Attributes

public_access

CfnCluster.ConnectivityInfoProperty.PublicAccess.

Link

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

Return type

Union[IResolvable, PublicAccessProperty, None]

EBSStorageInfoProperty

class CfnCluster.EBSStorageInfoProperty(*, volume_size=None)

Bases: object

Parameters

volume_size (Union[int, float, None]) – CfnCluster.EBSStorageInfoProperty.VolumeSize.

Link

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

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

e_bSStorage_info_property = msk.CfnCluster.EBSStorageInfoProperty(
    volume_size=123
)

Attributes

volume_size

CfnCluster.EBSStorageInfoProperty.VolumeSize.

Link

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

Return type

Union[int, float, None]

EncryptionAtRestProperty

class CfnCluster.EncryptionAtRestProperty(*, data_volume_kms_key_id)

Bases: object

Parameters

data_volume_kms_key_id (str) – CfnCluster.EncryptionAtRestProperty.DataVolumeKMSKeyId.

Link

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

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

encryption_at_rest_property = msk.CfnCluster.EncryptionAtRestProperty(
    data_volume_kms_key_id="dataVolumeKmsKeyId"
)

Attributes

data_volume_kms_key_id

CfnCluster.EncryptionAtRestProperty.DataVolumeKMSKeyId.

Link

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

Return type

str

EncryptionInTransitProperty

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

Bases: object

Parameters
  • client_broker (Optional[str]) – CfnCluster.EncryptionInTransitProperty.ClientBroker.

  • in_cluster (Union[bool, IResolvable, None]) – CfnCluster.EncryptionInTransitProperty.InCluster.

Link

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

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

encryption_in_transit_property = msk.CfnCluster.EncryptionInTransitProperty(
    client_broker="clientBroker",
    in_cluster=False
)

Attributes

client_broker

CfnCluster.EncryptionInTransitProperty.ClientBroker.

Link

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

Return type

Optional[str]

in_cluster

CfnCluster.EncryptionInTransitProperty.InCluster.

Link

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

Return type

Union[bool, IResolvable, None]

EncryptionInfoProperty

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

Bases: object

Parameters
Link

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

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

encryption_info_property = 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
    )
)

Attributes

encryption_at_rest

CfnCluster.EncryptionInfoProperty.EncryptionAtRest.

Link

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

Return type

Union[IResolvable, EncryptionAtRestProperty, None]

encryption_in_transit

CfnCluster.EncryptionInfoProperty.EncryptionInTransit.

Link

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

Return type

Union[IResolvable, EncryptionInTransitProperty, None]

FirehoseProperty

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

Bases: object

Parameters
  • delivery_stream (Optional[str]) – CfnCluster.FirehoseProperty.DeliveryStream.

  • enabled (Union[bool, IResolvable]) – CfnCluster.FirehoseProperty.Enabled.

Link

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

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

firehose_property = msk.CfnCluster.FirehoseProperty(
    enabled=False,

    # the properties below are optional
    delivery_stream="deliveryStream"
)

Attributes

delivery_stream

CfnCluster.FirehoseProperty.DeliveryStream.

Link

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

Return type

Optional[str]

enabled

CfnCluster.FirehoseProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable]

IamProperty

class CfnCluster.IamProperty(*, enabled)

Bases: object

Parameters

enabled (Union[bool, IResolvable]) – CfnCluster.IamProperty.Enabled.

Link

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

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

iam_property = msk.CfnCluster.IamProperty(
    enabled=False
)

Attributes

enabled

CfnCluster.IamProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable]

JmxExporterProperty

class CfnCluster.JmxExporterProperty(*, enabled_in_broker)

Bases: object

Parameters

enabled_in_broker (Union[bool, IResolvable]) – CfnCluster.JmxExporterProperty.EnabledInBroker.

Link

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

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

jmx_exporter_property = msk.CfnCluster.JmxExporterProperty(
    enabled_in_broker=False
)

Attributes

enabled_in_broker

CfnCluster.JmxExporterProperty.EnabledInBroker.

Link

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

Return type

Union[bool, IResolvable]

LoggingInfoProperty

class CfnCluster.LoggingInfoProperty(*, broker_logs)

Bases: object

Parameters

broker_logs (Union[IResolvable, BrokerLogsProperty]) – CfnCluster.LoggingInfoProperty.BrokerLogs.

Link

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

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

logging_info_property = 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"
        )
    )
)

Attributes

broker_logs

CfnCluster.LoggingInfoProperty.BrokerLogs.

Link

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

Return type

Union[IResolvable, BrokerLogsProperty]

NodeExporterProperty

class CfnCluster.NodeExporterProperty(*, enabled_in_broker)

Bases: object

Parameters

enabled_in_broker (Union[bool, IResolvable]) – CfnCluster.NodeExporterProperty.EnabledInBroker.

Link

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

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

node_exporter_property = msk.CfnCluster.NodeExporterProperty(
    enabled_in_broker=False
)

Attributes

enabled_in_broker

CfnCluster.NodeExporterProperty.EnabledInBroker.

Link

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

Return type

Union[bool, IResolvable]

OpenMonitoringProperty

class CfnCluster.OpenMonitoringProperty(*, prometheus)

Bases: object

Parameters

prometheus (Union[IResolvable, PrometheusProperty]) – CfnCluster.OpenMonitoringProperty.Prometheus.

Link

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

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

open_monitoring_property = 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
        )
    )
)

Attributes

prometheus

CfnCluster.OpenMonitoringProperty.Prometheus.

Link

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

Return type

Union[IResolvable, PrometheusProperty]

PrometheusProperty

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

Bases: object

Parameters
Link

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

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

prometheus_property = msk.CfnCluster.PrometheusProperty(
    jmx_exporter=msk.CfnCluster.JmxExporterProperty(
        enabled_in_broker=False
    ),
    node_exporter=msk.CfnCluster.NodeExporterProperty(
        enabled_in_broker=False
    )
)

Attributes

jmx_exporter

CfnCluster.PrometheusProperty.JmxExporter.

Link

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

Return type

Union[IResolvable, JmxExporterProperty, None]

node_exporter

CfnCluster.PrometheusProperty.NodeExporter.

Link

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

Return type

Union[IResolvable, NodeExporterProperty, None]

PublicAccessProperty

class CfnCluster.PublicAccessProperty(*, type=None)

Bases: object

Parameters

type (Optional[str]) – CfnCluster.PublicAccessProperty.Type.

Link

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

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

public_access_property = msk.CfnCluster.PublicAccessProperty(
    type="type"
)

Attributes

type

CfnCluster.PublicAccessProperty.Type.

Link

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

Return type

Optional[str]

S3Property

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

Bases: object

Parameters
  • bucket (Optional[str]) – CfnCluster.S3Property.Bucket.

  • enabled (Union[bool, IResolvable]) – CfnCluster.S3Property.Enabled.

  • prefix (Optional[str]) – CfnCluster.S3Property.Prefix.

Link

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

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

s3_property = msk.CfnCluster.S3Property(
    enabled=False,

    # the properties below are optional
    bucket="bucket",
    prefix="prefix"
)

Attributes

bucket

CfnCluster.S3Property.Bucket.

Link

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

Return type

Optional[str]

enabled

CfnCluster.S3Property.Enabled.

Link

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

Return type

Union[bool, IResolvable]

prefix

CfnCluster.S3Property.Prefix.

Link

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

Return type

Optional[str]

SaslProperty

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

Bases: object

Parameters
Link

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

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

sasl_property = msk.CfnCluster.SaslProperty(
    iam=msk.CfnCluster.IamProperty(
        enabled=False
    ),
    scram=msk.CfnCluster.ScramProperty(
        enabled=False
    )
)

Attributes

iam

CfnCluster.SaslProperty.Iam.

Link

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

Return type

Union[IResolvable, IamProperty, None]

scram

CfnCluster.SaslProperty.Scram.

Link

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

Return type

Union[IResolvable, ScramProperty, None]

ScramProperty

class CfnCluster.ScramProperty(*, enabled)

Bases: object

Parameters

enabled (Union[bool, IResolvable]) – CfnCluster.ScramProperty.Enabled.

Link

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

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

scram_property = msk.CfnCluster.ScramProperty(
    enabled=False
)

Attributes

enabled

CfnCluster.ScramProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable]

StorageInfoProperty

class CfnCluster.StorageInfoProperty(*, ebs_storage_info=None)

Bases: object

Parameters

ebs_storage_info (Union[IResolvable, EBSStorageInfoProperty, None]) – CfnCluster.StorageInfoProperty.EBSStorageInfo.

Link

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

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

storage_info_property = msk.CfnCluster.StorageInfoProperty(
    ebs_storage_info=msk.CfnCluster.EBSStorageInfoProperty(
        volume_size=123
    )
)

Attributes

ebs_storage_info

CfnCluster.StorageInfoProperty.EBSStorageInfo.

Link

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

Return type

Union[IResolvable, EBSStorageInfoProperty, None]

TlsProperty

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

Bases: object

Parameters
  • certificate_authority_arn_list (Optional[Sequence[str]]) – CfnCluster.TlsProperty.CertificateAuthorityArnList.

  • enabled (Union[bool, IResolvable, None]) – CfnCluster.TlsProperty.Enabled.

Link

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

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

tls_property = msk.CfnCluster.TlsProperty(
    certificate_authority_arn_list=["certificateAuthorityArnList"],
    enabled=False
)

Attributes

certificate_authority_arn_list

CfnCluster.TlsProperty.CertificateAuthorityArnList.

Link

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

Return type

Optional[List[str]]

enabled

CfnCluster.TlsProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable, None]

UnauthenticatedProperty

class CfnCluster.UnauthenticatedProperty(*, enabled)

Bases: object

Parameters

enabled (Union[bool, IResolvable]) – CfnCluster.UnauthenticatedProperty.Enabled.

Link

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

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

unauthenticated_property = msk.CfnCluster.UnauthenticatedProperty(
    enabled=False
)

Attributes

enabled

CfnCluster.UnauthenticatedProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable]