CfnReplicatorPropsMixin

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

Bases: Mixin

Creates the replicator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html
CloudformationResource:: AWS::MSK::Replicator
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_replicator_props_mixin = msk_mixins.CfnReplicatorPropsMixin(msk_mixins.CfnReplicatorMixinProps(
    description="description",
    kafka_clusters=[msk_mixins.CfnReplicatorPropsMixin.KafkaClusterProperty(
        amazon_msk_cluster=msk_mixins.CfnReplicatorPropsMixin.AmazonMskClusterProperty(
            msk_cluster_arn="mskClusterArn"
        ),
        vpc_config=msk_mixins.CfnReplicatorPropsMixin.KafkaClusterClientVpcConfigProperty(
            security_group_ids=["securityGroupIds"],
            subnet_ids=["subnetIds"]
        )
    )],
    replication_info_list=[msk_mixins.CfnReplicatorPropsMixin.ReplicationInfoProperty(
        consumer_group_replication=msk_mixins.CfnReplicatorPropsMixin.ConsumerGroupReplicationProperty(
            consumer_groups_to_exclude=["consumerGroupsToExclude"],
            consumer_groups_to_replicate=["consumerGroupsToReplicate"],
            detect_and_copy_new_consumer_groups=False,
            synchronise_consumer_group_offsets=False
        ),
        source_kafka_cluster_arn="sourceKafkaClusterArn",
        target_compression_type="targetCompressionType",
        target_kafka_cluster_arn="targetKafkaClusterArn",
        topic_replication=msk_mixins.CfnReplicatorPropsMixin.TopicReplicationProperty(
            copy_access_control_lists_for_topics=False,
            copy_topic_configurations=False,
            detect_and_copy_new_topics=False,
            starting_position=msk_mixins.CfnReplicatorPropsMixin.ReplicationStartingPositionProperty(
                type="type"
            ),
            topic_name_configuration=msk_mixins.CfnReplicatorPropsMixin.ReplicationTopicNameConfigurationProperty(
                type="type"
            ),
            topics_to_exclude=["topicsToExclude"],
            topics_to_replicate=["topicsToReplicate"]
        )
    )],
    replicator_name="replicatorName",
    service_execution_role_arn="serviceExecutionRoleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnReplicatorMixinProps, 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 = ['description', 'kafkaClusters', 'replicationInfoList', 'replicatorName', 'serviceExecutionRoleArn', '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

AmazonMskClusterProperty

class CfnReplicatorPropsMixin.AmazonMskClusterProperty(*, msk_cluster_arn=None)

Bases: object

Details of an Amazon MSK Cluster.

Parameters:: msk_cluster_arn (Optional[str]) – The Amazon Resource Name (ARN) of an Amazon MSK cluster.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-amazonmskcluster.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

amazon_msk_cluster_property = msk_mixins.CfnReplicatorPropsMixin.AmazonMskClusterProperty(
    msk_cluster_arn="mskClusterArn"
)

Attributes

msk_cluster_arn

The Amazon Resource Name (ARN) of an Amazon MSK cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-amazonmskcluster.html#cfn-msk-replicator-amazonmskcluster-mskclusterarn

ConsumerGroupReplicationProperty

class CfnReplicatorPropsMixin.ConsumerGroupReplicationProperty(*, consumer_groups_to_exclude=None, consumer_groups_to_replicate=None, detect_and_copy_new_consumer_groups=None, synchronise_consumer_group_offsets=None)

Bases: object

Details about consumer group replication.

Parameters:

consumer_groups_to_exclude (Optional[Sequence[str]]) – List of regular expression patterns indicating the consumer groups that should not be replicated.
consumer_groups_to_replicate (Optional[Sequence[str]]) – List of regular expression patterns indicating the consumer groups to copy.
detect_and_copy_new_consumer_groups (Union[bool, IResolvable, None]) – Enables synchronization of consumer groups to target cluster.
synchronise_consumer_group_offsets (Union[bool, IResolvable, None]) – Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-consumergroupreplication.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

consumer_group_replication_property = msk_mixins.CfnReplicatorPropsMixin.ConsumerGroupReplicationProperty(
    consumer_groups_to_exclude=["consumerGroupsToExclude"],
    consumer_groups_to_replicate=["consumerGroupsToReplicate"],
    detect_and_copy_new_consumer_groups=False,
    synchronise_consumer_group_offsets=False
)

Attributes

consumer_groups_to_exclude

List of regular expression patterns indicating the consumer groups that should not be replicated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-consumergroupreplication.html#cfn-msk-replicator-consumergroupreplication-consumergroupstoexclude

consumer_groups_to_replicate

List of regular expression patterns indicating the consumer groups to copy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-consumergroupreplication.html#cfn-msk-replicator-consumergroupreplication-consumergroupstoreplicate

detect_and_copy_new_consumer_groups

Enables synchronization of consumer groups to target cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-consumergroupreplication.html#cfn-msk-replicator-consumergroupreplication-detectandcopynewconsumergroups

synchronise_consumer_group_offsets

Enables synchronization of consumer group offsets to target cluster.

The translated offsets will be written to topic __consumer_offsets.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-consumergroupreplication.html#cfn-msk-replicator-consumergroupreplication-synchroniseconsumergroupoffsets

KafkaClusterClientVpcConfigProperty

class CfnReplicatorPropsMixin.KafkaClusterClientVpcConfigProperty(*, security_group_ids=None, subnet_ids=None)

Bases: object

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

Parameters:

security_group_ids (Optional[Sequence[str]]) – The security groups to attach to the ENIs for the broker nodes.
subnet_ids (Optional[Sequence[str]]) – The list of subnets in the client VPC to connect to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclusterclientvpcconfig.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

kafka_cluster_client_vpc_config_property = msk_mixins.CfnReplicatorPropsMixin.KafkaClusterClientVpcConfigProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

security_group_ids

The security groups to attach to the ENIs for the broker nodes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclusterclientvpcconfig.html#cfn-msk-replicator-kafkaclusterclientvpcconfig-securitygroupids

subnet_ids

The list of subnets in the client VPC to connect to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclusterclientvpcconfig.html#cfn-msk-replicator-kafkaclusterclientvpcconfig-subnetids

KafkaClusterProperty

class CfnReplicatorPropsMixin.KafkaClusterProperty(*, amazon_msk_cluster=None, vpc_config=None)

Bases: object

Information about Kafka Cluster to be used as source / target for replication.

Parameters:

amazon_msk_cluster (Union[IResolvable, AmazonMskClusterProperty, Dict[str, Any], None]) – Details of an Amazon MSK Cluster.
vpc_config (Union[IResolvable, KafkaClusterClientVpcConfigProperty, Dict[str, Any], None]) – Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkacluster.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

kafka_cluster_property = msk_mixins.CfnReplicatorPropsMixin.KafkaClusterProperty(
    amazon_msk_cluster=msk_mixins.CfnReplicatorPropsMixin.AmazonMskClusterProperty(
        msk_cluster_arn="mskClusterArn"
    ),
    vpc_config=msk_mixins.CfnReplicatorPropsMixin.KafkaClusterClientVpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)

Attributes

amazon_msk_cluster

Details of an Amazon MSK Cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkacluster.html#cfn-msk-replicator-kafkacluster-amazonmskcluster

vpc_config

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkacluster.html#cfn-msk-replicator-kafkacluster-vpcconfig

ReplicationInfoProperty

class CfnReplicatorPropsMixin.ReplicationInfoProperty(*, consumer_group_replication=None, source_kafka_cluster_arn=None, target_compression_type=None, target_kafka_cluster_arn=None, topic_replication=None)

Bases: object

Specifies configuration for replication between a source and target Kafka cluster.

Parameters:

consumer_group_replication (Union[IResolvable, ConsumerGroupReplicationProperty, Dict[str, Any], None]) – Configuration relating to consumer group replication.
source_kafka_cluster_arn (Optional[str]) – The ARN of the source Kafka cluster.
target_compression_type (Optional[str]) – The compression type to use when producing records to target cluster.
target_kafka_cluster_arn (Optional[str]) – The ARN of the target Kafka cluster.
topic_replication (Union[IResolvable, TopicReplicationProperty, Dict[str, Any], None]) – Configuration relating to topic replication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.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

replication_info_property = msk_mixins.CfnReplicatorPropsMixin.ReplicationInfoProperty(
    consumer_group_replication=msk_mixins.CfnReplicatorPropsMixin.ConsumerGroupReplicationProperty(
        consumer_groups_to_exclude=["consumerGroupsToExclude"],
        consumer_groups_to_replicate=["consumerGroupsToReplicate"],
        detect_and_copy_new_consumer_groups=False,
        synchronise_consumer_group_offsets=False
    ),
    source_kafka_cluster_arn="sourceKafkaClusterArn",
    target_compression_type="targetCompressionType",
    target_kafka_cluster_arn="targetKafkaClusterArn",
    topic_replication=msk_mixins.CfnReplicatorPropsMixin.TopicReplicationProperty(
        copy_access_control_lists_for_topics=False,
        copy_topic_configurations=False,
        detect_and_copy_new_topics=False,
        starting_position=msk_mixins.CfnReplicatorPropsMixin.ReplicationStartingPositionProperty(
            type="type"
        ),
        topic_name_configuration=msk_mixins.CfnReplicatorPropsMixin.ReplicationTopicNameConfigurationProperty(
            type="type"
        ),
        topics_to_exclude=["topicsToExclude"],
        topics_to_replicate=["topicsToReplicate"]
    )
)

Attributes

consumer_group_replication

Configuration relating to consumer group replication.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.html#cfn-msk-replicator-replicationinfo-consumergroupreplication

source_kafka_cluster_arn

The ARN of the source Kafka cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.html#cfn-msk-replicator-replicationinfo-sourcekafkaclusterarn

target_compression_type

The compression type to use when producing records to target cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.html#cfn-msk-replicator-replicationinfo-targetcompressiontype

target_kafka_cluster_arn

The ARN of the target Kafka cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.html#cfn-msk-replicator-replicationinfo-targetkafkaclusterarn

topic_replication

Configuration relating to topic replication.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationinfo.html#cfn-msk-replicator-replicationinfo-topicreplication

ReplicationStartingPositionProperty

class CfnReplicatorPropsMixin.ReplicationStartingPositionProperty(*, type=None)

Bases: object

Specifies the position in the topics to start replicating from.

Parameters:: type (Optional[str]) – The type of replication starting position.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationstartingposition.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

replication_starting_position_property = msk_mixins.CfnReplicatorPropsMixin.ReplicationStartingPositionProperty(
    type="type"
)

Attributes

type

The type of replication starting position.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationstartingposition.html#cfn-msk-replicator-replicationstartingposition-type

ReplicationTopicNameConfigurationProperty

class CfnReplicatorPropsMixin.ReplicationTopicNameConfigurationProperty(*, type=None)

Bases: object

Configuration for specifying replicated topic names will be the same as their corresponding upstream topics or prefixed with source cluster alias.

Parameters:: type (Optional[str]) – The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationtopicnameconfiguration.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

replication_topic_name_configuration_property = msk_mixins.CfnReplicatorPropsMixin.ReplicationTopicNameConfigurationProperty(
    type="type"
)

Attributes

type

The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-replicationtopicnameconfiguration.html#cfn-msk-replicator-replicationtopicnameconfiguration-type

TopicReplicationProperty

class CfnReplicatorPropsMixin.TopicReplicationProperty(*, copy_access_control_lists_for_topics=None, copy_topic_configurations=None, detect_and_copy_new_topics=None, starting_position=None, topic_name_configuration=None, topics_to_exclude=None, topics_to_replicate=None)

Bases: object

Details about topic replication.

Parameters:

copy_access_control_lists_for_topics (Union[bool, IResolvable, None]) – Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
copy_topic_configurations (Union[bool, IResolvable, None]) – Whether to periodically configure remote topics to match their corresponding upstream topics.
detect_and_copy_new_topics (Union[bool, IResolvable, None]) – Whether to periodically check for new topics and partitions.
starting_position (Union[IResolvable, ReplicationStartingPositionProperty, Dict[str, Any], None]) – Specifies the position in the topics to start replicating from.
topic_name_configuration (Union[IResolvable, ReplicationTopicNameConfigurationProperty, Dict[str, Any], None]) – Configuration for specifying replicated topic names will be the same as their corresponding upstream topics or prefixed with source cluster alias.
topics_to_exclude (Optional[Sequence[str]]) – List of regular expression patterns indicating the topics that should not be replicated.
topics_to_replicate (Optional[Sequence[str]]) – List of regular expression patterns indicating the topics to copy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-topicreplication.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

topic_replication_property = msk_mixins.CfnReplicatorPropsMixin.TopicReplicationProperty(
    copy_access_control_lists_for_topics=False,
    copy_topic_configurations=False,
    detect_and_copy_new_topics=False,
    starting_position=msk_mixins.CfnReplicatorPropsMixin.ReplicationStartingPositionProperty(
        type="type"
    ),
    topic_name_configuration=msk_mixins.CfnReplicatorPropsMixin.ReplicationTopicNameConfigurationProperty(
        type="type"
    ),
    topics_to_exclude=["topicsToExclude"],
    topics_to_replicate=["topicsToReplicate"]
)