URI HTTP methods Schemas Properties See also

V1 Replicators replicatorArn Replication-info

URI

/replication/v1/replicators/replicatorArn/replication-info

HTTP methods

PUT

Operation ID: UpdateReplicationInfo

Updates replication info of a replicator.

Path parameters
Name	Type	Required	Description
`replicatorArn`	String	True	The Amazon Resource Name (ARN) of the replicator to be described.

Responses
Status code	Response model	Description
`200`	`UpdateReplicationInfoResponse`	HTTP Status Code 200: OK.
`400`	None	HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
`401`	None	HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
`403`	None	HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
`404`	None	HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
`429`	None	HTTP Status Code 429: Limit exceeded. Resource limit reached.
`500`	None	HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
`503`	None	HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

OPTIONS

Enable CORS by returning correct headers

Path parameters
Name	Type	Required	Description
`replicatorArn`	String	True	The Amazon Resource Name (ARN) of the replicator to be described.

Responses
Status code	Response model	Description
`200`	None	Default response for CORS method

Schemas

Request bodies


{
  "consumerGroupReplication": {
    "consumerGroupsToExclude": [
      "string"
    ],
    "detectAndCopyNewConsumerGroups": boolean,
    "consumerGroupsToReplicate": [
      "string"
    ],
    "synchroniseConsumerGroupOffsets": boolean
  },
  "topicReplication": {
    "copyAccessControlListsForTopics": boolean,
    "detectAndCopyNewTopics": boolean,
    "copyTopicConfigurations": boolean,
    "topicsToReplicate": [
      "string"
    ],
    "topicsToExclude": [
      "string"
    ]
  },
  "sourceKafkaClusterArn": "string",
  "targetKafkaClusterArn": "string",
  "currentVersion": "string"
}

Response bodies


{
  "replicatorArn": "string",
  "replicatorState": enum
}

Properties

ConsumerGroupReplicationUpdate

Details about consumer group replication.

Property	Type	Required	Description
`consumerGroupsToExclude`	Array of type string MaxLength: 256	True	List of regular expression patterns indicating the consumer groups that should not be replicated.
`consumerGroupsToReplicate`	Array of type string MaxLength: 256	True	List of regular expression patterns indicating the consumer groups to copy.
`detectAndCopyNewConsumerGroups`	boolean	True	Enables synchronization of consumer groups to target cluster.
`synchroniseConsumerGroupOffsets`	boolean	True	Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

ReplicatorState

State of a replicator.

RUNNING
CREATING
UPDATING
DELETING
FAILED

TopicReplicationUpdate

Details for updating the topic replication of a replicator.

Property	Type	Required	Description
`copyAccessControlListsForTopics`	boolean	True	Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
`copyTopicConfigurations`	boolean	True	Whether to periodically configure remote topics to match their corresponding upstream topics.
`detectAndCopyNewTopics`	boolean	True	Whether to periodically check for new topics and partitions.
`topicsToExclude`	Array of type string MaxLength: 249	True	List of regular expression patterns indicating the topics that should not be replicated.
`topicsToReplicate`	Array of type string MaxLength: 249	True	List of regular expression patterns indicating the topics to copy.

UpdateReplicationInfoRequest

Parameters for updating replication information between source and target Kafka clusters of a replicator.

Property	Type	Required	Description
`consumerGroupReplication`	ConsumerGroupReplicationUpdate	False	Updated consumer group replication information.
`currentVersion`	string	True	Current replicator version.
`sourceKafkaClusterArn`	string	True	The ARN of the source Kafka cluster.
`targetKafkaClusterArn`	string	True	The ARN of the target Kafka cluster.
`topicReplication`	TopicReplicationUpdate	False	Updated topic replication information.

UpdateReplicationInfoResponse

Updated Replication information of a replicator.

Property	Type	Required	Description
`replicatorArn`	string	False	The Amazon Resource Name (ARN) of the replicator.
`replicatorState`	ReplicatorState	False	State of the replicator.