Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kafka ]

update-replication-info

Description

Updates replication info of a replicator.

See also: AWS API Documentation

Synopsis

  update-replication-info
[--consumer-group-replication <value>]
--current-version <value>
--replicator-arn <value>
--source-kafka-cluster-arn <value>
--target-kafka-cluster-arn <value>
[--topic-replication <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>]

Options

--consumer-group-replication (structure)

Updated consumer group replication information.

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.

Shorthand Syntax:

ConsumerGroupsToExclude=string,string,ConsumerGroupsToReplicate=string,string,DetectAndCopyNewConsumerGroups=boolean,SynchroniseConsumerGroupOffsets=boolean

JSON Syntax:

{
  "ConsumerGroupsToExclude": ["string", ...],
  "ConsumerGroupsToReplicate": ["string", ...],
  "DetectAndCopyNewConsumerGroups": true|false,
  "SynchroniseConsumerGroupOffsets": true|false
}

--current-version (string)

Current replicator version.

--replicator-arn (string)

The Amazon Resource Name (ARN) of the replicator to be updated.

--source-kafka-cluster-arn (string)

The ARN of the source Kafka cluster.

--target-kafka-cluster-arn (string)

The ARN of the target Kafka cluster.

--topic-replication (structure)

Updated topic replication information.

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.

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:

CopyAccessControlListsForTopics=boolean,CopyTopicConfigurations=boolean,DetectAndCopyNewTopics=boolean,TopicsToExclude=string,string,TopicsToReplicate=string,string

JSON Syntax:

{
  "CopyAccessControlListsForTopics": true|false,
  "CopyTopicConfigurations": true|false,
  "DetectAndCopyNewTopics": true|false,
  "TopicsToExclude": ["string", ...],
  "TopicsToReplicate": ["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.

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

Output

ReplicatorArn -> (string)

The Amazon Resource Name (ARN) of the replicator.

ReplicatorState -> (string)

State of the replicator.