Skip to content
AWS for Query.Farm

aws.kafkaconnect.describe_connector

Example SQL Queries

SELECT * FROM
aws.kafkaconnect.describe_connector
WHERE
"connector_arn" = 'VALUE';

Description

Returns summary information about the connector.

Table Definition

Column NameColumn Data Type
connector_arn Required Input Column

The Amazon Resource Name (ARN) of the connector.

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
capacity

Information about the capacity of the connector, whether it is auto scaled or provisioned.

STRUCT(
    "auto_scaling" STRUCT(
        "max_worker_count" BIGINT,
        "mcu_count" BIGINT,
        "min_worker_count" BIGINT,
        "scale_in_policy" STRUCT(
            "cpu_utilization_percentage" BIGINT
        ),
        "scale_out_policy" STRUCT(
            "cpu_utilization_percentage" BIGINT
        )
    ),
    "provisioned_capacity" STRUCT(
        "mcu_count" BIGINT,
        "worker_count" BIGINT
    )
)
Show child fields
capacity.auto_scaling

Describes the connector's auto scaling capacity.

Show child fields
capacity.auto_scaling.max_worker_count

The maximum number of workers allocated to the connector.

capacity.auto_scaling.mcu_count

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

capacity.auto_scaling.min_worker_count

The minimum number of workers allocated to the connector.

capacity.auto_scaling.scale_in_policy

The sacle-in policy for the connector.

Show child fields
capacity.auto_scaling.scale_in_policy.cpu_utilization_percentage

Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

capacity.auto_scaling.scale_out_policy

The sacle-out policy for the connector.>

Show child fields
capacity.auto_scaling.scale_out_policy.cpu_utilization_percentage

The CPU utilization percentage threshold at which you want connector scale out to be triggered.

capacity.provisioned_capacity

Describes a connector's provisioned capacity.

Show child fields
capacity.provisioned_capacity.mcu_count

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

capacity.provisioned_capacity.worker_count

The number of workers that are allocated to the connector.

connector_configuration

A map of keys to values that represent the configuration for the connector.

MAP(VARCHAR, VARCHAR)
connector_description

A summary description of the connector.

VARCHAR
connector_name

The name of the connector.

VARCHAR
connector_state

The state of the connector.

VARCHAR
creation_time

The time the connector was created.

TIMESTAMP_S
current_version

The current version of the connector.

VARCHAR
kafka_cluster

The Apache Kafka cluster that the connector is connected to.

STRUCT(
    "apache_kafka_cluster" STRUCT(
        "bootstrap_servers" VARCHAR,
        "vpc" STRUCT(
            "security_groups" VARCHAR[],
            "subnets" VARCHAR[]
        )
    )
)
Show child fields
kafka_cluster.apache_kafka_cluster

The Apache Kafka cluster to which the connector is connected.

Show child fields
kafka_cluster.apache_kafka_cluster.bootstrap_servers

The bootstrap servers of the cluster.

kafka_cluster.apache_kafka_cluster.vpc

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

Show child fields
kafka_cluster.apache_kafka_cluster.vpc.security_groups[]
kafka_cluster.apache_kafka_cluster.vpc.subnets[]
kafka_cluster_client_authentication

The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

STRUCT(
    "authentication_type" VARCHAR
)
Show child fields
kafka_cluster_client_authentication.authentication_type

The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

kafka_cluster_encryption_in_transit

Details of encryption in transit to the Apache Kafka cluster.

STRUCT(
    "encryption_type" VARCHAR
)
Show child fields
kafka_cluster_encryption_in_transit.encryption_type

The type of encryption in transit to the Apache Kafka cluster.

kafka_connect_version

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

VARCHAR
log_delivery

Details about delivering logs to Amazon CloudWatch Logs.

STRUCT(
    "worker_log_delivery" STRUCT(
        "cloud_watch_logs" STRUCT(
            "enabled" BOOLEAN,
            "log_group" VARCHAR
        ),
        "firehose" STRUCT(
            "delivery_stream" VARCHAR,
            "enabled" BOOLEAN
        ),
        "s3" STRUCT(
            "bucket" VARCHAR,
            "enabled" BOOLEAN,
            "prefix" VARCHAR
        )
    )
)
Show child fields
log_delivery.worker_log_delivery

The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

Show child fields
log_delivery.worker_log_delivery.cloud_watch_logs

Details about delivering logs to Amazon CloudWatch Logs.

Show child fields
log_delivery.worker_log_delivery.cloud_watch_logs.enabled

Whether log delivery to Amazon CloudWatch Logs is enabled.

log_delivery.worker_log_delivery.cloud_watch_logs.log_group

The name of the CloudWatch log group that is the destination for log delivery.

log_delivery.worker_log_delivery.firehose

Details about delivering logs to Amazon Kinesis Data Firehose.

Show child fields
log_delivery.worker_log_delivery.firehose.delivery_stream

The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

log_delivery.worker_log_delivery.firehose.enabled

Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.

log_delivery.worker_log_delivery.s3

Details about delivering logs to Amazon S3.

Show child fields
log_delivery.worker_log_delivery.s3.bucket

The name of the S3 bucket that is the destination for log delivery.

log_delivery.worker_log_delivery.s3.enabled

Specifies whether connector logs get sent to the specified Amazon S3 destination.

log_delivery.worker_log_delivery.s3.prefix

The S3 prefix that is the destination for log delivery.

plugins

Specifies which plugins were used for this connector.

STRUCT(
    "custom_plugin" STRUCT(
        "custom_plugin_arn" VARCHAR,
        "revision" BIGINT
    )
)[]
Show child fields
plugins[]
Show child fields
plugins[].custom_plugin

Details about a custom plugin.

Show child fields
plugins[].custom_plugin.custom_plugin_arn

The Amazon Resource Name (ARN) of the custom plugin.

plugins[].custom_plugin.revision

The revision of the custom plugin.

service_execution_role_arn

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

VARCHAR
state_description

Details about the state of a connector.

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

A code that describes the state of a resource.

state_description.message

A message that describes the state of a resource.

worker_configuration

Specifies which worker configuration was used for the connector.

STRUCT(
    "revision" BIGINT,
    "worker_configuration_arn" VARCHAR
)
Show child fields
worker_configuration.revision

The revision of the worker configuration.

worker_configuration.worker_configuration_arn

The Amazon Resource Name (ARN) of the worker configuration.