CfnReplicatorPropsMixin

class aws_cdk.cfn_property_mixins.aws_msk.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.cfn_property_mixins import aws_msk as msk
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_replicator_props_mixin = msk.CfnReplicatorPropsMixin(msk.CfnReplicatorMixinProps(
    description="description",
    kafka_clusters=[msk.CfnReplicatorPropsMixin.KafkaClusterProperty(
        amazon_msk_cluster=msk.CfnReplicatorPropsMixin.AmazonMskClusterProperty(
            msk_cluster_arn="mskClusterArn"
        ),
        apache_kafka_cluster=msk.CfnReplicatorPropsMixin.ApacheKafkaClusterProperty(
            apache_kafka_cluster_id="apacheKafkaClusterId",
            bootstrap_broker_string="bootstrapBrokerString"
        ),
        client_authentication=msk.CfnReplicatorPropsMixin.KafkaClusterClientAuthenticationProperty(
            mtls=msk.CfnReplicatorPropsMixin.KafkaClusterMtlsAuthenticationProperty(
                secret_arn="secretArn"
            ),
            sasl_o_auth_bearer=msk.CfnReplicatorPropsMixin.KafkaClusterSaslOAuthBearerAuthenticationProperty(
                client_credentials=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsProperty(
                    token_request_secret_arn="tokenRequestSecretArn"
                ),
                client_credentials_assertion=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsAssertionProperty(
                    audience="audience",
                    signing_algorithm="signingAlgorithm",
                    token_request_secret_arn="tokenRequestSecretArn"
                ),
                iam_jwt_bearer=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthIamJwtBearerProperty(
                    audience="audience",
                    signing_algorithm="signingAlgorithm",
                    token_request_secret_arn="tokenRequestSecretArn"
                ),
                scope="scope",
                token_endpoint_authentication_method="tokenEndpointAuthenticationMethod",
                token_endpoint_tls_certificate_arn="tokenEndpointTlsCertificateArn",
                token_endpoint_url="tokenEndpointUrl"
            ),
            sasl_scram=msk.CfnReplicatorPropsMixin.KafkaClusterSaslScramAuthenticationProperty(
                mechanism="mechanism",
                secret_arn="secretArn"
            )
        ),
        encryption_in_transit=msk.CfnReplicatorPropsMixin.KafkaClusterEncryptionInTransitProperty(
            encryption_type="encryptionType",
            root_ca_certificate="rootCaCertificate"
        ),
        vpc_config=msk.CfnReplicatorPropsMixin.KafkaClusterClientVpcConfigProperty(
            security_group_ids=["securityGroupIds"],
            subnet_ids=["subnetIds"]
        )
    )],
    log_delivery=msk.CfnReplicatorPropsMixin.LogDeliveryProperty(
        replicator_log_delivery=msk.CfnReplicatorPropsMixin.ReplicatorLogDeliveryProperty(
            cloud_watch_logs=msk.CfnReplicatorPropsMixin.CloudWatchLogsProperty(
                enabled=False,
                log_group="logGroup"
            ),
            firehose=msk.CfnReplicatorPropsMixin.FirehoseProperty(
                delivery_stream="deliveryStream",
                enabled=False
            ),
            s3=msk.CfnReplicatorPropsMixin.S3Property(
                bucket="bucket",
                enabled=False,
                prefix="prefix"
            )
        )
    ),
    replication_info_list=[msk.CfnReplicatorPropsMixin.ReplicationInfoProperty(
        consumer_group_replication=msk.CfnReplicatorPropsMixin.ConsumerGroupReplicationProperty(
            consumer_group_offset_sync_mode="consumerGroupOffsetSyncMode",
            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",
        source_kafka_cluster_id="sourceKafkaClusterId",
        target_compression_type="targetCompressionType",
        target_kafka_cluster_arn="targetKafkaClusterArn",
        target_kafka_cluster_id="targetKafkaClusterId",
        topic_replication=msk.CfnReplicatorPropsMixin.TopicReplicationProperty(
            copy_access_control_lists_for_topics=False,
            copy_topic_configurations=False,
            detect_and_copy_new_topics=False,
            starting_position=msk.CfnReplicatorPropsMixin.ReplicationStartingPositionProperty(
                type="type"
            ),
            topic_name_configuration=msk.CfnReplicatorPropsMixin.ReplicationTopicNameConfigurationProperty(
                type="type"
            ),
            topics_to_exclude=["topicsToExclude"],
            topics_to_replicate=["topicsToReplicate"]
        )
    )],
    replicator_name="replicatorName",
    service_execution_role_arn="serviceExecutionRoleArn",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

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

Parameters:

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

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'kafkaClusters', 'logDelivery', 'replicationInfoList', 'replicatorName', 'serviceExecutionRoleArn', 'tags']

Static Methods

classmethod is_mixin(x)

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.

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

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

ApacheKafkaClusterProperty

class CfnReplicatorPropsMixin.ApacheKafkaClusterProperty(*, apache_kafka_cluster_id=None, bootstrap_broker_string=None)

Bases: object

Details of an Apache Kafka cluster.

Parameters:

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

  • bootstrap_broker_string (Optional[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.cfn_property_mixins import aws_msk as msk

apache_kafka_cluster_property = msk.CfnReplicatorPropsMixin.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 CfnReplicatorPropsMixin.CloudWatchLogsProperty(*, enabled=None, log_group=None)

Bases: object

Details about delivering logs to CloudWatch Logs.

Parameters:

  • enabled (Union[bool, IResolvable, None]) – 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.cfn_property_mixins import aws_msk as msk

cloud_watch_logs_property = msk.CfnReplicatorPropsMixin.CloudWatchLogsProperty(
    enabled=False,
    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 CfnReplicatorPropsMixin.ConsumerGroupReplicationProperty(*, consumer_group_offset_sync_mode=None, 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_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.

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

consumer_group_replication_property = msk.CfnReplicatorPropsMixin.ConsumerGroupReplicationProperty(
    consumer_group_offset_sync_mode="consumerGroupOffsetSyncMode",
    consumer_groups_to_exclude=["consumerGroupsToExclude"],
    consumer_groups_to_replicate=["consumerGroupsToReplicate"],
    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 CfnReplicatorPropsMixin.FirehoseProperty(*, delivery_stream=None, enabled=None)

Bases: object

Details about delivering logs to Firehose.

Parameters:

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

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

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

firehose_property = msk.CfnReplicatorPropsMixin.FirehoseProperty(
    delivery_stream="deliveryStream",
    enabled=False
)

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 CfnReplicatorPropsMixin.KafkaClusterClientAuthenticationProperty(*, mtls=None, sasl_o_auth_bearer=None, sasl_scram=None)

Bases: object

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

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

kafka_cluster_client_authentication_property = msk.CfnReplicatorPropsMixin.KafkaClusterClientAuthenticationProperty(
    mtls=msk.CfnReplicatorPropsMixin.KafkaClusterMtlsAuthenticationProperty(
        secret_arn="secretArn"
    ),
    sasl_o_auth_bearer=msk.CfnReplicatorPropsMixin.KafkaClusterSaslOAuthBearerAuthenticationProperty(
        client_credentials=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsProperty(
            token_request_secret_arn="tokenRequestSecretArn"
        ),
        client_credentials_assertion=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsAssertionProperty(
            audience="audience",
            signing_algorithm="signingAlgorithm",
            token_request_secret_arn="tokenRequestSecretArn"
        ),
        iam_jwt_bearer=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthIamJwtBearerProperty(
            audience="audience",
            signing_algorithm="signingAlgorithm",
            token_request_secret_arn="tokenRequestSecretArn"
        ),
        scope="scope",
        token_endpoint_authentication_method="tokenEndpointAuthenticationMethod",
        token_endpoint_tls_certificate_arn="tokenEndpointTlsCertificateArn",
        token_endpoint_url="tokenEndpointUrl"
    ),
    sasl_scram=msk.CfnReplicatorPropsMixin.KafkaClusterSaslScramAuthenticationProperty(
        mechanism="mechanism",
        secret_arn="secretArn"
    )
)

Attributes

mtls

Details for mTLS client authentication.

See:

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

sasl_o_auth_bearer

Details for client authentication using SASL/OAUTHBEARER.

See:

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

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

kafka_cluster_client_vpc_config_property = msk.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

KafkaClusterEncryptionInTransitProperty

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

Bases: object

Details of encryption in transit to the Apache Kafka cluster.

Parameters:

  • encryption_type (Optional[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.cfn_property_mixins import aws_msk as msk

kafka_cluster_encryption_in_transit_property = msk.CfnReplicatorPropsMixin.KafkaClusterEncryptionInTransitProperty(
    encryption_type="encryptionType",
    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

KafkaClusterMtlsAuthenticationProperty

class CfnReplicatorPropsMixin.KafkaClusterMtlsAuthenticationProperty(*, secret_arn=None)

Bases: object

Details for mTLS client authentication.

Parameters:

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

See:

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

kafka_cluster_mtls_authentication_property = msk.CfnReplicatorPropsMixin.KafkaClusterMtlsAuthenticationProperty(
    secret_arn="secretArn"
)

Attributes

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-kafkaclustermtlsauthentication.html#cfn-msk-replicator-kafkaclustermtlsauthentication-secretarn

KafkaClusterOAuthClientCredentialsAssertionProperty

class CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsAssertionProperty(*, audience=None, signing_algorithm=None, token_request_secret_arn=None)

Bases: object

Details for SASL/OAUTHBEARER using the client credentials grant with a JWT client assertion (RFC 7521/7523 Section 2.2). An STS-vended JWT is used as the client_assertion.

Parameters:

  • audience (Optional[str]) – The audience (aud claim) set in the STS JWT client assertion.

  • signing_algorithm (Optional[str]) – The algorithm used to sign the STS JWT assertion.

  • token_request_secret_arn (Optional[str]) – Optional Secrets Manager ARN for identity providers that require client_id as a form parameter alongside the JWT client assertion.

See:

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

kafka_cluster_o_auth_client_credentials_assertion_property = msk.CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsAssertionProperty(
    audience="audience",
    signing_algorithm="signingAlgorithm",
    token_request_secret_arn="tokenRequestSecretArn"
)

Attributes

audience

The audience (aud claim) set in the STS JWT client assertion.

See:

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

signing_algorithm

The algorithm used to sign the STS JWT assertion.

See:

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

token_request_secret_arn

Optional Secrets Manager ARN for identity providers that require client_id as a form parameter alongside the JWT client assertion.

See:

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

KafkaClusterOAuthClientCredentialsProperty

class CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsProperty(*, token_request_secret_arn=None)

Bases: object

Details for SASL/OAUTHBEARER using the standard client_credentials grant.

The referenced secret must contain client_id and client_secret.

Parameters:

token_request_secret_arn (Optional[str]) – Secrets Manager ARN of the secret containing the client_id and client_secret used to obtain an OAuth Bearer token via the client_credentials grant.

See:

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

kafka_cluster_o_auth_client_credentials_property = msk.CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsProperty(
    token_request_secret_arn="tokenRequestSecretArn"
)

Attributes

token_request_secret_arn

Secrets Manager ARN of the secret containing the client_id and client_secret used to obtain an OAuth Bearer token via the client_credentials grant.

See:

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

KafkaClusterOAuthIamJwtBearerProperty

class CfnReplicatorPropsMixin.KafkaClusterOAuthIamJwtBearerProperty(*, audience=None, signing_algorithm=None, token_request_secret_arn=None)

Bases: object

Details for SASL/OAUTHBEARER using the JWT Bearer assertion grant (RFC 7523).

An STS-vended JWT is used as the assertion.

Parameters:

  • audience (Optional[str]) – The audience (aud claim) set in the STS JWT assertion.

  • signing_algorithm (Optional[str]) – The algorithm used to sign the STS JWT assertion.

  • token_request_secret_arn (Optional[str]) – Optional Secrets Manager ARN for identity providers that require client authentication alongside the JWT Bearer assertion.

See:

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

kafka_cluster_o_auth_iam_jwt_bearer_property = msk.CfnReplicatorPropsMixin.KafkaClusterOAuthIamJwtBearerProperty(
    audience="audience",
    signing_algorithm="signingAlgorithm",
    token_request_secret_arn="tokenRequestSecretArn"
)

Attributes

audience

The audience (aud claim) set in the STS JWT assertion.

See:

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

signing_algorithm

The algorithm used to sign the STS JWT assertion.

See:

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

token_request_secret_arn

Optional Secrets Manager ARN for identity providers that require client authentication alongside the JWT Bearer assertion.

See:

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

KafkaClusterProperty

class CfnReplicatorPropsMixin.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.cfn_property_mixins import aws_msk as msk

kafka_cluster_property = msk.CfnReplicatorPropsMixin.KafkaClusterProperty(
    amazon_msk_cluster=msk.CfnReplicatorPropsMixin.AmazonMskClusterProperty(
        msk_cluster_arn="mskClusterArn"
    ),
    apache_kafka_cluster=msk.CfnReplicatorPropsMixin.ApacheKafkaClusterProperty(
        apache_kafka_cluster_id="apacheKafkaClusterId",
        bootstrap_broker_string="bootstrapBrokerString"
    ),
    client_authentication=msk.CfnReplicatorPropsMixin.KafkaClusterClientAuthenticationProperty(
        mtls=msk.CfnReplicatorPropsMixin.KafkaClusterMtlsAuthenticationProperty(
            secret_arn="secretArn"
        ),
        sasl_o_auth_bearer=msk.CfnReplicatorPropsMixin.KafkaClusterSaslOAuthBearerAuthenticationProperty(
            client_credentials=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsProperty(
                token_request_secret_arn="tokenRequestSecretArn"
            ),
            client_credentials_assertion=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsAssertionProperty(
                audience="audience",
                signing_algorithm="signingAlgorithm",
                token_request_secret_arn="tokenRequestSecretArn"
            ),
            iam_jwt_bearer=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthIamJwtBearerProperty(
                audience="audience",
                signing_algorithm="signingAlgorithm",
                token_request_secret_arn="tokenRequestSecretArn"
            ),
            scope="scope",
            token_endpoint_authentication_method="tokenEndpointAuthenticationMethod",
            token_endpoint_tls_certificate_arn="tokenEndpointTlsCertificateArn",
            token_endpoint_url="tokenEndpointUrl"
        ),
        sasl_scram=msk.CfnReplicatorPropsMixin.KafkaClusterSaslScramAuthenticationProperty(
            mechanism="mechanism",
            secret_arn="secretArn"
        )
    ),
    encryption_in_transit=msk.CfnReplicatorPropsMixin.KafkaClusterEncryptionInTransitProperty(
        encryption_type="encryptionType",
        root_ca_certificate="rootCaCertificate"
    ),
    vpc_config=msk.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

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

KafkaClusterSaslOAuthBearerAuthenticationProperty

class CfnReplicatorPropsMixin.KafkaClusterSaslOAuthBearerAuthenticationProperty(*, client_credentials=None, client_credentials_assertion=None, iam_jwt_bearer=None, scope=None, token_endpoint_authentication_method=None, token_endpoint_tls_certificate_arn=None, token_endpoint_url=None)

Bases: object

Details for client authentication using SASL/OAUTHBEARER.

Parameters:

  • client_credentials (Union[IResolvable, KafkaClusterOAuthClientCredentialsProperty, Dict[str, Any], None]) – Details for SASL/OAUTHBEARER using the standard client_credentials grant. The referenced secret must contain client_id and client_secret.

  • client_credentials_assertion (Union[IResolvable, KafkaClusterOAuthClientCredentialsAssertionProperty, Dict[str, Any], None]) – Details for SASL/OAUTHBEARER using the client credentials grant with a JWT client assertion (RFC 7521/7523 Section 2.2). An STS-vended JWT is used as the client_assertion.

  • iam_jwt_bearer (Union[IResolvable, KafkaClusterOAuthIamJwtBearerProperty, Dict[str, Any], None]) – Details for SASL/OAUTHBEARER using the JWT Bearer assertion grant (RFC 7523). An STS-vended JWT is used as the assertion.

  • scope (Optional[str]) – OAuth scope to request. Included in the token request if provided.

  • token_endpoint_authentication_method (Optional[str]) – How client credentials are sent to the identity provider’s token endpoint.

  • token_endpoint_tls_certificate_arn (Optional[str]) – Secrets Manager ARN containing a custom CA certificate for the identity provider. Required only if the identity provider uses a private CA.

  • token_endpoint_url (Optional[str]) – The HTTPS URL of the OAuth token endpoint that vends OAuth Bearer tokens per RFC 6749.

See:

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

kafka_cluster_sasl_o_auth_bearer_authentication_property = msk.CfnReplicatorPropsMixin.KafkaClusterSaslOAuthBearerAuthenticationProperty(
    client_credentials=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsProperty(
        token_request_secret_arn="tokenRequestSecretArn"
    ),
    client_credentials_assertion=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthClientCredentialsAssertionProperty(
        audience="audience",
        signing_algorithm="signingAlgorithm",
        token_request_secret_arn="tokenRequestSecretArn"
    ),
    iam_jwt_bearer=msk.CfnReplicatorPropsMixin.KafkaClusterOAuthIamJwtBearerProperty(
        audience="audience",
        signing_algorithm="signingAlgorithm",
        token_request_secret_arn="tokenRequestSecretArn"
    ),
    scope="scope",
    token_endpoint_authentication_method="tokenEndpointAuthenticationMethod",
    token_endpoint_tls_certificate_arn="tokenEndpointTlsCertificateArn",
    token_endpoint_url="tokenEndpointUrl"
)

Attributes

client_credentials

Details for SASL/OAUTHBEARER using the standard client_credentials grant.

The referenced secret must contain client_id and client_secret.

See:

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

client_credentials_assertion

Details for SASL/OAUTHBEARER using the client credentials grant with a JWT client assertion (RFC 7521/7523 Section 2.2). An STS-vended JWT is used as the client_assertion.

See:

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

iam_jwt_bearer

Details for SASL/OAUTHBEARER using the JWT Bearer assertion grant (RFC 7523).

An STS-vended JWT is used as the assertion.

See:

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

scope

OAuth scope to request.

Included in the token request if provided.

See:

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

token_endpoint_authentication_method

How client credentials are sent to the identity provider’s token endpoint.

See:

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

token_endpoint_tls_certificate_arn

Secrets Manager ARN containing a custom CA certificate for the identity provider.

Required only if the identity provider uses a private CA.

See:

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

token_endpoint_url

The HTTPS URL of the OAuth token endpoint that vends OAuth Bearer tokens per RFC 6749.

See:

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

KafkaClusterSaslScramAuthenticationProperty

class CfnReplicatorPropsMixin.KafkaClusterSaslScramAuthenticationProperty(*, mechanism=None, secret_arn=None)

Bases: object

Details for SASL/SCRAM client authentication.

Parameters:

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

  • secret_arn (Optional[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.cfn_property_mixins import aws_msk as msk

kafka_cluster_sasl_scram_authentication_property = msk.CfnReplicatorPropsMixin.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 CfnReplicatorPropsMixin.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.cfn_property_mixins import aws_msk as msk

log_delivery_property = msk.CfnReplicatorPropsMixin.LogDeliveryProperty(
    replicator_log_delivery=msk.CfnReplicatorPropsMixin.ReplicatorLogDeliveryProperty(
        cloud_watch_logs=msk.CfnReplicatorPropsMixin.CloudWatchLogsProperty(
            enabled=False,
            log_group="logGroup"
        ),
        firehose=msk.CfnReplicatorPropsMixin.FirehoseProperty(
            delivery_stream="deliveryStream",
            enabled=False
        ),
        s3=msk.CfnReplicatorPropsMixin.S3Property(
            bucket="bucket",
            enabled=False,
            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 CfnReplicatorPropsMixin.ReplicationInfoProperty(*, consumer_group_replication=None, source_kafka_cluster_arn=None, source_kafka_cluster_id=None, target_compression_type=None, target_kafka_cluster_arn=None, target_kafka_cluster_id=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.

  • source_kafka_cluster_id (Optional[str]) – The ID 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.

  • target_kafka_cluster_id (Optional[str]) – The ID 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.cfn_property_mixins import aws_msk as msk

replication_info_property = msk.CfnReplicatorPropsMixin.ReplicationInfoProperty(
    consumer_group_replication=msk.CfnReplicatorPropsMixin.ConsumerGroupReplicationProperty(
        consumer_group_offset_sync_mode="consumerGroupOffsetSyncMode",
        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",
    source_kafka_cluster_id="sourceKafkaClusterId",
    target_compression_type="targetCompressionType",
    target_kafka_cluster_arn="targetKafkaClusterArn",
    target_kafka_cluster_id="targetKafkaClusterId",
    topic_replication=msk.CfnReplicatorPropsMixin.TopicReplicationProperty(
        copy_access_control_lists_for_topics=False,
        copy_topic_configurations=False,
        detect_and_copy_new_topics=False,
        starting_position=msk.CfnReplicatorPropsMixin.ReplicationStartingPositionProperty(
            type="type"
        ),
        topic_name_configuration=msk.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

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

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

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

ReplicatorLogDeliveryProperty

class CfnReplicatorPropsMixin.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.cfn_property_mixins import aws_msk as msk

replicator_log_delivery_property = msk.CfnReplicatorPropsMixin.ReplicatorLogDeliveryProperty(
    cloud_watch_logs=msk.CfnReplicatorPropsMixin.CloudWatchLogsProperty(
        enabled=False,
        log_group="logGroup"
    ),
    firehose=msk.CfnReplicatorPropsMixin.FirehoseProperty(
        delivery_stream="deliveryStream",
        enabled=False
    ),
    s3=msk.CfnReplicatorPropsMixin.S3Property(
        bucket="bucket",
        enabled=False,
        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 CfnReplicatorPropsMixin.S3Property(*, bucket=None, enabled=None, prefix=None)

Bases: object

Details about delivering logs to S3.

Parameters:

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

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

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

s3_property = msk.CfnReplicatorPropsMixin.S3Property(
    bucket="bucket",
    enabled=False,
    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 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.cfn_property_mixins import aws_msk as msk

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

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