File: //snap/google-cloud-cli/394/help/man/man1/gcloud_managed-kafka_connect-clusters_update.1
.TH "GCLOUD_MANAGED\-KAFKA_CONNECT\-CLUSTERS_UPDATE" 1
.SH "NAME"
.HP
gcloud managed\-kafka connect\-clusters update \- update a Managed Service for Apache Kafka for BigQuery connect cluster
.SH "SYNOPSIS"
.HP
\f5gcloud managed\-kafka connect\-clusters update\fR (\fICONNECT_CLUSTER\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) (\fB\-\-cpu\fR=\fICPU\fR\ \fB\-\-memory\fR=\fIMEMORY\fR\ \fB\-\-clear\-configs\fR\ |\ \fB\-\-config\-file\fR=\fIJSON\fR|\fIYAML\fR|\fIFILE\fR\ |\ \fB\-\-configs\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-clear\-dns\-names\fR\ |\ \fB\-\-dns\-name\fR=\fIDNS_NAME\fR\ \fB\-\-clear\-labels\fR\ |\ \fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-clear\-secrets\fR\ |\ \fB\-\-secret\fR=\fISECRET\fR\ [\fB\-\-primary\-subnet\fR=\fIPRIMARY_SUBNET\fR\ :\ \fB\-\-additional\-subnet\fR=\fIADDITIONAL_SUBNET\fR]) [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
Update an Managed Service for Apache Kafka for BigQuery connect cluster.
.SH "EXAMPLES"
To update a connect cluster, run the following:
.RS 2m
$ gcloud managed\-kafka connect\-clusters update myconnectorCluster \e
\-\-location=us\-central1 \-\-configs=KEY1=VALUE1,KEY2=VALUE2... OR \e
\-\-config\-file=my\-config\-file.yaml \-\-cpu=3 \-\-memory=3GiB \e
\-\-primary\-subnet=projects/my\-project/regions/us\-central1/\e
subnetworks/default/1 \e
\-\-additional\-subnet=projects/my\-project/regions/us\-central1/\e
subnetworks/default/2 \e
\-\-dns\-name=bootstrap.myconnectorCluster.us\-central1.managedkafka\e
.my\-project.cloud.goog:9092 \e
\-\-secret=projects/my\-project/secrets/my\-secret/versions/1 \e
\-\-labels=KEY1=VALUE1,KEY2=VALUE2...
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Connect cluster resource \- Identifies the connect 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5connect_cluster\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp
This must be specified.
.RS 2m
.TP 2m
\fICONNECT_CLUSTER\fR
ID of the connect_cluster or fully qualified identifier for the connect_cluster.
To set the \f5connect_cluster\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5connect_cluster\fR on the command line.
.RE
.sp
This positional argument must be specified if any of the other arguments in this
group are specified.
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR
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 \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5connect_cluster\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp
.RE
.RE
.sp
.SH "REQUIRED FLAGS"
.RS 2m
.TP 2m
At least one of these must be specified:
.RS 2m
.TP 2m
\fB\-\-cpu\fR=\fICPU\fR
The number of vCPUs to provision for the cluster. The minimum is 3.
.TP 2m
\fB\-\-memory\fR=\fIMEMORY\fR
The memory to provision for the cluster in bytes. The value must be between 1
GiB and 8 GiB per vCPU. Ex. 1024Mi, 4Gi.
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-clear\-configs\fR
Remove all the configurations for the topic.
.TP 2m
\fB\-\-config\-file\fR=\fIJSON\fR|\fIYAML\fR|\fIFILE\fR
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 \f5config_file\fR value.
\fBInput Example:\fR
.RS 2m
\-\-config\-file=string
.RE
\fBFile Example:\fR
.RS 2m
\-\-config\-file=path_to_file.(yaml|json)
.RE
.TP 2m
\fB\-\-configs\fR=[\fIKEY\fR=\fIVALUE\fR,...]
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:
\f5cleanup.policy=compact\fR,\f5compression.type=producer\fR.
.RE
.sp
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-clear\-dns\-names\fR
Remove all the DNS domain names for the connect cluster.
.TP 2m
\fB\-\-dns\-name\fR=\fIDNS_NAME\fR
DNS domain name from the subnet's network to be made visible to the Connect
Cluster.
.RE
.sp
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR
Remove all the labels from the connect cluster.
.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]
List of label KEY=VALUE pairs to add. Keys must start with a lowercase character
and contain only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase
characters, and numbers. Values must contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers.
.RE
.sp
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-clear\-secrets\fR
Remove all the secrets from the connect cluster.
.TP 2m
\fB\-\-secret\fR=\fISECRET\fR
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>
.RE
.sp
.TP 2m
\fB\-\-primary\-subnet\fR=\fIPRIMARY_SUBNET\fR
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.
.TP 2m
\fB\-\-additional\-subnet\fR=\fIADDITIONAL_SUBNET\fR
Additional subnet to make available to the Kafka Connect cluster. Structured
like: projects/{project}/regions/{region}/subnetworks/{subnet_id}.
.RE
.RE
.sp
.SH "OPTIONAL FLAGS"
.RS 2m
.TP 2m
\fB\-\-async\fR
Return immediately, without waiting for the operation in progress to complete.
.RE
.sp
.SH "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 \fB$ gcloud help\fR for details.
.SH "API REFERENCE"
This command uses the \fBmanagedkafka/v1\fR API. The full documentation for this
API can be found at:
https://cloud.google.com/managed\-service\-for\-apache\-kafka/docs
.SH "NOTES"
These variants are also available:
.RS 2m
$ gcloud alpha managed\-kafka connect\-clusters update
.RE
.RS 2m
$ gcloud beta managed\-kafka connect\-clusters update
.RE