[ aws . kafkaconnect ]

list-connectors

Description

Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-connectors is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: connectors

Synopsis

  list-connectors
[--connector-name-prefix <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--connector-name-prefix (string)

The name prefix that you want to use to search for and list connectors.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

connectors -> (list)

An array of connector descriptions.

(structure)

Summary of a connector.

capacity -> (structure)

The connector’s compute capacity settings.

autoScaling -> (structure)

Describes the connector’s auto scaling capacity.

maxWorkerCount -> (integer)

The maximum number of workers allocated to the connector.

mcuCount -> (integer)

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

minWorkerCount -> (integer)

The minimum number of workers allocated to the connector.

scaleInPolicy -> (structure)

The sacle-in policy for the connector.

cpuUtilizationPercentage -> (integer)

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

scaleOutPolicy -> (structure)

The sacle-out policy for the connector.>

cpuUtilizationPercentage -> (integer)

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

provisionedCapacity -> (structure)

Describes a connector’s provisioned capacity.

mcuCount -> (integer)

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

workerCount -> (integer)

The number of workers that are allocated to the connector.

connectorArn -> (string)

The Amazon Resource Name (ARN) of the connector.

connectorDescription -> (string)

The description of the connector.

connectorName -> (string)

The name of the connector.

connectorState -> (string)

The state of the connector.

creationTime -> (timestamp)

The time that the connector was created.

currentVersion -> (string)

The current version of the connector.

kafkaCluster -> (structure)

The details of the Apache Kafka cluster to which the connector is connected.

apacheKafkaCluster -> (structure)

The Apache Kafka cluster to which the connector is connected.

bootstrapServers -> (string)

The bootstrap servers of the cluster.

vpc -> (structure)

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

securityGroups -> (list)

The security groups for the connector.

(string)

subnets -> (list)

The subnets for the connector.

(string)

kafkaClusterClientAuthentication -> (structure)

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

authenticationType -> (string)

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

kafkaClusterEncryptionInTransit -> (structure)

Details of encryption in transit to the Apache Kafka cluster.

encryptionType -> (string)

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

kafkaConnectVersion -> (string)

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

logDelivery -> (structure)

The settings for delivering connector logs to Amazon CloudWatch Logs.

workerLogDelivery -> (structure)

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

cloudWatchLogs -> (structure)

Details about delivering logs to Amazon CloudWatch Logs.

enabled -> (boolean)

Whether log delivery to Amazon CloudWatch Logs is enabled.

logGroup -> (string)

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

firehose -> (structure)

Details about delivering logs to Amazon Kinesis Data Firehose.

deliveryStream -> (string)

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

enabled -> (boolean)

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

s3 -> (structure)

Details about delivering logs to Amazon S3.

bucket -> (string)

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

enabled -> (boolean)

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

prefix -> (string)

The S3 prefix that is the destination for log delivery.

plugins -> (list)

Specifies which plugins were used for this connector.

(structure)

The description of the plugin.

customPlugin -> (structure)

Details about a custom plugin.

customPluginArn -> (string)

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

revision -> (long)

The revision of the custom plugin.

serviceExecutionRoleArn -> (string)

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

workerConfiguration -> (structure)

The worker configurations that are in use with the connector.

revision -> (long)

The revision of the worker configuration.

workerConfigurationArn -> (string)

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

nextToken -> (string)

If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.