KafkaConnect / Client / update_connector

update_connector#

KafkaConnect.Client.update_connector(**kwargs)#

Updates the specified connector.

See also: AWS API Documentation

Request Syntax

response = client.update_connector(
    capacity={
        'autoScaling': {
            'maxWorkerCount': 123,
            'mcuCount': 123,
            'minWorkerCount': 123,
            'scaleInPolicy': {
                'cpuUtilizationPercentage': 123
            },
            'scaleOutPolicy': {
                'cpuUtilizationPercentage': 123
            }
        },
        'provisionedCapacity': {
            'mcuCount': 123,
            'workerCount': 123
        }
    },
    connectorArn='string',
    currentVersion='string'
)
Parameters:

  • capacity (dict) –

    [REQUIRED]

    The target capacity.

    • autoScaling (dict) –

      The target auto scaling setting.

      • maxWorkerCount (integer) – [REQUIRED]

        The target maximum number of workers allocated to the connector.

      • mcuCount (integer) – [REQUIRED]

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

      • minWorkerCount (integer) – [REQUIRED]

        The target minimum number of workers allocated to the connector.

      • scaleInPolicy (dict) – [REQUIRED]

        The target sacle-in policy for the connector.

        • cpuUtilizationPercentage (integer) – [REQUIRED]

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

      • scaleOutPolicy (dict) – [REQUIRED]

        The target sacle-out policy for the connector.

        • cpuUtilizationPercentage (integer) – [REQUIRED]

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

    • provisionedCapacity (dict) –

      The target settings for provisioned capacity.

      • mcuCount (integer) – [REQUIRED]

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

      • workerCount (integer) – [REQUIRED]

        The number of workers that are allocated to the connector.

  • connectorArn (string) –

    [REQUIRED]

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

  • currentVersion (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'connectorArn': 'string',
    'connectorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
}

Response Structure

  • (dict) –

    • connectorArn (string) –

      The Amazon Resource Name (ARN) of the connector.

    • connectorState (string) –

      The state of the connector.

Exceptions