gcloud alpha managed-kafka connect-clusters update

NAME
gcloud alpha managed-kafka connect-clusters update - update a Managed Service for Apache Kafka for BigQuery connect cluster
SYNOPSIS
gcloud alpha managed-kafka connect-clusters update (CONNECT_CLUSTER : --location=LOCATION) (--cpu=CPU --memory=MEMORY --clear-configs     | --config-file=JSON|YAML|FILE     | --configs=[KEY=VALUE,…] --clear-dns-names     | --dns-name=DNS_NAME --clear-labels     | --labels=[KEY=VALUE,…] --clear-secrets     | --secret=SECRET [--primary-subnet=PRIMARY_SUBNET : --additional-subnet=ADDITIONAL_SUBNET]) [--async] [GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Update an Managed Service for Apache Kafka for BigQuery connect cluster.
EXAMPLES
To update a connect cluster, run the following:
gcloud alpha managed-kafka connect-clusters update myconnectorCluster --location=us-central1 --configs=KEY1=VALUE1,KEY2=VALUE2… OR --config-file=my-config-file.yaml --cpu=3 --memory=3GiB --primary-subnet=projects/my-project/regions/us-central1/subnetworks/default/1 --additional-subnet=projects/my-project/regions/us-central1/subnetworks/default/2 --dns-name=bootstrap.myconnectorCluster.us-central1.managedkafka.my-project.cloud.goog:9092 --secret=projects/my-project/secrets/my-secret/versions/1 --labels=KEY1=VALUE1,KEY2=VALUE2…
POSITIONAL ARGUMENTS
Connect cluster resource - Identifies the connector cluster for which the command runs. The arguments 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 in other ways.

To set the project attribute:

  • provide the argument connect_cluster on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

This must be specified.

CONNECT_CLUSTER
ID of the connect_cluster or fully qualified identifier for the connect_cluster.

To set the connect_cluster attribute:

  • provide the argument connect_cluster on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--location=LOCATION
ID of the location of the Managed Service for Apache Kafka resource. See https://cloud.google.com/managed-service-for-apache-kafka/docs/locations for a list of supported locations. To set the location attribute:
  • provide the argument connect_cluster on the command line with a fully specified name;
  • provide the argument --location on the command line.
REQUIRED FLAGS
At least one of these must be specified:
--cpu=CPU
The number of vCPUs to provision for the cluster. The minimum is 3.
--memory=MEMORY
The memory to provision for the cluster in bytes. The value must be between 1 GiB and 8 GiB per vCPU. Ex. 1024Mi, 4Gi.
At most one of these can be specified:
--clear-configs
Remove all the configurations for the topic.
--config-file=JSON|YAML|FILE
The path to the JSON or YAML file containing the configuration that are overridden from the cluster or connector defaults. This also supports inline JSON or YAML. Sets config_file value. Input Example:
--config-file=string

File Example:

--config-file=path_to_file.(yaml|json)
--configs=[KEY=VALUE,…]
Configuration for the connect cluster that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: cleanup.policy=compact,compression.type=producer.
At most one of these can be specified:
--clear-dns-names
Remove all the DNS domain names for the connect cluster.
--dns-name=DNS_NAME
DNS domain name from the subnet's network to be made visible to the Connect Cluster.
At most one of these can be specified:
--clear-labels
Remove all the labels from the connect cluster.
--labels=[KEY=VALUE,…]
List of label KEY=VALUE pairs to add. Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
At most one of these can be specified:
--clear-secrets
Remove all the secrets from the connect cluster.
--secret=SECRET
Secrets to load into workers. Exact SecretVersions from Secret Manager must be provided -- aliases are not supported. Up to 32 secrets may be loaded into one cluster. Format: projects/<project-id>/secrets/<secret-name>/versions/<version-id>
--primary-subnet=PRIMARY_SUBNET
VPC subnet to make available to the Kafka Connect cluster. Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id}. The primary subnet is used to create a Private Service Connect (PSC) interface for the Kafka Connect workers. It must be located in the same region as the Connect cluster.

This flag argument must be specified if any of the other arguments in this group are specified.

--additional-subnet=ADDITIONAL_SUBNET
Additional subnet to make available to the Kafka Connect cluster. Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id}.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
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 help for details.

API REFERENCE
This command uses the managedkafka/v1 API. The full documentation for 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 this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist.