CfnReplicator

class aws_cdk.aws_msk.CfnReplicator(scope, id, *, kafka_clusters, replication_info_list, replicator_name, service_execution_role_arn, description=None, log_delivery=None, tags=None)

Bases: CfnResource

Creates the replicator.

See:

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

CloudformationResource:

AWS::MSK::Replicator

ExampleMetadata:

fixture=_generated

Example:

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

cfn_replicator = msk.CfnReplicator(self, "MyCfnReplicator",
    kafka_clusters=[msk.CfnReplicator.KafkaClusterProperty(
        amazon_msk_cluster=msk.CfnReplicator.AmazonMskClusterProperty(
            msk_cluster_arn="mskClusterArn"
        ),
        apache_kafka_cluster=msk.CfnReplicator.ApacheKafkaClusterProperty(
            apache_kafka_cluster_id="apacheKafkaClusterId",
            bootstrap_broker_string="bootstrapBrokerString"
        ),
        client_authentication=msk.CfnReplicator.KafkaClusterClientAuthenticationProperty(
            sasl_scram=msk.CfnReplicator.KafkaClusterSaslScramAuthenticationProperty(
                mechanism="mechanism",
                secret_arn="secretArn"
            )
        ),
        encryption_in_transit=msk.CfnReplicator.KafkaClusterEncryptionInTransitProperty(
            encryption_type="encryptionType",

            # the properties below are optional
            root_ca_certificate="rootCaCertificate"
        ),
        vpc_config=msk.CfnReplicator.KafkaClusterClientVpcConfigProperty(
            subnet_ids=["subnetIds"],

            # the properties below are optional
            security_group_ids=["securityGroupIds"]
        )
    )],
    replication_info_list=[msk.CfnReplicator.ReplicationInfoProperty(
        consumer_group_replication=msk.CfnReplicator.ConsumerGroupReplicationProperty(
            consumer_groups_to_replicate=["consumerGroupsToReplicate"],

            # the properties below are optional
            consumer_group_offset_sync_mode="consumerGroupOffsetSyncMode",
            consumer_groups_to_exclude=["consumerGroupsToExclude"],
            detect_and_copy_new_consumer_groups=False,
            synchronise_consumer_group_offsets=False
        ),
        target_compression_type="targetCompressionType",
        topic_replication=msk.CfnReplicator.TopicReplicationProperty(
            topics_to_replicate=["topicsToReplicate"],

            # the properties below are optional
            copy_access_control_lists_for_topics=False,
            copy_topic_configurations=False,
            detect_and_copy_new_topics=False,
            starting_position=msk.CfnReplicator.ReplicationStartingPositionProperty(
                type="type"
            ),
            topic_name_configuration=msk.CfnReplicator.ReplicationTopicNameConfigurationProperty(
                type="type"
            ),
            topics_to_exclude=["topicsToExclude"]
        ),

        # the properties below are optional
        source_kafka_cluster_arn="sourceKafkaClusterArn",
        source_kafka_cluster_id="sourceKafkaClusterId",
        target_kafka_cluster_arn="targetKafkaClusterArn",
        target_kafka_cluster_id="targetKafkaClusterId"
    )],
    replicator_name="replicatorName",
    service_execution_role_arn="serviceExecutionRoleArn",

    # the properties below are optional
    description="description",
    log_delivery=msk.CfnReplicator.LogDeliveryProperty(
        replicator_log_delivery=msk.CfnReplicator.ReplicatorLogDeliveryProperty(
            cloud_watch_logs=msk.CfnReplicator.CloudWatchLogsProperty(
                enabled=False,

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

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

                # the properties below are optional
                bucket="bucket",
                prefix="prefix"
            )
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::MSK::Replicator.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • kafka_clusters (Union[IResolvable, Sequence[Union[IResolvable, KafkaClusterProperty, Dict[str, Any]]]]) – Kafka Clusters to use in setting up sources / targets for replication.

  • replication_info_list (Union[IResolvable, Sequence[Union[IResolvable, ReplicationInfoProperty, Dict[str, Any]]]]) – A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

  • replicator_name (str) – The name of the replicator. Alpha-numeric characters with ‘-’ are allowed.

  • service_execution_role_arn (str) – The ARN of the IAM role used by the replicator to access resources in the customer’s account (e.g source and target clusters).

  • description (Optional[str]) – A summary description of the replicator.

  • log_delivery (Union[IResolvable, LogDeliveryProperty, Dict[str, Any], None]) – Configuration for log delivery for the replicator.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – List of tags to attach to created Replicator.

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

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.

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"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)
Parameters:

cdk_property_name (str)

Return type:

Optional[str]

get_att(attribute_name, type_hint=None)

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.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::MSK::Replicator'
attr_current_version

The current version number of the replicator.

CloudformationAttribute:

CurrentVersion

attr_replicator_arn

Amazon Resource Name (ARN) for the created replicator.

CloudformationAttribute:

ReplicatorArn

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

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

cfn_resource_type

AWS resource type.

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.

description

A summary description of the replicator.

env
kafka_clusters

Kafka Clusters to use in setting up sources / targets for replication.

log_delivery

Configuration for log delivery for the replicator.

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).

Returns:

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

node

The tree node.

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 }).

replication_info_list

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

replicator_name

The name of the replicator.

replicator_ref

A reference to a Replicator resource.

service_execution_role_arn

The ARN of the IAM role used by the replicator to access resources in the customer’s account (e.g source and target clusters).

stack

The stack in which this element is defined.

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

tags

List of tags to attach to created Replicator.

Static Methods

classmethod arn_for_replicator(resource)
Parameters:

resource (IReplicatorRef)

Return type:

str

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_replicator(x)

Checks whether the given object is a CfnReplicator.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

AmazonMskClusterProperty

class CfnReplicator.AmazonMskClusterProperty(*, msk_cluster_arn)

Bases: object

Details of an Amazon MSK Cluster.

Parameters:

msk_cluster_arn (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 import aws_msk as msk

amazon_msk_cluster_property = msk.CfnReplicator.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

ApacheKafkaClusterProperty

class CfnReplicator.ApacheKafkaClusterProperty(*, apache_kafka_cluster_id, bootstrap_broker_string)

Bases: object

Details of an Apache Kafka cluster.

Parameters:

  • apache_kafka_cluster_id (str) – The ID of the Apache Kafka cluster.

  • bootstrap_broker_string (str) – The bootstrap broker string of the Apache Kafka cluster.

See:

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

apache_kafka_cluster_property = msk.CfnReplicator.ApacheKafkaClusterProperty(
    apache_kafka_cluster_id="apacheKafkaClusterId",
    bootstrap_broker_string="bootstrapBrokerString"
)

Attributes

apache_kafka_cluster_id

The ID of the Apache Kafka cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-apachekafkacluster.html#cfn-msk-replicator-apachekafkacluster-apachekafkaclusterid

bootstrap_broker_string

The bootstrap broker string of the Apache Kafka cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-apachekafkacluster.html#cfn-msk-replicator-apachekafkacluster-bootstrapbrokerstring

CloudWatchLogsProperty

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

Bases: object

Details about delivering logs to CloudWatch Logs.

Parameters:

  • enabled (Union[bool, IResolvable]) – Whether log delivery to CloudWatch Logs is enabled.

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

See:

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

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

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

Attributes

enabled

Whether log delivery to CloudWatch Logs is enabled.

See:

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

log_group

The CloudWatch log group that is the destination for log delivery.

See:

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

ConsumerGroupReplicationProperty

class CfnReplicator.ConsumerGroupReplicationProperty(*, consumer_groups_to_replicate, consumer_group_offset_sync_mode=None, consumer_groups_to_exclude=None, detect_and_copy_new_consumer_groups=None, synchronise_consumer_group_offsets=None)

Bases: object

Details about consumer group replication.

Parameters:

  • consumer_groups_to_replicate (Sequence[str]) – List of regular expression patterns indicating the consumer groups to copy.

  • consumer_group_offset_sync_mode (Optional[str]) – The consumer group offset synchronization mode.

  • consumer_groups_to_exclude (Optional[Sequence[str]]) – List of regular expression patterns indicating the consumer groups that should not be replicated.

  • 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 import aws_msk as msk

consumer_group_replication_property = msk.CfnReplicator.ConsumerGroupReplicationProperty(
    consumer_groups_to_replicate=["consumerGroupsToReplicate"],

    # the properties below are optional
    consumer_group_offset_sync_mode="consumerGroupOffsetSyncMode",
    consumer_groups_to_exclude=["consumerGroupsToExclude"],
    detect_and_copy_new_consumer_groups=False,
    synchronise_consumer_group_offsets=False
)

Attributes

consumer_group_offset_sync_mode

The consumer group offset synchronization mode.

See:

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

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

FirehoseProperty

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

Bases: object

Details about delivering logs to Firehose.

Parameters:

  • enabled (Union[bool, IResolvable]) – Whether log delivery to Firehose is enabled.

  • delivery_stream (Optional[str]) – The Firehose delivery stream that is the destination for log delivery.

See:

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

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

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

Attributes

delivery_stream

The Firehose delivery stream that is the destination for log delivery.

See:

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

enabled

Whether log delivery to Firehose is enabled.

See:

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

KafkaClusterClientAuthenticationProperty

class CfnReplicator.KafkaClusterClientAuthenticationProperty(*, sasl_scram)

Bases: object

Details of the client authentication used by the Apache Kafka cluster.

Parameters:

sasl_scram (Union[IResolvable, KafkaClusterSaslScramAuthenticationProperty, Dict[str, Any]]) – Details for SASL/SCRAM client authentication.

See:

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

kafka_cluster_client_authentication_property = msk.CfnReplicator.KafkaClusterClientAuthenticationProperty(
    sasl_scram=msk.CfnReplicator.KafkaClusterSaslScramAuthenticationProperty(
        mechanism="mechanism",
        secret_arn="secretArn"
    )
)

Attributes

sasl_scram

Details for SASL/SCRAM client authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclusterclientauthentication.html#cfn-msk-replicator-kafkaclusterclientauthentication-saslscram

KafkaClusterClientVpcConfigProperty

class CfnReplicator.KafkaClusterClientVpcConfigProperty(*, subnet_ids, security_group_ids=None)

Bases: object

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

Parameters:

  • subnet_ids (Sequence[str]) – The list of subnets in the client VPC to connect to.

  • security_group_ids (Optional[Sequence[str]]) – 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

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 import aws_msk as msk

kafka_cluster_client_vpc_config_property = msk.CfnReplicator.KafkaClusterClientVpcConfigProperty(
    subnet_ids=["subnetIds"],

    # the properties below are optional
    security_group_ids=["securityGroupIds"]
)

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

KafkaClusterEncryptionInTransitProperty

class CfnReplicator.KafkaClusterEncryptionInTransitProperty(*, encryption_type, root_ca_certificate=None)

Bases: object

Details of encryption in transit to the Apache Kafka cluster.

Parameters:

  • encryption_type (str) – The type of encryption in transit to the Apache Kafka cluster.

  • root_ca_certificate (Optional[str]) – The root CA certificate.

See:

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

kafka_cluster_encryption_in_transit_property = msk.CfnReplicator.KafkaClusterEncryptionInTransitProperty(
    encryption_type="encryptionType",

    # the properties below are optional
    root_ca_certificate="rootCaCertificate"
)

Attributes

encryption_type

The type of encryption in transit to the Apache Kafka cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclusterencryptionintransit.html#cfn-msk-replicator-kafkaclusterencryptionintransit-encryptiontype

root_ca_certificate

The root CA certificate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclusterencryptionintransit.html#cfn-msk-replicator-kafkaclusterencryptionintransit-rootcacertificate

KafkaClusterProperty

class CfnReplicator.KafkaClusterProperty(*, amazon_msk_cluster=None, apache_kafka_cluster=None, client_authentication=None, encryption_in_transit=None, vpc_config=None)

Bases: object

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

Parameters:
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 import aws_msk as msk

kafka_cluster_property = msk.CfnReplicator.KafkaClusterProperty(
    amazon_msk_cluster=msk.CfnReplicator.AmazonMskClusterProperty(
        msk_cluster_arn="mskClusterArn"
    ),
    apache_kafka_cluster=msk.CfnReplicator.ApacheKafkaClusterProperty(
        apache_kafka_cluster_id="apacheKafkaClusterId",
        bootstrap_broker_string="bootstrapBrokerString"
    ),
    client_authentication=msk.CfnReplicator.KafkaClusterClientAuthenticationProperty(
        sasl_scram=msk.CfnReplicator.KafkaClusterSaslScramAuthenticationProperty(
            mechanism="mechanism",
            secret_arn="secretArn"
        )
    ),
    encryption_in_transit=msk.CfnReplicator.KafkaClusterEncryptionInTransitProperty(
        encryption_type="encryptionType",

        # the properties below are optional
        root_ca_certificate="rootCaCertificate"
    ),
    vpc_config=msk.CfnReplicator.KafkaClusterClientVpcConfigProperty(
        subnet_ids=["subnetIds"],

        # the properties below are optional
        security_group_ids=["securityGroupIds"]
    )
)

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

apache_kafka_cluster

Details of an Apache Kafka cluster.

See:

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

client_authentication

Details of the client authentication used by the Apache Kafka cluster.

See:

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

encryption_in_transit

Details of encryption in transit to the Apache Kafka cluster.

See:

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

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

KafkaClusterSaslScramAuthenticationProperty

class CfnReplicator.KafkaClusterSaslScramAuthenticationProperty(*, mechanism, secret_arn)

Bases: object

Details for SASL/SCRAM client authentication.

Parameters:

  • mechanism (str) – The SASL/SCRAM authentication mechanism.

  • secret_arn (str) – The Amazon Resource Name (ARN) of the Secrets Manager secret.

See:

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

kafka_cluster_sasl_scram_authentication_property = msk.CfnReplicator.KafkaClusterSaslScramAuthenticationProperty(
    mechanism="mechanism",
    secret_arn="secretArn"
)

Attributes

mechanism

The SASL/SCRAM authentication mechanism.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersaslscramauthentication.html#cfn-msk-replicator-kafkaclustersaslscramauthentication-mechanism

secret_arn

The Amazon Resource Name (ARN) of the Secrets Manager secret.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersaslscramauthentication.html#cfn-msk-replicator-kafkaclustersaslscramauthentication-secretarn

LogDeliveryProperty

class CfnReplicator.LogDeliveryProperty(*, replicator_log_delivery=None)

Bases: object

Configuration for log delivery for the replicator.

Parameters:

replicator_log_delivery (Union[IResolvable, ReplicatorLogDeliveryProperty, Dict[str, Any], None]) – Details of the log delivery for the replicator.

See:

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

log_delivery_property = msk.CfnReplicator.LogDeliveryProperty(
    replicator_log_delivery=msk.CfnReplicator.ReplicatorLogDeliveryProperty(
        cloud_watch_logs=msk.CfnReplicator.CloudWatchLogsProperty(
            enabled=False,

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

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

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

Attributes

replicator_log_delivery

Details of the log delivery for the replicator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-logdelivery.html#cfn-msk-replicator-logdelivery-replicatorlogdelivery

ReplicationInfoProperty

class CfnReplicator.ReplicationInfoProperty(*, consumer_group_replication, target_compression_type, topic_replication, source_kafka_cluster_arn=None, source_kafka_cluster_id=None, target_kafka_cluster_arn=None, target_kafka_cluster_id=None)

Bases: object

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

Parameters:

  • consumer_group_replication (Union[IResolvable, ConsumerGroupReplicationProperty, Dict[str, Any]]) – Configuration relating to consumer group replication.

  • target_compression_type (str) – The compression type to use when producing records to target cluster.

  • topic_replication (Union[IResolvable, TopicReplicationProperty, Dict[str, Any]]) – Configuration relating to topic replication.

  • source_kafka_cluster_arn (Optional[str]) – The ARN of the source Kafka cluster.

  • source_kafka_cluster_id (Optional[str]) – The ID of the source Kafka cluster.

  • target_kafka_cluster_arn (Optional[str]) – The ARN of the target Kafka cluster.

  • target_kafka_cluster_id (Optional[str]) – The ID of the target Kafka cluster.

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 import aws_msk as msk

replication_info_property = msk.CfnReplicator.ReplicationInfoProperty(
    consumer_group_replication=msk.CfnReplicator.ConsumerGroupReplicationProperty(
        consumer_groups_to_replicate=["consumerGroupsToReplicate"],

        # the properties below are optional
        consumer_group_offset_sync_mode="consumerGroupOffsetSyncMode",
        consumer_groups_to_exclude=["consumerGroupsToExclude"],
        detect_and_copy_new_consumer_groups=False,
        synchronise_consumer_group_offsets=False
    ),
    target_compression_type="targetCompressionType",
    topic_replication=msk.CfnReplicator.TopicReplicationProperty(
        topics_to_replicate=["topicsToReplicate"],

        # the properties below are optional
        copy_access_control_lists_for_topics=False,
        copy_topic_configurations=False,
        detect_and_copy_new_topics=False,
        starting_position=msk.CfnReplicator.ReplicationStartingPositionProperty(
            type="type"
        ),
        topic_name_configuration=msk.CfnReplicator.ReplicationTopicNameConfigurationProperty(
            type="type"
        ),
        topics_to_exclude=["topicsToExclude"]
    ),

    # the properties below are optional
    source_kafka_cluster_arn="sourceKafkaClusterArn",
    source_kafka_cluster_id="sourceKafkaClusterId",
    target_kafka_cluster_arn="targetKafkaClusterArn",
    target_kafka_cluster_id="targetKafkaClusterId"
)

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

source_kafka_cluster_id

The ID of the source Kafka cluster.

See:

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

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

target_kafka_cluster_id

The ID of the target Kafka cluster.

See:

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

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 CfnReplicator.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 import aws_msk as msk

replication_starting_position_property = msk.CfnReplicator.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 CfnReplicator.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 import aws_msk as msk

replication_topic_name_configuration_property = msk.CfnReplicator.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

ReplicatorLogDeliveryProperty

class CfnReplicator.ReplicatorLogDeliveryProperty(*, cloud_watch_logs=None, firehose=None, s3=None)

Bases: object

Details of the log delivery for the replicator.

Parameters:
See:

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

replicator_log_delivery_property = msk.CfnReplicator.ReplicatorLogDeliveryProperty(
    cloud_watch_logs=msk.CfnReplicator.CloudWatchLogsProperty(
        enabled=False,

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

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

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

Attributes

cloud_watch_logs

Details about delivering logs to CloudWatch Logs.

See:

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

firehose

Details about delivering logs to Firehose.

See:

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

s3

Details about delivering logs to S3.

See:

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

S3Property

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

Bases: object

Details about delivering logs to S3.

Parameters:

  • enabled (Union[bool, IResolvable]) – Whether log delivery to S3 is enabled.

  • bucket (Optional[str]) – The S3 bucket that is the destination for log delivery.

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

See:

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

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

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

Attributes

bucket

The S3 bucket that is the destination for log delivery.

See:

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

enabled

Whether log delivery to S3 is enabled.

See:

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

prefix

The S3 prefix that is the destination for log delivery.

See:

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

TopicReplicationProperty

class CfnReplicator.TopicReplicationProperty(*, topics_to_replicate, 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)

Bases: object

Details about topic replication.

Parameters:

  • topics_to_replicate (Sequence[str]) – List of regular expression patterns indicating the topics to copy.

  • 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.

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 import aws_msk as msk

topic_replication_property = msk.CfnReplicator.TopicReplicationProperty(
    topics_to_replicate=["topicsToReplicate"],

    # the properties below are optional
    copy_access_control_lists_for_topics=False,
    copy_topic_configurations=False,
    detect_and_copy_new_topics=False,
    starting_position=msk.CfnReplicator.ReplicationStartingPositionProperty(
        type="type"
    ),
    topic_name_configuration=msk.CfnReplicator.ReplicationTopicNameConfigurationProperty(
        type="type"
    ),
    topics_to_exclude=["topicsToExclude"]
)

Attributes

copy_access_control_lists_for_topics

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

See:

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

copy_topic_configurations

Whether to periodically configure remote topics to match their corresponding upstream topics.

See:

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

detect_and_copy_new_topics

Whether to periodically check for new topics and partitions.

See:

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

starting_position

Specifies the position in the topics to start replicating from.

See:

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

topic_name_configuration

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

See:

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

topics_to_exclude

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

See:

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

topics_to_replicate

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#cfn-msk-replicator-topicreplication-topicstoreplicate