AWS::MSK::Replicator

MSK Replicator

Resource Type definition for AWS::MSK::Replicator

Properties

6 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`KafkaClusters`	`Array<KafkaCluster>`	RequiredCreate-only
`ReplicationInfoList`	`Array<ReplicationInfo>`	Required
`ReplicatorName`	`string`	RequiredCreate-only
`ServiceExecutionRoleArn`	`string`	RequiredCreate-only
`Description`	`string`	Create-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CurrentVersion`	`string`	The current version of the MSK replicator.
`ReplicatorArn`	`string`	Amazon Resource Name for the created replicator.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::MSK::Replicator

Resources:
  MyResource:
    Type: AWS::MSK::Replicator
    Properties:
      ReplicatorName: "my-replicatorname"
      ReplicationInfoList: []
      KafkaClusters: []
      ServiceExecutionRoleArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

ec2:CreateNetworkInterfaceec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcsiam:CreateServiceLinkedRoleiam:PassRolekafka:CreateReplicatorkafka:CreateReplicatorReference

read

kafka:DescribeReplicatorkafka:ListTagsForResource

update

kafka:DescribeReplicatorkafka:ListTagsForResourcekafka:TagResourcekafka:UntagResourcekafka:UpdateReplicationInfo

delete

kafka:DeleteReplicatorkafka:DescribeReplicatorkafka:ListTagsForResourcekafka:UntagResource

list

kafka:ListReplicators

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceMSK

Properties8

Required4

TaggingSupported

Primary IDReplicatorArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ReplicatorNameDescriptionKafkaClustersServiceExecutionRoleArnReplicationInfoList/*/SourceKafkaClusterArnReplicationInfoList/*/TargetKafkaClusterArnReplicationInfoList/*/TargetCompressionTypeReplicationInfoList/*/TopicReplication/StartingPositionReplicationInfoList/*/TopicReplication/TopicNameConfiguration

Related Resources

External Links

AWS Documentation