[ aws . kafkaconnect ]
describe-connector¶
Description¶
Returns summary information about the connector.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-connector
--connector-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--connector-arn (string)
The Amazon Resource Name (ARN) of the connector that you want to describe.
--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.
--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¶
capacity -> (structure)
Information about the capacity of the connector, whether it is auto scaled or provisioned.
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.
connectorConfiguration -> (map)
A map of keys to values that represent the configuration for the connector.
key -> (string)
value -> (string)
connectorDescription -> (string)
A summary description of the connector.
connectorName -> (string)
The name of the connector.
connectorState -> (string)
The state of the connector.
creationTime -> (timestamp)
The time the connector was created.
currentVersion -> (string)
The current version of the connector.
kafkaCluster -> (structure)
The Apache Kafka cluster that the connector is connected to.
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)
Details about delivering 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.
stateDescription -> (structure)
Details about the state of a connector.
code -> (string)
A code that describes the state of a resource.
message -> (string)
A message that describes the state of a resource.
workerConfiguration -> (structure)
Specifies which worker configuration was used for the connector.
revision -> (long)
The revision of the worker configuration.
workerConfigurationArn -> (string)
The Amazon Resource Name (ARN) of the worker configuration.