Skip to content
AWS for Query.Farm

aws.kafka.describe_replicator

Example SQL Queries

SELECT * FROM
aws.kafka.describe_replicator
WHERE
"replicator_arn" = 'VALUE';

Description

Describes a replicator.

Table Definition

Column NameColumn Data Type
replicator_arn Required Input Column

The Amazon Resource Name (ARN) of the replicator.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
creation_time

The time when the replicator was created.

TIMESTAMP_S
current_version

The current version number of the replicator.

VARCHAR
is_replicator_reference

Whether this resource is a replicator reference.

BOOLEAN
kafka_clusters

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

STRUCT(
    "amazon_msk_cluster" STRUCT(
        "msk_cluster_arn" VARCHAR
    ),
    "kafka_cluster_alias" VARCHAR,
    "vpc_config" STRUCT(
        "security_group_ids" VARCHAR[],
        "subnet_ids" VARCHAR[]
    )
)[]
Show child fields
kafka_clusters[]
Show child fields
kafka_clusters[].amazon_msk_cluster

Details of an Amazon MSK Cluster.

Show child fields
kafka_clusters[].amazon_msk_cluster.msk_cluster_arn

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

kafka_clusters[].kafka_cluster_alias

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

kafka_clusters[].vpc_config

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

Show child fields
kafka_clusters[].vpc_config.security_group_ids[]
kafka_clusters[].vpc_config.subnet_ids[]
replication_info_list

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

STRUCT(
    "consumer_group_replication" STRUCT(
        "consumer_groups_to_exclude" VARCHAR[],
        "consumer_groups_to_replicate" VARCHAR[],
        "detect_and_copy_new_consumer_groups" BOOLEAN,
        "synchronise_consumer_group_offsets" BOOLEAN
    ),
    "source_kafka_cluster_alias" VARCHAR,
    "target_compression_type" VARCHAR,
    "target_kafka_cluster_alias" VARCHAR,
    "topic_replication" STRUCT(
        "copy_access_control_lists_for_topics" BOOLEAN,
        "copy_topic_configurations" BOOLEAN,
        "detect_and_copy_new_topics" BOOLEAN,
        "starting_position" STRUCT(
            "type" VARCHAR
        ),
        "topics_to_exclude" VARCHAR[],
        "topics_to_replicate" VARCHAR[]
    )
)[]
Show child fields
replication_info_list[]
Show child fields
replication_info_list[].consumer_group_replication

Configuration relating to consumer group replication.

Show child fields
replication_info_list[].consumer_group_replication.consumer_groups_to_exclude[]
replication_info_list[].consumer_group_replication.consumer_groups_to_replicate[]
replication_info_list[].consumer_group_replication.detect_and_copy_new_consumer_groups

Enables synchronization of consumer groups to target cluster.

replication_info_list[].consumer_group_replication.synchronise_consumer_group_offsets

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

replication_info_list[].source_kafka_cluster_alias

The alias of the source Kafka cluster.

replication_info_list[].target_compression_type

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

replication_info_list[].target_kafka_cluster_alias

The alias of the target Kafka cluster.

replication_info_list[].topic_replication

Configuration relating to topic replication.

Show child fields
replication_info_list[].topic_replication.copy_access_control_lists_for_topics

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

replication_info_list[].topic_replication.copy_topic_configurations

Whether to periodically configure remote topics to match their corresponding upstream topics.

replication_info_list[].topic_replication.detect_and_copy_new_topics

Whether to periodically check for new topics and partitions.

replication_info_list[].topic_replication.starting_position

Configuration for specifying the position in the topics to start replicating from.

Show child fields
replication_info_list[].topic_replication.starting_position.type

The type of replication starting position.

replication_info_list[].topic_replication.topics_to_exclude[]
replication_info_list[].topic_replication.topics_to_replicate[]
replicator_description

The description of the replicator.

VARCHAR
replicator_name

The name of the replicator.

VARCHAR
replicator_resource_arn

The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

VARCHAR
replicator_state

State of the replicator.

VARCHAR
service_execution_role_arn

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)

VARCHAR
state_info

Details about the state of the replicator.

STRUCT(
    "code" VARCHAR,
    "message" VARCHAR
)
Show child fields
state_info.code

Code that describes the current state of the replicator.

state_info.message

Message that describes the state of the replicator.

tags

List of tags attached to the Replicator.

MAP(VARCHAR, VARCHAR)