gcloud alpha managed-kafka connectors update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha managed-kafka connectors update - update a Managed Service for Apache Kafka connector
- SYNOPSIS
gcloud alpha managed-kafka connectors update(CONNECTOR:--connect-cluster=CONNECT_CLUSTER--location=LOCATION)[--task-retry-disabled][--config-file=JSON|YAML|FILE|--configs=[KEY=VALUE,…]][--task-restart-max-backoff=TASK_RESTART_MAX_BACKOFF--task-restart-min-backoff=TASK_RESTART_MIN_BACKOFF][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Update a Managed Service for Apache Kafka connector.- EXAMPLES
- To update a connector name myconnector, run the following:
gcloudalphamanaged-kafkaconnectorsupdatemyconnector--location=us-central1--configs=KEY1=VALUE1,KEY2=VALUE2…--connect-cluster=mycluster[--task-restart-min-backoff=60s][--task-restart-max-backoff=30m][--task-retry-disabled=true]ORgcloudalphamanaged-kafkaconnectorsupdatemyconnector--location=us-central1--config-file=my-config-file.yaml--connect-cluster=mycluster[--task-restart-min-backoff=60s][--task-restart-max-backoff=30m][--task-retry-disabled=true] - POSITIONAL ARGUMENTS
- Connector resource - Identifies the connector for which the command runs. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.
To set the
projectattribute:- provide the argument
connectoron the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
CONNECTOR- ID of the connector or fully qualified identifier for the connector.
To set the
connectorattribute:- provide the argument
connectoron the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--connect-cluster=CONNECT_CLUSTER- The connect cluster name.To set the
connect-clusterattribute:- provide the argument
connectoron the command line with a fullyspecified name; - provide the argument
--connect-clusteron the command line.
- provide the argument
--location=LOCATION- ID of the location of the Managed Service for Apache Kafka resource. Seehttps://cloud.google.com/managed-service-for-apache-kafka/docs/locationsfor a list of supported locations.To set the
locationattribute:- provide the argument
connectoron the command line with a fullyspecified name; - provide the argument
--locationon the command line.
- provide the argument
- provide the argument
- Connector resource - Identifies the connector for which the command runs. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.
- FLAGS
--task-retry-disabled- Disable default task retry policy.
- At most one of these can be specified:
--config-file=JSON|YAML|FILE- The path to the JSON or YAML file containing the configuration that areoverridden from the connector defaults. This also supports inline JSON or YAML.Sets
config_filevalue.Input Example:--config-file=stringFile Example:--config-file=path_to_file.(yaml|json)
--configs=[KEY=VALUE,…]- Configuration for the connector that are overridden from the connector defaults.The key of the map is a Kafka topic property name, for example:
cleanup.policy=compact,compression.type=producer.
--task-restart-max-backoff=TASK_RESTART_MAX_BACKOFF- The maximum amount of time to wait before retrying a failed task in seconds.This sets an upper bound for the backoff delay. The default value is 1800s (30minutes). See $gcloud topicdatetimes for information on duration formats.
--task-restart-min-backoff=TASK_RESTART_MIN_BACKOFF- The minimum amount of time to wait before retrying a failed task in seconds.This sets a lower bound for the backoff delay. The default value is 60s. See $gcloud topic datetimes forinformation on duration formats.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - API REFERENCE
- This command uses the
managedkafka/v1API. The full documentationfor this API can be found at:https://cloud.google.com/managed-service-for-apache-kafka/docs - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudmanaged-kafkaconnectorsupdategcloudbetamanaged-kafkaconnectorsupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-09 UTC.