V1 Replicators replicatorArn - Amazon Managed Streaming for Apache Kafka
URIHTTP methodsSchemasPropertiesSee also

V1 Replicators replicatorArn

URI

/replication/v1/replicators/replicatorArn

HTTP methods

GET

Operation ID: DescribeReplicator

Describes a replicator.

Path parameters
NameTypeRequiredDescription
replicatorArnStringTrue

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

Responses
Status codeResponse modelDescription
200 DescribeReplicatorResponse

HTTP Status Code 200: OK.

400None

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

401None

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

403None

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404None

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

429None

HTTP Status Code 429: Limit exceeded. Resource limit reached.

500None

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

503None

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

DELETE

Operation ID: DeleteReplicator

Deletes a replicator.

Path parameters
NameTypeRequiredDescription
replicatorArnStringTrue

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

Query parameters
NameTypeRequiredDescription
currentVersionStringFalse

The current version of the replicator.

Responses
Status codeResponse modelDescription
200 DeleteReplicatorResponse

HTTP Status Code 200: OK.

400None

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

401None

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

403None

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404None

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

429None

HTTP Status Code 429: Limit exceeded. Resource limit reached.

500None

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

503None

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
NameTypeRequiredDescription
replicatorArnStringTrue

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

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Response bodies

{
  "replicatorArn": "string",
  "creationTime": "string",
  "kafkaClusters": [
    {
      "kafkaClusterAlias": "string",
      "amazonMskCluster": {
        "mskClusterArn": "string"
      },
      "vpcConfig": {
        "securityGroupIds": [
          "string"
        ],
        "subnetIds": [
          "string"
        ]
      }
    }
  ],
  "currentVersion": "string",
  "tags": {
  },
  "replicatorDescription": "string",
  "replicatorName": "string",
  "serviceExecutionRoleArn": "string",
  "replicationInfoList": [
    {
      "consumerGroupReplication": {
        "consumerGroupsToExclude": [
          "string"
        ],
        "detectAndCopyNewConsumerGroups": boolean,
        "consumerGroupsToReplicate": [
          "string"
        ],
        "synchroniseConsumerGroupOffsets": boolean
      },
      "targetCompressionType": enum,
      "sourceKafkaClusterAlias": "string",
      "topicReplication": {
        "copyAccessControlListsForTopics": boolean,
        "detectAndCopyNewTopics": boolean,
        "topicNameConfiguration": {
          "type": enum
        },
        "copyTopicConfigurations": boolean,
        "startingPosition": {
          "type": enum
        },
        "topicsToReplicate": [
          "string"
        ],
        "topicsToExclude": [
          "string"
        ]
      },
      "targetKafkaClusterAlias": "string"
    }
  ],
  "stateInfo": {
    "code": "string",
    "message": "string"
  },
  "replicatorState": enum,
  "isReplicatorReference": boolean,
  "replicatorResourceArn": "string"
}
{
  "replicatorArn": "string",
  "replicatorState": enum
}

Properties

AmazonMskCluster

Details of an Amazon MSK Cluster.

PropertyTypeRequiredDescription
mskClusterArn

string

True

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

ConsumerGroupReplication

Details about consumer group replication.

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

DeleteReplicatorResponse

Returns information about the deleted replicator.

PropertyTypeRequiredDescription
replicatorArn

string

False

The Amazon Resource Name (ARN) of the replicator.

replicatorState

ReplicatorState

False

State of the replicator.

DescribeReplicatorResponse

Response body for DescribeReplicator.

PropertyTypeRequiredDescription
creationTime

string

False

The time when the replicator was created.

currentVersion

string

False

The current version number of the replicator.

isReplicatorReference

boolean

False

Whether this resource is a replicator reference.

kafkaClusters

Array of type KafkaClusterDescription

False

Kafka Clusters used in setting up sources / targets for replication.

replicationInfoList

Array of type ReplicationInfoDescription

False

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

replicatorArn

string

False

The Amazon Resource Name (ARN) of the replicator.

replicatorDescription

string

False

The description 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

ReplicatorState

False

State of the replicator.

serviceExecutionRoleArn

string

False

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

stateInfo

ReplicationStateInfo

False

Details about the state of the replicator.

tags

object

False

List of tags attached to the Replicator.

KafkaClusterClientVpcConfig

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

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

KafkaClusterDescription

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

PropertyTypeRequiredDescription
amazonMskCluster

AmazonMskCluster

False

Details of an Amazon MSK Cluster.

kafkaClusterAlias

string

False

The alias of the Kafka cluster. Used to prefix names of replicated topics.

vpcConfig

KafkaClusterClientVpcConfig

False

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

ReplicationInfoDescription

Specifies configuration for replication between a source and target Kafka cluster (sourceKafkaClusterAlias -> targetKafkaClusterAlias)

PropertyTypeRequiredDescription
consumerGroupReplication

ConsumerGroupReplication

False

Configuration relating to consumer group replication.

sourceKafkaClusterAlias

string

False

The alias of the source Kafka cluster.

targetCompressionType

TargetCompressionType

False

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

targetKafkaClusterAlias

string

False

The alias of the target Kafka cluster.

topicReplication

TopicReplication

False

Configuration relating to topic replication.

ReplicationStartingPosition

Specifies the position in the topics to start replicating from.

PropertyTypeRequiredDescription
type

ReplicationStartingPositionType

False

The type of replication starting position.

ReplicationStartingPositionType

The type of replication starting position.

  • LATEST

  • EARLIEST

ReplicationStateInfo

Details about the state of a replicator.

PropertyTypeRequiredDescription
code

string

False

Code that describes the state of the replicator.

message

string

False

Message that describes the state of the replicator.

ReplicationTopicNameConfiguration

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

PropertyTypeRequiredDescription
type

ReplicationTopicNameConfigurationType

False

The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.

ReplicationTopicNameConfigurationType

The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.

  • IDENTICAL

  • PREFIXED_WITH_SOURCE_CLUSTER_ALIAS

ReplicatorState

State of a replicator.

  • RUNNING

  • CREATING

  • UPDATING

  • DELETING

  • FAILED

TargetCompressionType

The type of compression to use producing records to the target cluster.

  • NONE

  • GZIP

  • SNAPPY

  • LZ4

  • ZSTD

TopicReplication

Details about topic replication.

PropertyTypeRequiredDescription
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

ReplicationStartingPosition

False

Specifies the position in the topics to start replicating from.

topicNameConfiguration

ReplicationTopicNameConfiguration

False

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

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:

DescribeReplicator

DeleteReplicator