aws.msk.Replicator
Explore with Pulumi AI
Resource for managing an AWS Managed Streaming for Kafka Replicator.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.msk.Replicator("test", {
replicatorName: "test-name",
description: "test-description",
serviceExecutionRoleArn: sourceAwsIamRole.arn,
kafkaClusters: [
{
amazonMskCluster: {
mskClusterArn: source.arn,
},
vpcConfig: {
subnetIds: sourceAwsSubnet.map(__item => __item.id),
securityGroupsIds: [sourceAwsSecurityGroup.id],
},
},
{
amazonMskCluster: {
mskClusterArn: target.arn,
},
vpcConfig: {
subnetIds: targetAwsSubnet.map(__item => __item.id),
securityGroupsIds: [targetAwsSecurityGroup.id],
},
},
],
replicationInfoList: {
sourceKafkaClusterArn: source.arn,
targetKafkaClusterArn: target.arn,
targetCompressionType: "NONE",
topicReplications: [{
topicsToReplicates: [".*"],
startingPosition: {
type: "LATEST",
},
}],
consumerGroupReplications: [{
consumerGroupsToReplicates: [".*"],
}],
},
});
import pulumi
import pulumi_aws as aws
test = aws.msk.Replicator("test",
replicator_name="test-name",
description="test-description",
service_execution_role_arn=source_aws_iam_role["arn"],
kafka_clusters=[
{
"amazon_msk_cluster": {
"msk_cluster_arn": source["arn"],
},
"vpc_config": {
"subnet_ids": [__item["id"] for __item in source_aws_subnet],
"security_groups_ids": [source_aws_security_group["id"]],
},
},
{
"amazon_msk_cluster": {
"msk_cluster_arn": target["arn"],
},
"vpc_config": {
"subnet_ids": [__item["id"] for __item in target_aws_subnet],
"security_groups_ids": [target_aws_security_group["id"]],
},
},
],
replication_info_list={
"source_kafka_cluster_arn": source["arn"],
"target_kafka_cluster_arn": target["arn"],
"target_compression_type": "NONE",
"topic_replications": [{
"topics_to_replicates": [".*"],
"starting_position": {
"type": "LATEST",
},
}],
"consumer_group_replications": [{
"consumer_groups_to_replicates": [".*"],
}],
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/msk"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := msk.NewReplicator(ctx, "test", &msk.ReplicatorArgs{
ReplicatorName: pulumi.String("test-name"),
Description: pulumi.String("test-description"),
ServiceExecutionRoleArn: pulumi.Any(sourceAwsIamRole.Arn),
KafkaClusters: msk.ReplicatorKafkaClusterArray{
&msk.ReplicatorKafkaClusterArgs{
AmazonMskCluster: &msk.ReplicatorKafkaClusterAmazonMskClusterArgs{
MskClusterArn: pulumi.Any(source.Arn),
},
VpcConfig: &msk.ReplicatorKafkaClusterVpcConfigArgs{
SubnetIds: []pulumi.String(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:9,27-48)),
SecurityGroupsIds: pulumi.StringArray{
sourceAwsSecurityGroup.Id,
},
},
},
&msk.ReplicatorKafkaClusterArgs{
AmazonMskCluster: &msk.ReplicatorKafkaClusterAmazonMskClusterArgs{
MskClusterArn: pulumi.Any(target.Arn),
},
VpcConfig: &msk.ReplicatorKafkaClusterVpcConfigArgs{
SubnetIds: []pulumi.String(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:17,27-48)),
SecurityGroupsIds: pulumi.StringArray{
targetAwsSecurityGroup.Id,
},
},
},
},
ReplicationInfoList: &msk.ReplicatorReplicationInfoListArgs{
SourceKafkaClusterArn: pulumi.Any(source.Arn),
TargetKafkaClusterArn: pulumi.Any(target.Arn),
TargetCompressionType: pulumi.String("NONE"),
TopicReplications: msk.ReplicatorReplicationInfoListTopicReplicationArray{
&msk.ReplicatorReplicationInfoListTopicReplicationArgs{
TopicsToReplicates: pulumi.StringArray{
pulumi.String(".*"),
},
StartingPosition: &msk.ReplicatorReplicationInfoListTopicReplicationStartingPositionArgs{
Type: pulumi.String("LATEST"),
},
},
},
ConsumerGroupReplications: msk.ReplicatorReplicationInfoListConsumerGroupReplicationArray{
&msk.ReplicatorReplicationInfoListConsumerGroupReplicationArgs{
ConsumerGroupsToReplicates: pulumi.StringArray{
pulumi.String(".*"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Msk.Replicator("test", new()
{
ReplicatorName = "test-name",
Description = "test-description",
ServiceExecutionRoleArn = sourceAwsIamRole.Arn,
KafkaClusters = new[]
{
new Aws.Msk.Inputs.ReplicatorKafkaClusterArgs
{
AmazonMskCluster = new Aws.Msk.Inputs.ReplicatorKafkaClusterAmazonMskClusterArgs
{
MskClusterArn = source.Arn,
},
VpcConfig = new Aws.Msk.Inputs.ReplicatorKafkaClusterVpcConfigArgs
{
SubnetIds = sourceAwsSubnet.Select(__item => __item.Id).ToList(),
SecurityGroupsIds = new[]
{
sourceAwsSecurityGroup.Id,
},
},
},
new Aws.Msk.Inputs.ReplicatorKafkaClusterArgs
{
AmazonMskCluster = new Aws.Msk.Inputs.ReplicatorKafkaClusterAmazonMskClusterArgs
{
MskClusterArn = target.Arn,
},
VpcConfig = new Aws.Msk.Inputs.ReplicatorKafkaClusterVpcConfigArgs
{
SubnetIds = targetAwsSubnet.Select(__item => __item.Id).ToList(),
SecurityGroupsIds = new[]
{
targetAwsSecurityGroup.Id,
},
},
},
},
ReplicationInfoList = new Aws.Msk.Inputs.ReplicatorReplicationInfoListArgs
{
SourceKafkaClusterArn = source.Arn,
TargetKafkaClusterArn = target.Arn,
TargetCompressionType = "NONE",
TopicReplications = new[]
{
new Aws.Msk.Inputs.ReplicatorReplicationInfoListTopicReplicationArgs
{
TopicsToReplicates = new[]
{
".*",
},
StartingPosition = new Aws.Msk.Inputs.ReplicatorReplicationInfoListTopicReplicationStartingPositionArgs
{
Type = "LATEST",
},
},
},
ConsumerGroupReplications = new[]
{
new Aws.Msk.Inputs.ReplicatorReplicationInfoListConsumerGroupReplicationArgs
{
ConsumerGroupsToReplicates = new[]
{
".*",
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.msk.Replicator;
import com.pulumi.aws.msk.ReplicatorArgs;
import com.pulumi.aws.msk.inputs.ReplicatorKafkaClusterArgs;
import com.pulumi.aws.msk.inputs.ReplicatorKafkaClusterAmazonMskClusterArgs;
import com.pulumi.aws.msk.inputs.ReplicatorKafkaClusterVpcConfigArgs;
import com.pulumi.aws.msk.inputs.ReplicatorReplicationInfoListArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new Replicator("test", ReplicatorArgs.builder()
.replicatorName("test-name")
.description("test-description")
.serviceExecutionRoleArn(sourceAwsIamRole.arn())
.kafkaClusters(
ReplicatorKafkaClusterArgs.builder()
.amazonMskCluster(ReplicatorKafkaClusterAmazonMskClusterArgs.builder()
.mskClusterArn(source.arn())
.build())
.vpcConfig(ReplicatorKafkaClusterVpcConfigArgs.builder()
.subnetIds(sourceAwsSubnet.stream().map(element -> element.id()).collect(toList()))
.securityGroupsIds(sourceAwsSecurityGroup.id())
.build())
.build(),
ReplicatorKafkaClusterArgs.builder()
.amazonMskCluster(ReplicatorKafkaClusterAmazonMskClusterArgs.builder()
.mskClusterArn(target.arn())
.build())
.vpcConfig(ReplicatorKafkaClusterVpcConfigArgs.builder()
.subnetIds(targetAwsSubnet.stream().map(element -> element.id()).collect(toList()))
.securityGroupsIds(targetAwsSecurityGroup.id())
.build())
.build())
.replicationInfoList(ReplicatorReplicationInfoListArgs.builder()
.sourceKafkaClusterArn(source.arn())
.targetKafkaClusterArn(target.arn())
.targetCompressionType("NONE")
.topicReplications(ReplicatorReplicationInfoListTopicReplicationArgs.builder()
.topicsToReplicates(".*")
.startingPosition(ReplicatorReplicationInfoListTopicReplicationStartingPositionArgs.builder()
.type("LATEST")
.build())
.build())
.consumerGroupReplications(ReplicatorReplicationInfoListConsumerGroupReplicationArgs.builder()
.consumerGroupsToReplicates(".*")
.build())
.build())
.build());
}
}
Coming soon!
Create Replicator Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Replicator(name: string, args: ReplicatorArgs, opts?: CustomResourceOptions);
@overload
def Replicator(resource_name: str,
args: ReplicatorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Replicator(resource_name: str,
opts: Optional[ResourceOptions] = None,
kafka_clusters: Optional[Sequence[ReplicatorKafkaClusterArgs]] = None,
replication_info_list: Optional[ReplicatorReplicationInfoListArgs] = None,
replicator_name: Optional[str] = None,
service_execution_role_arn: Optional[str] = None,
description: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewReplicator(ctx *Context, name string, args ReplicatorArgs, opts ...ResourceOption) (*Replicator, error)
public Replicator(string name, ReplicatorArgs args, CustomResourceOptions? opts = null)
public Replicator(String name, ReplicatorArgs args)
public Replicator(String name, ReplicatorArgs args, CustomResourceOptions options)
type: aws:msk:Replicator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ReplicatorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ReplicatorArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ReplicatorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ReplicatorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ReplicatorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var replicatorResource = new Aws.Msk.Replicator("replicatorResource", new()
{
KafkaClusters = new[]
{
new Aws.Msk.Inputs.ReplicatorKafkaClusterArgs
{
AmazonMskCluster = new Aws.Msk.Inputs.ReplicatorKafkaClusterAmazonMskClusterArgs
{
MskClusterArn = "string",
},
VpcConfig = new Aws.Msk.Inputs.ReplicatorKafkaClusterVpcConfigArgs
{
SubnetIds = new[]
{
"string",
},
SecurityGroupsIds = new[]
{
"string",
},
},
},
},
ReplicationInfoList = new Aws.Msk.Inputs.ReplicatorReplicationInfoListArgs
{
ConsumerGroupReplications = new[]
{
new Aws.Msk.Inputs.ReplicatorReplicationInfoListConsumerGroupReplicationArgs
{
ConsumerGroupsToReplicates = new[]
{
"string",
},
ConsumerGroupsToExcludes = new[]
{
"string",
},
DetectAndCopyNewConsumerGroups = false,
SynchroniseConsumerGroupOffsets = false,
},
},
SourceKafkaClusterArn = "string",
TargetCompressionType = "string",
TargetKafkaClusterArn = "string",
TopicReplications = new[]
{
new Aws.Msk.Inputs.ReplicatorReplicationInfoListTopicReplicationArgs
{
TopicsToReplicates = new[]
{
"string",
},
CopyAccessControlListsForTopics = false,
CopyTopicConfigurations = false,
DetectAndCopyNewTopics = false,
StartingPosition = new Aws.Msk.Inputs.ReplicatorReplicationInfoListTopicReplicationStartingPositionArgs
{
Type = "string",
},
TopicsToExcludes = new[]
{
"string",
},
},
},
SourceKafkaClusterAlias = "string",
TargetKafkaClusterAlias = "string",
},
ReplicatorName = "string",
ServiceExecutionRoleArn = "string",
Description = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := msk.NewReplicator(ctx, "replicatorResource", &msk.ReplicatorArgs{
KafkaClusters: msk.ReplicatorKafkaClusterArray{
&msk.ReplicatorKafkaClusterArgs{
AmazonMskCluster: &msk.ReplicatorKafkaClusterAmazonMskClusterArgs{
MskClusterArn: pulumi.String("string"),
},
VpcConfig: &msk.ReplicatorKafkaClusterVpcConfigArgs{
SubnetIds: pulumi.StringArray{
pulumi.String("string"),
},
SecurityGroupsIds: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
ReplicationInfoList: &msk.ReplicatorReplicationInfoListArgs{
ConsumerGroupReplications: msk.ReplicatorReplicationInfoListConsumerGroupReplicationArray{
&msk.ReplicatorReplicationInfoListConsumerGroupReplicationArgs{
ConsumerGroupsToReplicates: pulumi.StringArray{
pulumi.String("string"),
},
ConsumerGroupsToExcludes: pulumi.StringArray{
pulumi.String("string"),
},
DetectAndCopyNewConsumerGroups: pulumi.Bool(false),
SynchroniseConsumerGroupOffsets: pulumi.Bool(false),
},
},
SourceKafkaClusterArn: pulumi.String("string"),
TargetCompressionType: pulumi.String("string"),
TargetKafkaClusterArn: pulumi.String("string"),
TopicReplications: msk.ReplicatorReplicationInfoListTopicReplicationArray{
&msk.ReplicatorReplicationInfoListTopicReplicationArgs{
TopicsToReplicates: pulumi.StringArray{
pulumi.String("string"),
},
CopyAccessControlListsForTopics: pulumi.Bool(false),
CopyTopicConfigurations: pulumi.Bool(false),
DetectAndCopyNewTopics: pulumi.Bool(false),
StartingPosition: &msk.ReplicatorReplicationInfoListTopicReplicationStartingPositionArgs{
Type: pulumi.String("string"),
},
TopicsToExcludes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
SourceKafkaClusterAlias: pulumi.String("string"),
TargetKafkaClusterAlias: pulumi.String("string"),
},
ReplicatorName: pulumi.String("string"),
ServiceExecutionRoleArn: pulumi.String("string"),
Description: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var replicatorResource = new Replicator("replicatorResource", ReplicatorArgs.builder()
.kafkaClusters(ReplicatorKafkaClusterArgs.builder()
.amazonMskCluster(ReplicatorKafkaClusterAmazonMskClusterArgs.builder()
.mskClusterArn("string")
.build())
.vpcConfig(ReplicatorKafkaClusterVpcConfigArgs.builder()
.subnetIds("string")
.securityGroupsIds("string")
.build())
.build())
.replicationInfoList(ReplicatorReplicationInfoListArgs.builder()
.consumerGroupReplications(ReplicatorReplicationInfoListConsumerGroupReplicationArgs.builder()
.consumerGroupsToReplicates("string")
.consumerGroupsToExcludes("string")
.detectAndCopyNewConsumerGroups(false)
.synchroniseConsumerGroupOffsets(false)
.build())
.sourceKafkaClusterArn("string")
.targetCompressionType("string")
.targetKafkaClusterArn("string")
.topicReplications(ReplicatorReplicationInfoListTopicReplicationArgs.builder()
.topicsToReplicates("string")
.copyAccessControlListsForTopics(false)
.copyTopicConfigurations(false)
.detectAndCopyNewTopics(false)
.startingPosition(ReplicatorReplicationInfoListTopicReplicationStartingPositionArgs.builder()
.type("string")
.build())
.topicsToExcludes("string")
.build())
.sourceKafkaClusterAlias("string")
.targetKafkaClusterAlias("string")
.build())
.replicatorName("string")
.serviceExecutionRoleArn("string")
.description("string")
.tags(Map.of("string", "string"))
.build());
replicator_resource = aws.msk.Replicator("replicatorResource",
kafka_clusters=[{
"amazon_msk_cluster": {
"msk_cluster_arn": "string",
},
"vpc_config": {
"subnet_ids": ["string"],
"security_groups_ids": ["string"],
},
}],
replication_info_list={
"consumer_group_replications": [{
"consumer_groups_to_replicates": ["string"],
"consumer_groups_to_excludes": ["string"],
"detect_and_copy_new_consumer_groups": False,
"synchronise_consumer_group_offsets": False,
}],
"source_kafka_cluster_arn": "string",
"target_compression_type": "string",
"target_kafka_cluster_arn": "string",
"topic_replications": [{
"topics_to_replicates": ["string"],
"copy_access_control_lists_for_topics": False,
"copy_topic_configurations": False,
"detect_and_copy_new_topics": False,
"starting_position": {
"type": "string",
},
"topics_to_excludes": ["string"],
}],
"source_kafka_cluster_alias": "string",
"target_kafka_cluster_alias": "string",
},
replicator_name="string",
service_execution_role_arn="string",
description="string",
tags={
"string": "string",
})
const replicatorResource = new aws.msk.Replicator("replicatorResource", {
kafkaClusters: [{
amazonMskCluster: {
mskClusterArn: "string",
},
vpcConfig: {
subnetIds: ["string"],
securityGroupsIds: ["string"],
},
}],
replicationInfoList: {
consumerGroupReplications: [{
consumerGroupsToReplicates: ["string"],
consumerGroupsToExcludes: ["string"],
detectAndCopyNewConsumerGroups: false,
synchroniseConsumerGroupOffsets: false,
}],
sourceKafkaClusterArn: "string",
targetCompressionType: "string",
targetKafkaClusterArn: "string",
topicReplications: [{
topicsToReplicates: ["string"],
copyAccessControlListsForTopics: false,
copyTopicConfigurations: false,
detectAndCopyNewTopics: false,
startingPosition: {
type: "string",
},
topicsToExcludes: ["string"],
}],
sourceKafkaClusterAlias: "string",
targetKafkaClusterAlias: "string",
},
replicatorName: "string",
serviceExecutionRoleArn: "string",
description: "string",
tags: {
string: "string",
},
});
type: aws:msk:Replicator
properties:
description: string
kafkaClusters:
- amazonMskCluster:
mskClusterArn: string
vpcConfig:
securityGroupsIds:
- string
subnetIds:
- string
replicationInfoList:
consumerGroupReplications:
- consumerGroupsToExcludes:
- string
consumerGroupsToReplicates:
- string
detectAndCopyNewConsumerGroups: false
synchroniseConsumerGroupOffsets: false
sourceKafkaClusterAlias: string
sourceKafkaClusterArn: string
targetCompressionType: string
targetKafkaClusterAlias: string
targetKafkaClusterArn: string
topicReplications:
- copyAccessControlListsForTopics: false
copyTopicConfigurations: false
detectAndCopyNewTopics: false
startingPosition:
type: string
topicsToExcludes:
- string
topicsToReplicates:
- string
replicatorName: string
serviceExecutionRoleArn: string
tags:
string: string
Replicator Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Replicator resource accepts the following input properties:
- Kafka
Clusters List<ReplicatorKafka Cluster> - A list of Kafka clusters which are targets of the replicator.
- Replication
Info ReplicatorList Replication Info List - A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- Replicator
Name string - The name of the replicator.
- Service
Execution stringRole 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).
- Description string
- A summary description of the replicator.
- Dictionary<string, string>
- Kafka
Clusters []ReplicatorKafka Cluster Args - A list of Kafka clusters which are targets of the replicator.
- Replication
Info ReplicatorList Replication Info List Args - A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- Replicator
Name string - The name of the replicator.
- Service
Execution stringRole 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).
- Description string
- A summary description of the replicator.
- map[string]string
- kafka
Clusters List<ReplicatorKafka Cluster> - A list of Kafka clusters which are targets of the replicator.
- replication
Info ReplicatorList Replication Info List - A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- replicator
Name String - The name of the replicator.
- service
Execution StringRole 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).
- description String
- A summary description of the replicator.
- Map<String,String>
- kafka
Clusters ReplicatorKafka Cluster[] - A list of Kafka clusters which are targets of the replicator.
- replication
Info ReplicatorList Replication Info List - A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- replicator
Name string - The name of the replicator.
- service
Execution stringRole 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).
- description string
- A summary description of the replicator.
- {[key: string]: string}
- kafka_
clusters Sequence[ReplicatorKafka Cluster Args] - A list of Kafka clusters which are targets of the replicator.
- replication_
info_ Replicatorlist Replication Info List Args - 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.
- service_
execution_ strrole_ 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).
- description str
- A summary description of the replicator.
- Mapping[str, str]
- kafka
Clusters List<Property Map> - A list of Kafka clusters which are targets of the replicator.
- replication
Info Property MapList - A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- replicator
Name String - The name of the replicator.
- service
Execution StringRole 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).
- description String
- A summary description of the replicator.
- Map<String>
Outputs
All input properties are implicitly available as output properties. Additionally, the Replicator resource produces the following output properties:
- Arn string
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- Current
Version string - Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- Arn string
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- Current
Version string - Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- arn String
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- current
Version String - id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- arn string
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- current
Version string - id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- arn str
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- current_
version str - id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- arn String
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- current
Version String - id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
Look up Existing Replicator Resource
Get an existing Replicator resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ReplicatorState, opts?: CustomResourceOptions): Replicator
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
current_version: Optional[str] = None,
description: Optional[str] = None,
kafka_clusters: Optional[Sequence[ReplicatorKafkaClusterArgs]] = None,
replication_info_list: Optional[ReplicatorReplicationInfoListArgs] = None,
replicator_name: Optional[str] = None,
service_execution_role_arn: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> Replicator
func GetReplicator(ctx *Context, name string, id IDInput, state *ReplicatorState, opts ...ResourceOption) (*Replicator, error)
public static Replicator Get(string name, Input<string> id, ReplicatorState? state, CustomResourceOptions? opts = null)
public static Replicator get(String name, Output<String> id, ReplicatorState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- Current
Version string - Description string
- A summary description of the replicator.
- Kafka
Clusters List<ReplicatorKafka Cluster> - A list of Kafka clusters which are targets of the replicator.
- Replication
Info ReplicatorList Replication Info List - A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- Replicator
Name string - The name of the replicator.
- Service
Execution stringRole 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).
- Dictionary<string, string>
- Dictionary<string, string>
- Arn string
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- Current
Version string - Description string
- A summary description of the replicator.
- Kafka
Clusters []ReplicatorKafka Cluster Args - A list of Kafka clusters which are targets of the replicator.
- Replication
Info ReplicatorList Replication Info List Args - A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- Replicator
Name string - The name of the replicator.
- Service
Execution stringRole 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).
- map[string]string
- map[string]string
- arn String
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- current
Version String - description String
- A summary description of the replicator.
- kafka
Clusters List<ReplicatorKafka Cluster> - A list of Kafka clusters which are targets of the replicator.
- replication
Info ReplicatorList Replication Info List - A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- replicator
Name String - The name of the replicator.
- service
Execution StringRole 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).
- Map<String,String>
- Map<String,String>
- arn string
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- current
Version string - description string
- A summary description of the replicator.
- kafka
Clusters ReplicatorKafka Cluster[] - A list of Kafka clusters which are targets of the replicator.
- replication
Info ReplicatorList Replication Info List - A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- replicator
Name string - The name of the replicator.
- service
Execution stringRole 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).
- {[key: string]: string}
- {[key: string]: string}
- arn str
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- current_
version str - description str
- A summary description of the replicator.
- kafka_
clusters Sequence[ReplicatorKafka Cluster Args] - A list of Kafka clusters which are targets of the replicator.
- replication_
info_ Replicatorlist Replication Info List Args - 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.
- service_
execution_ strrole_ 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).
- Mapping[str, str]
- Mapping[str, str]
- arn String
- ARN of the Replicator. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information.
- current
Version String - description String
- A summary description of the replicator.
- kafka
Clusters List<Property Map> - A list of Kafka clusters which are targets of the replicator.
- replication
Info Property MapList - A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- replicator
Name String - The name of the replicator.
- service
Execution StringRole 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).
- Map<String>
- Map<String>
Supporting Types
ReplicatorKafkaCluster, ReplicatorKafkaClusterArgs
- Amazon
Msk ReplicatorCluster Kafka Cluster Amazon Msk Cluster - Details of an Amazon MSK cluster.
- Vpc
Config ReplicatorKafka Cluster Vpc Config - Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
- Amazon
Msk ReplicatorCluster Kafka Cluster Amazon Msk Cluster - Details of an Amazon MSK cluster.
- Vpc
Config ReplicatorKafka Cluster Vpc Config - Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
- amazon
Msk ReplicatorCluster Kafka Cluster Amazon Msk Cluster - Details of an Amazon MSK cluster.
- vpc
Config ReplicatorKafka Cluster Vpc Config - Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
- amazon
Msk ReplicatorCluster Kafka Cluster Amazon Msk Cluster - Details of an Amazon MSK cluster.
- vpc
Config ReplicatorKafka Cluster Vpc Config - Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
- amazon_
msk_ Replicatorcluster Kafka Cluster Amazon Msk Cluster - Details of an Amazon MSK cluster.
- vpc_
config ReplicatorKafka Cluster Vpc Config - Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
- amazon
Msk Property MapCluster - Details of an Amazon MSK cluster.
- vpc
Config Property Map - Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
ReplicatorKafkaClusterAmazonMskCluster, ReplicatorKafkaClusterAmazonMskClusterArgs
- Msk
Cluster stringArn - The ARN of an Amazon MSK cluster.
- Msk
Cluster stringArn - The ARN of an Amazon MSK cluster.
- msk
Cluster StringArn - The ARN of an Amazon MSK cluster.
- msk
Cluster stringArn - The ARN of an Amazon MSK cluster.
- msk_
cluster_ strarn - The ARN of an Amazon MSK cluster.
- msk
Cluster StringArn - The ARN of an Amazon MSK cluster.
ReplicatorKafkaClusterVpcConfig, ReplicatorKafkaClusterVpcConfigArgs
- Subnet
Ids List<string> - The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets to allow communication between your Kafka Cluster and the replicator.
- Security
Groups List<string>Ids - The AWS security groups to associate with the ENIs used by the replicator. If a security group is not specified, the default security group associated with the VPC is used.
- Subnet
Ids []string - The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets to allow communication between your Kafka Cluster and the replicator.
- Security
Groups []stringIds - The AWS security groups to associate with the ENIs used by the replicator. If a security group is not specified, the default security group associated with the VPC is used.
- subnet
Ids List<String> - The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets to allow communication between your Kafka Cluster and the replicator.
- security
Groups List<String>Ids - The AWS security groups to associate with the ENIs used by the replicator. If a security group is not specified, the default security group associated with the VPC is used.
- subnet
Ids string[] - The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets to allow communication between your Kafka Cluster and the replicator.
- security
Groups string[]Ids - The AWS security groups to associate with the ENIs used by the replicator. If a security group is not specified, the default security group associated with the VPC is used.
- subnet_
ids Sequence[str] - The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets to allow communication between your Kafka Cluster and the replicator.
- security_
groups_ Sequence[str]ids - The AWS security groups to associate with the ENIs used by the replicator. If a security group is not specified, the default security group associated with the VPC is used.
- subnet
Ids List<String> - The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets to allow communication between your Kafka Cluster and the replicator.
- security
Groups List<String>Ids - The AWS security groups to associate with the ENIs used by the replicator. If a security group is not specified, the default security group associated with the VPC is used.
ReplicatorReplicationInfoList, ReplicatorReplicationInfoListArgs
- Consumer
Group List<ReplicatorReplications Replication Info List Consumer Group Replication> - Configuration relating to consumer group replication.
- Source
Kafka stringCluster Arn - The ARN of the source Kafka cluster.
- Target
Compression stringType - The type of compression to use writing records to target Kafka cluster.
- Target
Kafka stringCluster Arn - The ARN of the target Kafka cluster.
- Topic
Replications List<ReplicatorReplication Info List Topic Replication> - Configuration relating to topic replication.
- Source
Kafka stringCluster Alias - Target
Kafka stringCluster Alias
- Consumer
Group []ReplicatorReplications Replication Info List Consumer Group Replication - Configuration relating to consumer group replication.
- Source
Kafka stringCluster Arn - The ARN of the source Kafka cluster.
- Target
Compression stringType - The type of compression to use writing records to target Kafka cluster.
- Target
Kafka stringCluster Arn - The ARN of the target Kafka cluster.
- Topic
Replications []ReplicatorReplication Info List Topic Replication - Configuration relating to topic replication.
- Source
Kafka stringCluster Alias - Target
Kafka stringCluster Alias
- consumer
Group List<ReplicatorReplications Replication Info List Consumer Group Replication> - Configuration relating to consumer group replication.
- source
Kafka StringCluster Arn - The ARN of the source Kafka cluster.
- target
Compression StringType - The type of compression to use writing records to target Kafka cluster.
- target
Kafka StringCluster Arn - The ARN of the target Kafka cluster.
- topic
Replications List<ReplicatorReplication Info List Topic Replication> - Configuration relating to topic replication.
- source
Kafka StringCluster Alias - target
Kafka StringCluster Alias
- consumer
Group ReplicatorReplications Replication Info List Consumer Group Replication[] - Configuration relating to consumer group replication.
- source
Kafka stringCluster Arn - The ARN of the source Kafka cluster.
- target
Compression stringType - The type of compression to use writing records to target Kafka cluster.
- target
Kafka stringCluster Arn - The ARN of the target Kafka cluster.
- topic
Replications ReplicatorReplication Info List Topic Replication[] - Configuration relating to topic replication.
- source
Kafka stringCluster Alias - target
Kafka stringCluster Alias
- consumer_
group_ Sequence[Replicatorreplications Replication Info List Consumer Group Replication] - Configuration relating to consumer group replication.
- source_
kafka_ strcluster_ arn - The ARN of the source Kafka cluster.
- target_
compression_ strtype - The type of compression to use writing records to target Kafka cluster.
- target_
kafka_ strcluster_ arn - The ARN of the target Kafka cluster.
- topic_
replications Sequence[ReplicatorReplication Info List Topic Replication] - Configuration relating to topic replication.
- source_
kafka_ strcluster_ alias - target_
kafka_ strcluster_ alias
- consumer
Group List<Property Map>Replications - Configuration relating to consumer group replication.
- source
Kafka StringCluster Arn - The ARN of the source Kafka cluster.
- target
Compression StringType - The type of compression to use writing records to target Kafka cluster.
- target
Kafka StringCluster Arn - The ARN of the target Kafka cluster.
- topic
Replications List<Property Map> - Configuration relating to topic replication.
- source
Kafka StringCluster Alias - target
Kafka StringCluster Alias
ReplicatorReplicationInfoListConsumerGroupReplication, ReplicatorReplicationInfoListConsumerGroupReplicationArgs
- Consumer
Groups List<string>To Replicates - List of regular expression patterns indicating the consumer groups to copy.
- Consumer
Groups List<string>To Excludes - List of regular expression patterns indicating the consumer groups that should not be replicated.
- Detect
And boolCopy New Consumer Groups - Whether to periodically check for new consumer groups.
- Synchronise
Consumer boolGroup Offsets - Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
- Consumer
Groups []stringTo Replicates - List of regular expression patterns indicating the consumer groups to copy.
- Consumer
Groups []stringTo Excludes - List of regular expression patterns indicating the consumer groups that should not be replicated.
- Detect
And boolCopy New Consumer Groups - Whether to periodically check for new consumer groups.
- Synchronise
Consumer boolGroup Offsets - Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
- consumer
Groups List<String>To Replicates - List of regular expression patterns indicating the consumer groups to copy.
- consumer
Groups List<String>To Excludes - List of regular expression patterns indicating the consumer groups that should not be replicated.
- detect
And BooleanCopy New Consumer Groups - Whether to periodically check for new consumer groups.
- synchronise
Consumer BooleanGroup Offsets - Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
- consumer
Groups string[]To Replicates - List of regular expression patterns indicating the consumer groups to copy.
- consumer
Groups string[]To Excludes - List of regular expression patterns indicating the consumer groups that should not be replicated.
- detect
And booleanCopy New Consumer Groups - Whether to periodically check for new consumer groups.
- synchronise
Consumer booleanGroup Offsets - Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
- consumer_
groups_ Sequence[str]to_ replicates - List of regular expression patterns indicating the consumer groups to copy.
- consumer_
groups_ Sequence[str]to_ excludes - List of regular expression patterns indicating the consumer groups that should not be replicated.
- detect_
and_ boolcopy_ new_ consumer_ groups - Whether to periodically check for new consumer groups.
- synchronise_
consumer_ boolgroup_ offsets - Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
- consumer
Groups List<String>To Replicates - List of regular expression patterns indicating the consumer groups to copy.
- consumer
Groups List<String>To Excludes - List of regular expression patterns indicating the consumer groups that should not be replicated.
- detect
And BooleanCopy New Consumer Groups - Whether to periodically check for new consumer groups.
- synchronise
Consumer BooleanGroup Offsets - Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
ReplicatorReplicationInfoListTopicReplication, ReplicatorReplicationInfoListTopicReplicationArgs
- Topics
To List<string>Replicates - List of regular expression patterns indicating the topics to copy.
- Copy
Access boolControl Lists For Topics - Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
- Copy
Topic boolConfigurations - Whether to periodically configure remote topics to match their corresponding upstream topics.
- Detect
And boolCopy New Topics - Whether to periodically check for new topics and partitions.
- Starting
Position ReplicatorReplication Info List Topic Replication Starting Position - Configuration for specifying the position in the topics to start replicating from.
- Topics
To List<string>Excludes - List of regular expression patterns indicating the topics that should not be replica.
- Topics
To []stringReplicates - List of regular expression patterns indicating the topics to copy.
- Copy
Access boolControl Lists For Topics - Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
- Copy
Topic boolConfigurations - Whether to periodically configure remote topics to match their corresponding upstream topics.
- Detect
And boolCopy New Topics - Whether to periodically check for new topics and partitions.
- Starting
Position ReplicatorReplication Info List Topic Replication Starting Position - Configuration for specifying the position in the topics to start replicating from.
- Topics
To []stringExcludes - List of regular expression patterns indicating the topics that should not be replica.
- topics
To List<String>Replicates - List of regular expression patterns indicating the topics to copy.
- copy
Access BooleanControl Lists For Topics - Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
- copy
Topic BooleanConfigurations - Whether to periodically configure remote topics to match their corresponding upstream topics.
- detect
And BooleanCopy New Topics - Whether to periodically check for new topics and partitions.
- starting
Position ReplicatorReplication Info List Topic Replication Starting Position - Configuration for specifying the position in the topics to start replicating from.
- topics
To List<String>Excludes - List of regular expression patterns indicating the topics that should not be replica.
- topics
To string[]Replicates - List of regular expression patterns indicating the topics to copy.
- copy
Access booleanControl Lists For Topics - Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
- copy
Topic booleanConfigurations - Whether to periodically configure remote topics to match their corresponding upstream topics.
- detect
And booleanCopy New Topics - Whether to periodically check for new topics and partitions.
- starting
Position ReplicatorReplication Info List Topic Replication Starting Position - Configuration for specifying the position in the topics to start replicating from.
- topics
To string[]Excludes - List of regular expression patterns indicating the topics that should not be replica.
- topics_
to_ Sequence[str]replicates - List of regular expression patterns indicating the topics to copy.
- copy_
access_ boolcontrol_ lists_ for_ topics - Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
- copy_
topic_ boolconfigurations - Whether to periodically configure remote topics to match their corresponding upstream topics.
- detect_
and_ boolcopy_ new_ topics - Whether to periodically check for new topics and partitions.
- starting_
position ReplicatorReplication Info List Topic Replication Starting Position - Configuration for specifying the position in the topics to start replicating from.
- topics_
to_ Sequence[str]excludes - List of regular expression patterns indicating the topics that should not be replica.
- topics
To List<String>Replicates - List of regular expression patterns indicating the topics to copy.
- copy
Access BooleanControl Lists For Topics - Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
- copy
Topic BooleanConfigurations - Whether to periodically configure remote topics to match their corresponding upstream topics.
- detect
And BooleanCopy New Topics - Whether to periodically check for new topics and partitions.
- starting
Position Property Map - Configuration for specifying the position in the topics to start replicating from.
- topics
To List<String>Excludes - List of regular expression patterns indicating the topics that should not be replica.
ReplicatorReplicationInfoListTopicReplicationStartingPosition, ReplicatorReplicationInfoListTopicReplicationStartingPositionArgs
- Type string
- The type of replication starting position. Supports
LATEST
andEARLIEST
.
- Type string
- The type of replication starting position. Supports
LATEST
andEARLIEST
.
- type String
- The type of replication starting position. Supports
LATEST
andEARLIEST
.
- type string
- The type of replication starting position. Supports
LATEST
andEARLIEST
.
- type str
- The type of replication starting position. Supports
LATEST
andEARLIEST
.
- type String
- The type of replication starting position. Supports
LATEST
andEARLIEST
.
Import
Using pulumi import
, import MSK replicators using the replicator ARN. For example:
$ pulumi import aws:msk/replicator:Replicator example arn:aws:kafka:us-west-2:123456789012:configuration/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.