V1 Replicators
URI
/replication/v1/replicators
HTTP methods
GET
Operation ID: ListReplicators
Lists the replicators.
Query parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replicatorNameFilter | String | False | Returns replicators starting with given name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextToken | String | False | If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxResults | String | False | The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 |
ListReplicatorsResponse | 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. |
POST
Operation ID: CreateReplicator
Creates the replicator.
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 |
CreateReplicatorResponse | 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | None | HTTP Status Code 409: Conflict. This replicator name already exists. Retry your request with another name. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | Default response for CORS method |
Schemas
Request bodies
{ "replicatorName": "string", "serviceExecutionRoleArn": "string", "replicationInfoList": [ { "consumerGroupReplication": { "consumerGroupsToExclude": [ "string" ], "detectAndCopyNewConsumerGroups": boolean, "consumerGroupsToReplicate": [ "string" ], "synchroniseConsumerGroupOffsets": boolean }, "targetCompressionType": enum, "topicReplication": { "copyAccessControlListsForTopics": boolean, "detectAndCopyNewTopics": boolean, "copyTopicConfigurations": boolean, "startingPosition": { "type": enum }, "topicsToReplicate": [ "string" ], "topicsToExclude": [ "string" ] }, "sourceKafkaClusterArn": "string", "targetKafkaClusterArn": "string" } ], "description": "string", "kafkaClusters": [ { "amazonMskCluster": { "mskClusterArn": "string" }, "vpcConfig": { "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } ], "tags": { } }
Response bodies
{ "nextToken": "string", "replicators": [ { "replicatorArn": "string", "replicatorName": "string", "creationTime": "string", "kafkaClustersSummary": [ { "kafkaClusterAlias": "string", "amazonMskCluster": { "mskClusterArn": "string" } } ], "replicatorState": enum, "isReplicatorReference": boolean, "replicationInfoSummaryList": [ { "sourceKafkaClusterAlias": "string", "targetKafkaClusterAlias": "string" } ], "replicatorResourceArn": "string", "currentVersion": "string" } ] }
{ "replicatorArn": "string", "replicatorName": "string", "replicatorState": enum }
Properties
AmazonMskCluster
Details of an Amazon MSK Cluster.
Property | Type | Required | Description |
---|---|---|---|
mskClusterArn | string | True | The Amazon Resource Name (ARN) of an Amazon MSK cluster. |
ConsumerGroupReplication
Details about consumer group replication.
Property | Type | Required | Description |
---|---|---|---|
consumerGroupsToExclude | Array of type string MaxLength: 256 | False | 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 | False | Enables synchronization of consumer groups to target cluster. |
synchroniseConsumerGroupOffsets | boolean | False | Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets. |
CreateReplicatorRequest
Request body for replicator.
Property | Type | Required | Description |
---|---|---|---|
description | string MaxLength: 1024 | False | A summary description of the replicator. |
kafkaClusters | Array of type KafkaCluster | True | Kafka Clusters to use in setting up sources / targets for replication. |
replicationInfoList | Array of type ReplicationInfo | True | A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. |
replicatorName | string Pattern: MinLength: 1 MaxLength: 128 | True | The name of the replicator. Alpha-numeric characters with '-' are allowed. |
serviceExecutionRoleArn | string | True | 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 | object | False | List of tags to attach to created Replicator. |
CreateReplicatorResponse
Returns information about the created replicator.
Property | Type | Required | Description |
---|---|---|---|
replicatorArn | string | False | The Amazon Resource Name (ARN) of the replicator. |
replicatorName | string | False | Name of the replicator provided by the customer. |
replicatorState | False | State of the replicator. |
KafkaCluster
Information about Kafka Cluster to be used as source / target for replication.
Property | Type | Required | Description |
---|---|---|---|
amazonMskCluster | True | Details of an Amazon MSK Cluster. | |
vpcConfig | True | Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster. |
KafkaClusterClientVpcConfig
Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
Property | Type | Required | Description |
---|---|---|---|
securityGroupIds | Array of type string | False | The security groups to attach to the ENIs for the broker nodes. |
subnetIds | Array of type string | True | The list of subnets in the client VPC to connect to. |
KafkaClusterSummary
Summarized information about Kafka Cluster used as source / target for replication.
Property | Type | Required | Description |
---|---|---|---|
amazonMskCluster | False | Details of an Amazon MSK Cluster. | |
kafkaClusterAlias | string | False | The alias of the Kafka cluster. Used to prefix names of replicated topics. |
ListReplicatorsResponse
The response contains an array containing replicator information and a NextToken if the response is truncated.
Property | Type | Required | Description |
---|---|---|---|
nextToken | string | False | If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators. |
replicators | Array of type ReplicatorSummary | False | List containing information of each of the replicators in the account. |
ReplicationInfo
Specifies configuration for replication between a source and target Kafka cluster.
Property | Type | Required | Description |
---|---|---|---|
consumerGroupReplication | True | Configuration relating to consumer group replication. | |
sourceKafkaClusterArn | string | True | The ARN of the source Kafka cluster. |
targetCompressionType | True | The compression type to use when producing records to target cluster. | |
targetKafkaClusterArn | string | True | The ARN of the target Kafka cluster. |
topicReplication | True | Configuration relating to topic replication. |
ReplicationInfoSummary
Summarized information of replication between clusters.
Property | Type | Required | Description |
---|---|---|---|
sourceKafkaClusterAlias | string | False | The alias of the source Kafka cluster. |
targetKafkaClusterAlias | string | False | The alias of the target Kafka cluster. |
ReplicationStartingPosition
Specifies the position in the topics to start replicating from.
Property | Type | Required | Description |
---|---|---|---|
type | False | The type of replication starting position. |
ReplicationStartingPositionType
The type of replication starting position.
LATEST
EARLIEST
ReplicatorState
State of a replicator.
RUNNING
CREATING
UPDATING
DELETING
FAILED
ReplicatorSummary
Information about a replicator.
Property | Type | Required | Description |
---|---|---|---|
creationTime | string | False | The time the replicator was created. |
currentVersion | string | False | The current version of the replicator. |
isReplicatorReference | boolean | False | Whether this resource is a replicator reference. |
kafkaClustersSummary | Array of type KafkaClusterSummary | False | Kafka Clusters used in setting up sources / targets for replication. |
replicationInfoSummaryList | Array of type ReplicationInfoSummary | False | A list of summarized information of replications between clusters. |
replicatorArn | string | False | The Amazon Resource Name (ARN) of the replicator. |
replicatorName | string | False | The name of the replicator. |
replicatorResourceArn | string | False | The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created. |
replicatorState | False | State of the replicator. |
TargetCompressionType
The type of compression to use producing records to the target cluster.
NONE
GZIP
SNAPPY
LZ4
ZSTD
TopicReplication
Details about topic replication.
Property | Type | Required | Description |
---|---|---|---|
copyAccessControlListsForTopics | boolean | False | Whether to periodically configure remote topic ACLs to match their corresponding upstream topics. |
copyTopicConfigurations | boolean | False | Whether to periodically configure remote topics to match their corresponding upstream topics. |
detectAndCopyNewTopics | boolean | False | Whether to periodically check for new topics and partitions. |
startingPosition | False | Specifies the position in the topics to start replicating from. | |
topicsToExclude | Array of type string MaxLength: 249 | False | 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. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: