replicators

Creates, updates, deletes, gets or lists a replicators resource.

Overview

Name	replicators
Type	Resource
Id	aws.kafka.replicators

Fields

The following fields are returned by SELECT queries:

describe_replicator

Name	Datatype	Description
creation_time	string (date-time)	The time when the replicator was created.
current_version	string	The current version number of the replicator.
is_replicator_reference	boolean	Whether this resource is a replicator reference.
kafka_clusters	array	Kafka Clusters used in setting up sources / targets for replication.
log_delivery	object	Configuration for log delivery to customer destinations.
replication_info_list	array	A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
replicator_arn	string	The Amazon Resource Name (ARN) of the replicator.
replicator_description	string	The description of the replicator.
replicator_name	string	The name of the replicator.
replicator_resource_arn	string	The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.
replicator_state	string	State of the replicator. (RUNNING, CREATING, UPDATING, DELETING, FAILED)
service_execution_role_arn	string	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)
state_info	object	Details about the state of the replicator.
tags	object	List of tags attached to the Replicator.

list_replicators

Name	Datatype	Description
creation_time	string (date-time)	The time the replicator was created.
current_version	string	The current version of the replicator.
is_replicator_reference	boolean	Whether this resource is a replicator reference.
kafka_clusters_summary	array	Kafka Clusters used in setting up sources / targets for replication.
replication_info_summary_list	array	A list of summarized information of replications between clusters.
replicator_arn	string	The Amazon Resource Name (ARN) of the replicator.
replicator_name	string	The name of the replicator.
replicator_resource_arn	string	The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.
replicator_state	string	State of the replicator. (RUNNING, CREATING, UPDATING, DELETING, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_replicator	select	replicator_arn, region		Describes a replicator.
list_replicators	select	region	maxResults, nextToken, replicatorNameFilter	Lists the replicators.
create_replicator	insert	region, KafkaClusters, ReplicationInfoList, ReplicatorName, ServiceExecutionRoleArn		Creates the replicator.
update_replication_info	update	replicator_arn, region, CurrentVersion		Updates replication info of a replicator.
delete_replicator	delete	replicator_arn, region	currentVersion	Deletes a replicator.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
replicator_arn	string	The Amazon Resource Name (ARN) of the replicator to be deleted.
currentVersion	string	The current version of the replicator.
maxResults	integer	The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
nextToken	string	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.
replicatorNameFilter	string	Returns replicators starting with given name.

SELECT examples

describe_replicator

Describes a replicator.

SELECT
creation_time,
current_version,
is_replicator_reference,
kafka_clusters,
log_delivery,
replication_info_list,
replicator_arn,
replicator_description,
replicator_name,
replicator_resource_arn,
replicator_state,
service_execution_role_arn,
state_info,
tags
FROM aws.kafka.replicators
WHERE replicator_arn = '{{ replicator_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_replicators

Lists the replicators.

SELECT
creation_time,
current_version,
is_replicator_reference,
kafka_clusters_summary,
replication_info_summary_list,
replicator_arn,
replicator_name,
replicator_resource_arn,
replicator_state
FROM aws.kafka.replicators
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND replicatorNameFilter = '{{ replicatorNameFilter }}'
;

INSERT examples

create_replicator

Creates the replicator.

INSERT INTO aws.kafka.replicators (
Description,
KafkaClusters,
ReplicationInfoList,
ReplicatorName,
ServiceExecutionRoleArn,
Tags,
LogDelivery,
region
)
SELECT 
'{{ Description }}',
'{{ KafkaClusters }}' /* required */,
'{{ ReplicationInfoList }}' /* required */,
'{{ ReplicatorName }}' /* required */,
'{{ ServiceExecutionRoleArn }}' /* required */,
'{{ Tags }}',
'{{ LogDelivery }}',
'{{ region }}'
RETURNING
replicator_arn,
replicator_name,
replicator_state
;

Manifest

# Description fields are for documentation purposes
- name: replicators
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the replicators resource.
  - name: Description
    value: "{{ Description }}"
  - name: KafkaClusters
    value:
      - AmazonMskCluster:
          MskClusterArn: "{{ MskClusterArn }}"
        ApacheKafkaCluster:
          ApacheKafkaClusterId: "{{ ApacheKafkaClusterId }}"
          BootstrapBrokerString: "{{ BootstrapBrokerString }}"
        VpcConfig:
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
          SubnetIds:
            - "{{ SubnetIds }}"
        ClientAuthentication:
          SaslScram:
            Mechanism: "{{ Mechanism }}"
            SecretArn: "{{ SecretArn }}"
          MTLS:
            SecretArn: "{{ SecretArn }}"
        EncryptionInTransit:
          EncryptionType: "{{ EncryptionType }}"
          RootCaCertificate: "{{ RootCaCertificate }}"
  - name: ReplicationInfoList
    value:
      - ConsumerGroupReplication:
          ConsumerGroupsToExclude:
            - "{{ ConsumerGroupsToExclude }}"
          ConsumerGroupsToReplicate:
            - "{{ ConsumerGroupsToReplicate }}"
          DetectAndCopyNewConsumerGroups: {{ DetectAndCopyNewConsumerGroups }}
          SynchroniseConsumerGroupOffsets: {{ SynchroniseConsumerGroupOffsets }}
          ConsumerGroupOffsetSyncMode: "{{ ConsumerGroupOffsetSyncMode }}"
        SourceKafkaClusterArn: "{{ SourceKafkaClusterArn }}"
        SourceKafkaClusterId: "{{ SourceKafkaClusterId }}"
        TargetCompressionType: "{{ TargetCompressionType }}"
        TargetKafkaClusterArn: "{{ TargetKafkaClusterArn }}"
        TargetKafkaClusterId: "{{ TargetKafkaClusterId }}"
        TopicReplication:
          CopyAccessControlListsForTopics: {{ CopyAccessControlListsForTopics }}
          CopyTopicConfigurations: {{ CopyTopicConfigurations }}
          DetectAndCopyNewTopics: {{ DetectAndCopyNewTopics }}
          StartingPosition:
            Type: "{{ Type }}"
          TopicNameConfiguration:
            Type: "{{ Type }}"
          TopicsToExclude:
            - "{{ TopicsToExclude }}"
          TopicsToReplicate:
            - "{{ TopicsToReplicate }}"
  - name: ReplicatorName
    value: "{{ ReplicatorName }}"
  - name: ServiceExecutionRoleArn
    value: "{{ ServiceExecutionRoleArn }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: LogDelivery
    description: |
      Configuration for log delivery to customer destinations.
    value:
      ReplicatorLogDelivery:
        CloudWatchLogs:
          Enabled: {{ Enabled }}
          LogGroup: "{{ LogGroup }}"
        Firehose:
          Enabled: {{ Enabled }}
          DeliveryStream: "{{ DeliveryStream }}"
        S3:
          Enabled: {{ Enabled }}
          Bucket: "{{ Bucket }}"
          Prefix: "{{ Prefix }}"

UPDATE examples

update_replication_info

Updates replication info of a replicator.

UPDATE aws.kafka.replicators
SET 
ConsumerGroupReplication = '{{ ConsumerGroupReplication }}',
CurrentVersion = '{{ CurrentVersion }}',
SourceKafkaClusterArn = '{{ SourceKafkaClusterArn }}',
SourceKafkaClusterId = '{{ SourceKafkaClusterId }}',
TargetKafkaClusterArn = '{{ TargetKafkaClusterArn }}',
TargetKafkaClusterId = '{{ TargetKafkaClusterId }}',
TopicReplication = '{{ TopicReplication }}',
LogDelivery = '{{ LogDelivery }}'
WHERE 
replicator_arn = '{{ replicator_arn }}' --required
AND region = '{{ region }}' --required
AND CurrentVersion = '{{ CurrentVersion }}' --required
RETURNING
replicator_arn,
replicator_state;

DELETE examples

delete_replicator

Deletes a replicator.

DELETE FROM aws.kafka.replicators
WHERE replicator_arn = '{{ replicator_arn }}' --required
AND region = '{{ region }}' --required
AND currentVersion = '{{ currentVersion }}'
;