AWS::MSK::Replicator - AWS CloudFormation

AWS::MSK::Replicator

Creates the replicator.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::MSK::Replicator", "Properties" : { "CurrentVersion" : String, "Description" : String, "KafkaClusters" : [ KafkaCluster, ... ], "ReplicationInfoList" : [ ReplicationInfo, ... ], "ReplicatorName" : String, "ServiceExecutionRoleArn" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::MSK::Replicator Properties: CurrentVersion: String Description: String KafkaClusters: - KafkaCluster ReplicationInfoList: - ReplicationInfo ReplicatorName: String ServiceExecutionRoleArn: String Tags: - Tag

Properties

CurrentVersion

The current version number of the replicator.

Required: No

Type: String

Update requires: No interruption

Description

A summary description of the replicator.

Required: No

Type: String

Maximum: 1024

Update requires: Replacement

KafkaClusters

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

Required: Yes

Type: Array of KafkaCluster

Minimum: 2

Maximum: 2

Update requires: Replacement

ReplicationInfoList

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

Required: Yes

Type: Array of ReplicationInfo

Minimum: 1

Maximum: 1

Update requires: No interruption

ReplicatorName

The name of the replicator. Alpha-numeric characters with '-' are allowed.

Required: Yes

Type: String

Pattern: ^[0-9A-Za-z][0-9A-Za-z-]{0,}$

Minimum: 1

Maximum: 128

Update requires: Replacement

ServiceExecutionRoleArn

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

Required: Yes

Type: String

Pattern: arn:(aws|aws-us-gov|aws-cn):iam:.*

Update requires: Replacement

Tags

List of tags to attach to created Replicator.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ReplicatorArn

Amazon Resource Name (ARN) for the created replicator.