Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kafkaconnect ]

update-connector

Description

Updates the specified connector.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-connector
--capacity <value>
--connector-arn <value>
--current-version <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--capacity (structure)

The target capacity.

autoScaling -> (structure)

The target auto scaling setting.

maxWorkerCount -> (integer)

The target maximum number of workers allocated to the connector.

mcuCount -> (integer)

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

minWorkerCount -> (integer)

The target minimum number of workers allocated to the connector.

scaleInPolicy -> (structure)

The target sacle-in policy for the connector.

cpuUtilizationPercentage -> (integer)

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

scaleOutPolicy -> (structure)

The target sacle-out policy for the connector.

cpuUtilizationPercentage -> (integer)

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

provisionedCapacity -> (structure)

The target settings for 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.

Shorthand Syntax:

autoScaling={maxWorkerCount=integer,mcuCount=integer,minWorkerCount=integer,scaleInPolicy={cpuUtilizationPercentage=integer},scaleOutPolicy={cpuUtilizationPercentage=integer}},provisionedCapacity={mcuCount=integer,workerCount=integer}

JSON Syntax:

{
  "autoScaling": {
    "maxWorkerCount": integer,
    "mcuCount": integer,
    "minWorkerCount": integer,
    "scaleInPolicy": {
      "cpuUtilizationPercentage": integer
    },
    "scaleOutPolicy": {
      "cpuUtilizationPercentage": integer
    }
  },
  "provisionedCapacity": {
    "mcuCount": integer,
    "workerCount": integer
  }
}

--connector-arn (string)

The Amazon Resource Name (ARN) of the connector that you want to update.

--current-version (string)

The current version of the connector that you want to update.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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

connectorArn -> (string)

The Amazon Resource Name (ARN) of the connector.

connectorState -> (string)

The state of the connector.