1. Packages
  2. AWS Native
  3. API Docs
  4. msk
  5. Replicator

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.msk.Replicator

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    Resource Type definition for AWS::MSK::Replicator

    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[Sequence[ReplicatorReplicationInfoArgs]] = None,
                   service_execution_role_arn: Optional[str] = None,
                   current_version: Optional[str] = None,
                   description: Optional[str] = None,
                   replicator_name: Optional[str] = None,
                   tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native: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.

    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

    The Replicator resource accepts the following input properties:

    KafkaClusters List<Pulumi.AwsNative.Msk.Inputs.ReplicatorKafkaCluster>
    Specifies a list of Kafka clusters which are targets of the replicator.
    ReplicationInfoList List<Pulumi.AwsNative.Msk.Inputs.ReplicatorReplicationInfo>
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    ServiceExecutionRoleArn string
    The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
    CurrentVersion string
    The current version of the MSK replicator.
    Description string
    A summary description of the replicator.
    ReplicatorName string
    The name of the replicator.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A collection of tags associated with a resource
    KafkaClusters []ReplicatorKafkaClusterArgs
    Specifies a list of Kafka clusters which are targets of the replicator.
    ReplicationInfoList []ReplicatorReplicationInfoArgs
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    ServiceExecutionRoleArn string
    The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
    CurrentVersion string
    The current version of the MSK replicator.
    Description string
    A summary description of the replicator.
    ReplicatorName string
    The name of the replicator.
    Tags TagArgs
    A collection of tags associated with a resource
    kafkaClusters List<ReplicatorKafkaCluster>
    Specifies a list of Kafka clusters which are targets of the replicator.
    replicationInfoList List<ReplicatorReplicationInfo>
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    serviceExecutionRoleArn String
    The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
    currentVersion String
    The current version of the MSK replicator.
    description String
    A summary description of the replicator.
    replicatorName String
    The name of the replicator.
    tags List<Tag>
    A collection of tags associated with a resource
    kafkaClusters ReplicatorKafkaCluster[]
    Specifies a list of Kafka clusters which are targets of the replicator.
    replicationInfoList ReplicatorReplicationInfo[]
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    serviceExecutionRoleArn string
    The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
    currentVersion string
    The current version of the MSK replicator.
    description string
    A summary description of the replicator.
    replicatorName string
    The name of the replicator.
    tags Tag[]
    A collection of tags associated with a resource
    kafka_clusters Sequence[ReplicatorKafkaClusterArgs]
    Specifies a list of Kafka clusters which are targets of the replicator.
    replication_info_list Sequence[ReplicatorReplicationInfoArgs]
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    service_execution_role_arn str
    The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
    current_version str
    The current version of the MSK replicator.
    description str
    A summary description of the replicator.
    replicator_name str
    The name of the replicator.
    tags Sequence[TagArgs]
    A collection of tags associated with a resource
    kafkaClusters List<Property Map>
    Specifies a list of Kafka clusters which are targets of the replicator.
    replicationInfoList List<Property Map>
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    serviceExecutionRoleArn String
    The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
    currentVersion String
    The current version of the MSK replicator.
    description String
    A summary description of the replicator.
    replicatorName String
    The name of the replicator.
    tags List<Property Map>
    A collection of tags associated with a resource

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Replicator resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ReplicatorArn string
    Amazon Resource Name for the created replicator.
    Id string
    The provider-assigned unique ID for this managed resource.
    ReplicatorArn string
    Amazon Resource Name for the created replicator.
    id String
    The provider-assigned unique ID for this managed resource.
    replicatorArn String
    Amazon Resource Name for the created replicator.
    id string
    The provider-assigned unique ID for this managed resource.
    replicatorArn string
    Amazon Resource Name for the created replicator.
    id str
    The provider-assigned unique ID for this managed resource.
    replicator_arn str
    Amazon Resource Name for the created replicator.
    id String
    The provider-assigned unique ID for this managed resource.
    replicatorArn String
    Amazon Resource Name for the created replicator.

    Supporting Types

    ReplicatorAmazonMskCluster, ReplicatorAmazonMskClusterArgs

    MskClusterArn string
    The ARN of an Amazon MSK cluster.
    MskClusterArn string
    The ARN of an Amazon MSK cluster.
    mskClusterArn String
    The ARN of an Amazon MSK cluster.
    mskClusterArn string
    The ARN of an Amazon MSK cluster.
    msk_cluster_arn str
    The ARN of an Amazon MSK cluster.
    mskClusterArn String
    The ARN of an Amazon MSK cluster.

    ReplicatorConsumerGroupReplication, ReplicatorConsumerGroupReplicationArgs

    ConsumerGroupsToReplicate List<string>
    List of regular expression patterns indicating the consumer groups to copy.
    ConsumerGroupsToExclude List<string>
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    DetectAndCopyNewConsumerGroups bool
    Whether to periodically check for new consumer groups.
    SynchroniseConsumerGroupOffsets bool
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
    ConsumerGroupsToReplicate []string
    List of regular expression patterns indicating the consumer groups to copy.
    ConsumerGroupsToExclude []string
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    DetectAndCopyNewConsumerGroups bool
    Whether to periodically check for new consumer groups.
    SynchroniseConsumerGroupOffsets bool
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
    consumerGroupsToReplicate List<String>
    List of regular expression patterns indicating the consumer groups to copy.
    consumerGroupsToExclude List<String>
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    detectAndCopyNewConsumerGroups Boolean
    Whether to periodically check for new consumer groups.
    synchroniseConsumerGroupOffsets Boolean
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
    consumerGroupsToReplicate string[]
    List of regular expression patterns indicating the consumer groups to copy.
    consumerGroupsToExclude string[]
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    detectAndCopyNewConsumerGroups boolean
    Whether to periodically check for new consumer groups.
    synchroniseConsumerGroupOffsets boolean
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
    consumer_groups_to_replicate Sequence[str]
    List of regular expression patterns indicating the consumer groups to copy.
    consumer_groups_to_exclude Sequence[str]
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    detect_and_copy_new_consumer_groups bool
    Whether to periodically check for new consumer groups.
    synchronise_consumer_group_offsets bool
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
    consumerGroupsToReplicate List<String>
    List of regular expression patterns indicating the consumer groups to copy.
    consumerGroupsToExclude List<String>
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    detectAndCopyNewConsumerGroups Boolean
    Whether to periodically check for new consumer groups.
    synchroniseConsumerGroupOffsets Boolean
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.

    ReplicatorKafkaCluster, ReplicatorKafkaClusterArgs

    AmazonMskCluster Pulumi.AwsNative.Msk.Inputs.ReplicatorAmazonMskCluster
    Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required.
    VpcConfig Pulumi.AwsNative.Msk.Inputs.ReplicatorKafkaClusterClientVpcConfig
    Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
    AmazonMskCluster ReplicatorAmazonMskCluster
    Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required.
    VpcConfig ReplicatorKafkaClusterClientVpcConfig
    Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
    amazonMskCluster ReplicatorAmazonMskCluster
    Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required.
    vpcConfig ReplicatorKafkaClusterClientVpcConfig
    Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
    amazonMskCluster ReplicatorAmazonMskCluster
    Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required.
    vpcConfig ReplicatorKafkaClusterClientVpcConfig
    Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
    amazon_msk_cluster ReplicatorAmazonMskCluster
    Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required.
    vpc_config ReplicatorKafkaClusterClientVpcConfig
    Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
    amazonMskCluster Property Map
    Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required.
    vpcConfig Property Map
    Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

    ReplicatorKafkaClusterClientVpcConfig, ReplicatorKafkaClusterClientVpcConfigArgs

    SubnetIds List<string>
    The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.
    SecurityGroupIds List<string>
    The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used.
    SubnetIds []string
    The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.
    SecurityGroupIds []string
    The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used.
    subnetIds List<String>
    The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.
    securityGroupIds List<String>
    The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used.
    subnetIds string[]
    The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.
    securityGroupIds string[]
    The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. 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.
    security_group_ids Sequence[str]
    The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used.
    subnetIds List<String>
    The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.
    securityGroupIds List<String>
    The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used.

    ReplicatorReplicationInfo, ReplicatorReplicationInfoArgs

    ConsumerGroupReplication Pulumi.AwsNative.Msk.Inputs.ReplicatorConsumerGroupReplication
    Configuration relating to consumer group replication.
    SourceKafkaClusterArn string
    Amazon Resource Name of the source Kafka cluster.
    TargetCompressionType Pulumi.AwsNative.Msk.ReplicatorReplicationInfoTargetCompressionType
    The type of compression to use writing records to target Kafka cluster.
    TargetKafkaClusterArn string
    Amazon Resource Name of the target Kafka cluster.
    TopicReplication Pulumi.AwsNative.Msk.Inputs.ReplicatorTopicReplication
    Configuration relating to topic replication.
    ConsumerGroupReplication ReplicatorConsumerGroupReplication
    Configuration relating to consumer group replication.
    SourceKafkaClusterArn string
    Amazon Resource Name of the source Kafka cluster.
    TargetCompressionType ReplicatorReplicationInfoTargetCompressionType
    The type of compression to use writing records to target Kafka cluster.
    TargetKafkaClusterArn string
    Amazon Resource Name of the target Kafka cluster.
    TopicReplication ReplicatorTopicReplication
    Configuration relating to topic replication.
    consumerGroupReplication ReplicatorConsumerGroupReplication
    Configuration relating to consumer group replication.
    sourceKafkaClusterArn String
    Amazon Resource Name of the source Kafka cluster.
    targetCompressionType ReplicatorReplicationInfoTargetCompressionType
    The type of compression to use writing records to target Kafka cluster.
    targetKafkaClusterArn String
    Amazon Resource Name of the target Kafka cluster.
    topicReplication ReplicatorTopicReplication
    Configuration relating to topic replication.
    consumerGroupReplication ReplicatorConsumerGroupReplication
    Configuration relating to consumer group replication.
    sourceKafkaClusterArn string
    Amazon Resource Name of the source Kafka cluster.
    targetCompressionType ReplicatorReplicationInfoTargetCompressionType
    The type of compression to use writing records to target Kafka cluster.
    targetKafkaClusterArn string
    Amazon Resource Name of the target Kafka cluster.
    topicReplication ReplicatorTopicReplication
    Configuration relating to topic replication.
    consumer_group_replication ReplicatorConsumerGroupReplication
    Configuration relating to consumer group replication.
    source_kafka_cluster_arn str
    Amazon Resource Name of the source Kafka cluster.
    target_compression_type ReplicatorReplicationInfoTargetCompressionType
    The type of compression to use writing records to target Kafka cluster.
    target_kafka_cluster_arn str
    Amazon Resource Name of the target Kafka cluster.
    topic_replication ReplicatorTopicReplication
    Configuration relating to topic replication.
    consumerGroupReplication Property Map
    Configuration relating to consumer group replication.
    sourceKafkaClusterArn String
    Amazon Resource Name of the source Kafka cluster.
    targetCompressionType "NONE" | "GZIP" | "SNAPPY" | "LZ4" | "ZSTD"
    The type of compression to use writing records to target Kafka cluster.
    targetKafkaClusterArn String
    Amazon Resource Name of the target Kafka cluster.
    topicReplication Property Map
    Configuration relating to topic replication.

    ReplicatorReplicationInfoTargetCompressionType, ReplicatorReplicationInfoTargetCompressionTypeArgs

    None
    NONE
    Gzip
    GZIP
    Snappy
    SNAPPY
    Lz4
    LZ4
    Zstd
    ZSTD
    ReplicatorReplicationInfoTargetCompressionTypeNone
    NONE
    ReplicatorReplicationInfoTargetCompressionTypeGzip
    GZIP
    ReplicatorReplicationInfoTargetCompressionTypeSnappy
    SNAPPY
    ReplicatorReplicationInfoTargetCompressionTypeLz4
    LZ4
    ReplicatorReplicationInfoTargetCompressionTypeZstd
    ZSTD
    None
    NONE
    Gzip
    GZIP
    Snappy
    SNAPPY
    Lz4
    LZ4
    Zstd
    ZSTD
    None
    NONE
    Gzip
    GZIP
    Snappy
    SNAPPY
    Lz4
    LZ4
    Zstd
    ZSTD
    NONE
    NONE
    GZIP
    GZIP
    SNAPPY
    SNAPPY
    LZ4
    LZ4
    ZSTD
    ZSTD
    "NONE"
    NONE
    "GZIP"
    GZIP
    "SNAPPY"
    SNAPPY
    "LZ4"
    LZ4
    "ZSTD"
    ZSTD

    ReplicatorReplicationStartingPosition, ReplicatorReplicationStartingPositionArgs

    ReplicatorReplicationStartingPositionType, ReplicatorReplicationStartingPositionTypeArgs

    Latest
    LATEST
    Earliest
    EARLIEST
    ReplicatorReplicationStartingPositionTypeLatest
    LATEST
    ReplicatorReplicationStartingPositionTypeEarliest
    EARLIEST
    Latest
    LATEST
    Earliest
    EARLIEST
    Latest
    LATEST
    Earliest
    EARLIEST
    LATEST
    LATEST
    EARLIEST
    EARLIEST
    "LATEST"
    LATEST
    "EARLIEST"
    EARLIEST

    ReplicatorTopicReplication, ReplicatorTopicReplicationArgs

    TopicsToReplicate List<string>
    List of regular expression patterns indicating the topics to copy.
    CopyAccessControlListsForTopics bool
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    CopyTopicConfigurations bool
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    DetectAndCopyNewTopics bool
    Whether to periodically check for new topics and partitions.
    StartingPosition Pulumi.AwsNative.Msk.Inputs.ReplicatorReplicationStartingPosition
    Configuration for specifying the position in the topics to start replicating from.
    TopicsToExclude List<string>
    List of regular expression patterns indicating the topics that should not be replicated.
    TopicsToReplicate []string
    List of regular expression patterns indicating the topics to copy.
    CopyAccessControlListsForTopics bool
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    CopyTopicConfigurations bool
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    DetectAndCopyNewTopics bool
    Whether to periodically check for new topics and partitions.
    StartingPosition ReplicatorReplicationStartingPosition
    Configuration for specifying the position in the topics to start replicating from.
    TopicsToExclude []string
    List of regular expression patterns indicating the topics that should not be replicated.
    topicsToReplicate List<String>
    List of regular expression patterns indicating the topics to copy.
    copyAccessControlListsForTopics Boolean
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    copyTopicConfigurations Boolean
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    detectAndCopyNewTopics Boolean
    Whether to periodically check for new topics and partitions.
    startingPosition ReplicatorReplicationStartingPosition
    Configuration for specifying the position in the topics to start replicating from.
    topicsToExclude List<String>
    List of regular expression patterns indicating the topics that should not be replicated.
    topicsToReplicate string[]
    List of regular expression patterns indicating the topics to copy.
    copyAccessControlListsForTopics boolean
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    copyTopicConfigurations boolean
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    detectAndCopyNewTopics boolean
    Whether to periodically check for new topics and partitions.
    startingPosition ReplicatorReplicationStartingPosition
    Configuration for specifying the position in the topics to start replicating from.
    topicsToExclude string[]
    List of regular expression patterns indicating the topics that should not be replicated.
    topics_to_replicate Sequence[str]
    List of regular expression patterns indicating the topics to copy.
    copy_access_control_lists_for_topics bool
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    copy_topic_configurations bool
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    detect_and_copy_new_topics bool
    Whether to periodically check for new topics and partitions.
    starting_position ReplicatorReplicationStartingPosition
    Configuration for specifying the position in the topics to start replicating from.
    topics_to_exclude Sequence[str]
    List of regular expression patterns indicating the topics that should not be replicated.
    topicsToReplicate List<String>
    List of regular expression patterns indicating the topics to copy.
    copyAccessControlListsForTopics Boolean
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    copyTopicConfigurations Boolean
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    detectAndCopyNewTopics Boolean
    Whether to periodically check for new topics and partitions.
    startingPosition Property Map
    Configuration for specifying the position in the topics to start replicating from.
    topicsToExclude List<String>
    List of regular expression patterns indicating the topics that should not be replicated.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi