[ 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>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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.

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)

Shorthand Syntax:

AmazonMskCluster={MskClusterArn=string},VpcConfig={SecurityGroupIds=[string,string],SubnetIds=[string,string]} ...

JSON Syntax:

[
  {
    "AmazonMskCluster": {
      "MskClusterArn": "string"
    },
    "VpcConfig": {
      "SecurityGroupIds": ["string", ...],
      "SubnetIds": ["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.

SourceKafkaClusterArn -> (string)

The ARN 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.

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.

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},SourceKafkaClusterArn=string,TargetCompressionType=string,TargetKafkaClusterArn=string,TopicReplication={CopyAccessControlListsForTopics=boolean,CopyTopicConfigurations=boolean,DetectAndCopyNewTopics=boolean,StartingPosition={Type=string},TopicsToExclude=[string,string],TopicsToReplicate=[string,string]} ...

JSON Syntax:

[
  {
    "ConsumerGroupReplication": {
      "ConsumerGroupsToExclude": ["string", ...],
      "ConsumerGroupsToReplicate": ["string", ...],
      "DetectAndCopyNewConsumerGroups": true|false,
      "SynchroniseConsumerGroupOffsets": true|false
    },
    "SourceKafkaClusterArn": "string",
    "TargetCompressionType": "NONE"|"GZIP"|"SNAPPY"|"LZ4"|"ZSTD",
    "TargetKafkaClusterArn": "string",
    "TopicReplication": {
      "CopyAccessControlListsForTopics": true|false,
      "CopyTopicConfigurations": true|false,
      "DetectAndCopyNewTopics": true|false,
      "StartingPosition": {
        "Type": "LATEST"|"EARLIEST"
      },
      "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"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

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.