Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kafka ]

create-replicator

Description

Creates the replicator.

See also: AWS API Documentation

Synopsis

  create-replicator
[--description <value>]
--kafka-clusters <value>
--replication-info-list <value>
--replicator-name <value>
--service-execution-role-arn <value>
[--tags <value>]
[--log-delivery <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--description (string)

A summary description of the replicator.

--kafka-clusters (list)

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

(structure)

Information about Kafka Cluster to be used as source / target for replication.

AmazonMskCluster -> (structure)

Details of an Amazon MSK Cluster.

MskClusterArn -> (string)

The Amazon Resource Name (ARN) of an Amazon MSK cluster.

ApacheKafkaCluster -> (structure)

Details of an Apache Kafka Cluster.

ApacheKafkaClusterId -> (string)

The ID of the Apache Kafka cluster.

BootstrapBrokerString -> (string)

The bootstrap broker string of the Apache Kafka cluster.

VpcConfig -> (structure)

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

SecurityGroupIds -> (list)

The security groups to attach to the ENIs for the broker nodes.

(string)

SubnetIds -> (list)

The list of subnets in the client VPC to connect to.

(string)

ClientAuthentication -> (structure)

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

SaslScram -> (structure)

Details for SASL/SCRAM client authentication.

Mechanism -> (string)

The SASL/SCRAM authentication mechanism.

SecretArn -> (string)

The Amazon Resource Name (ARN) of the Secrets Manager secret.

EncryptionInTransit -> (structure)

Details of encryption in transit to the Apache Kafka cluster.

EncryptionType -> (string)

The type of encryption in transit to the Apache Kafka cluster.

RootCaCertificate -> (string)

The root CA certificate.

Shorthand Syntax:

AmazonMskCluster={MskClusterArn=string},ApacheKafkaCluster={ApacheKafkaClusterId=string,BootstrapBrokerString=string},VpcConfig={SecurityGroupIds=[string,string],SubnetIds=[string,string]},ClientAuthentication={SaslScram={Mechanism=string,SecretArn=string}},EncryptionInTransit={EncryptionType=string,RootCaCertificate=string} ...

JSON Syntax:

[
  {
    "AmazonMskCluster": {
      "MskClusterArn": "string"
    },
    "ApacheKafkaCluster": {
      "ApacheKafkaClusterId": "string",
      "BootstrapBrokerString": "string"
    },
    "VpcConfig": {
      "SecurityGroupIds": ["string", ...],
      "SubnetIds": ["string", ...]
    },
    "ClientAuthentication": {
      "SaslScram": {
        "Mechanism": "SHA256"|"SHA512",
        "SecretArn": "string"
      }
    },
    "EncryptionInTransit": {
      "EncryptionType": "TLS",
      "RootCaCertificate": "string"
    }
  }
  ...
]

--replication-info-list (list)

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

(structure)

Specifies configuration for replication between a source and target Kafka cluster.

ConsumerGroupReplication -> (structure)

Configuration relating to consumer group replication.

ConsumerGroupsToExclude -> (list)

List of regular expression patterns indicating the consumer groups that should not be replicated.

(string)

ConsumerGroupsToReplicate -> (list)

List of regular expression patterns indicating the consumer groups to copy.

(string)

DetectAndCopyNewConsumerGroups -> (boolean)

Enables synchronization of consumer groups to target cluster.

SynchroniseConsumerGroupOffsets -> (boolean)

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

ConsumerGroupOffsetSyncMode -> (string)

The consumer group offset synchronization mode. With LEGACY, offsets are synchronized when producers write to the source cluster. With ENHANCED, consumer offsets are synchronized regardless of producer location. ENHANCED requires a corresponding replicator that replicates data from the target cluster to the source cluster.

SourceKafkaClusterArn -> (string)

The ARN of the source Kafka cluster.

SourceKafkaClusterId -> (string)

The ID of the source Kafka cluster.

TargetCompressionType -> (string)

The compression type to use when producing records to target cluster.

TargetKafkaClusterArn -> (string)

The ARN of the target Kafka cluster.

TargetKafkaClusterId -> (string)

The ID of the target Kafka cluster.

TopicReplication -> (structure)

Configuration relating to topic replication.

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 -> (structure)

Configuration for specifying the position in the topics to start replicating from.

Type -> (string)

The type of replication starting position.

TopicNameConfiguration -> (structure)

Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.

Type -> (string)

The type of replicated topic name.

TopicsToExclude -> (list)

List of regular expression patterns indicating the topics that should not be replicated.

(string)

TopicsToReplicate -> (list)

List of regular expression patterns indicating the topics to copy.

(string)

Shorthand Syntax:

ConsumerGroupReplication={ConsumerGroupsToExclude=[string,string],ConsumerGroupsToReplicate=[string,string],DetectAndCopyNewConsumerGroups=boolean,SynchroniseConsumerGroupOffsets=boolean,ConsumerGroupOffsetSyncMode=string},SourceKafkaClusterArn=string,SourceKafkaClusterId=string,TargetCompressionType=string,TargetKafkaClusterArn=string,TargetKafkaClusterId=string,TopicReplication={CopyAccessControlListsForTopics=boolean,CopyTopicConfigurations=boolean,DetectAndCopyNewTopics=boolean,StartingPosition={Type=string},TopicNameConfiguration={Type=string},TopicsToExclude=[string,string],TopicsToReplicate=[string,string]} ...

JSON Syntax:

[
  {
    "ConsumerGroupReplication": {
      "ConsumerGroupsToExclude": ["string", ...],
      "ConsumerGroupsToReplicate": ["string", ...],
      "DetectAndCopyNewConsumerGroups": true|false,
      "SynchroniseConsumerGroupOffsets": true|false,
      "ConsumerGroupOffsetSyncMode": "LEGACY"|"ENHANCED"
    },
    "SourceKafkaClusterArn": "string",
    "SourceKafkaClusterId": "string",
    "TargetCompressionType": "NONE"|"GZIP"|"SNAPPY"|"LZ4"|"ZSTD",
    "TargetKafkaClusterArn": "string",
    "TargetKafkaClusterId": "string",
    "TopicReplication": {
      "CopyAccessControlListsForTopics": true|false,
      "CopyTopicConfigurations": true|false,
      "DetectAndCopyNewTopics": true|false,
      "StartingPosition": {
        "Type": "LATEST"|"EARLIEST"
      },
      "TopicNameConfiguration": {
        "Type": "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS"|"IDENTICAL"
      },
      "TopicsToExclude": ["string", ...],
      "TopicsToReplicate": ["string", ...]
    }
  }
  ...
]

--replicator-name (string)

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

--service-execution-role-arn (string)

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

--tags (map)

List of tags to attach to created Replicator.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--log-delivery (structure)

Configuration for delivering replicator logs to customer destinations.

ReplicatorLogDelivery -> (structure)

Configuration for replicator log delivery.

CloudWatchLogs -> (structure)

Configuration for CloudWatch Logs delivery.

Enabled -> (boolean)

Whether log delivery to CloudWatch Logs is enabled.

LogGroup -> (string)

The CloudWatch log group that is the destination for log delivery.

Firehose -> (structure)

Configuration for Firehose delivery.

Enabled -> (boolean)

Whether log delivery to Firehose is enabled.

DeliveryStream -> (string)

The Firehose delivery stream that is the destination for log delivery.

S3 -> (structure)

Configuration for S3 delivery.

Enabled -> (boolean)

Whether log delivery to S3 is enabled.

Bucket -> (string)

The S3 bucket that is the destination for log delivery.

Prefix -> (string)

The S3 prefix that is the destination for log delivery.

Shorthand Syntax:

ReplicatorLogDelivery={CloudWatchLogs={Enabled=boolean,LogGroup=string},Firehose={Enabled=boolean,DeliveryStream=string},S3={Enabled=boolean,Bucket=string,Prefix=string}}

JSON Syntax:

{
  "ReplicatorLogDelivery": {
    "CloudWatchLogs": {
      "Enabled": true|false,
      "LogGroup": "string"
    },
    "Firehose": {
      "Enabled": true|false,
      "DeliveryStream": "string"
    },
    "S3": {
      "Enabled": true|false,
      "Bucket": "string",
      "Prefix": "string"
    }
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

ReplicatorArn -> (string)

The Amazon Resource Name (ARN) of the replicator.

ReplicatorName -> (string)

Name of the replicator provided by the customer.

ReplicatorState -> (string)

State of the replicator.