.TH "GCLOUD_BETA_ALLOYDB_INSTANCES_UPDATE" 1



.SH "NAME"
.HP
gcloud beta alloydb instances update \- updates an AlloyDB instance within a given cluster



.SH "SYNOPSIS"
.HP
\f5gcloud beta alloydb instances update\fR \fIINSTANCE\fR \fB\-\-cluster\fR=\fICLUSTER\fR \fB\-\-region\fR=\fIREGION\fR [\fB\-\-activation\-policy\fR=\fIACTIVATION_POLICY\fR] [\fB\-\-allowed\-psc\-projects\fR=[\fIALLOWED_PSC_PROJECTS\fR,...]] [\fB\-\-assign\-inbound\-public\-ip\fR=\fIASSIGN_INBOUND_PUBLIC_IP\fR] [\fB\-\-async\fR] [\fB\-\-authorized\-external\-networks\fR=[\fIAUTHORIZED_NETWORK\fR,...]] [\fB\-\-availability\-type\fR=\fIAVAILABILITY_TYPE\fR] [\fB\-\-clear\-psc\-network\-attachment\-uri\fR] [\fB\-\-connection\-pooling\-client\-connection\-idle\-timeout\fR=\fICONNECTION_POOLING_CLIENT_CONNECTION_IDLE_TIMEOUT\fR] [\fB\-\-connection\-pooling\-ignore\-startup\-parameters\fR=[\fISTARTUP_PARAMETERS\fR,...]] [\fB\-\-connection\-pooling\-max\-client\-connections\fR=\fICONNECTION_POOLING_MAX_CLIENT_CONNECTIONS\fR] [\fB\-\-connection\-pooling\-max\-pool\-size\fR=\fICONNECTION_POOLING_MAX_POOL_SIZE\fR] [\fB\-\-connection\-pooling\-max\-prepared\-statements\fR=\fICONNECTION_POOLING_MAX_PREPARED_STATEMENTS\fR] [\fB\-\-connection\-pooling\-min\-pool\-size\fR=\fICONNECTION_POOLING_MIN_POOL_SIZE\fR] [\fB\-\-connection\-pooling\-pool\-mode\fR=\fICONNECTION_POOLING_POOL_MODE\fR] [\fB\-\-connection\-pooling\-query\-wait\-timeout\fR=\fICONNECTION_POOLING_QUERY_WAIT_TIMEOUT\fR] [\fB\-\-connection\-pooling\-server\-idle\-timeout\fR=\fICONNECTION_POOLING_SERVER_IDLE_TIMEOUT\fR] [\fB\-\-connection\-pooling\-server\-lifetime\fR=\fICONNECTION_POOLING_SERVER_LIFETIME\fR] [\fB\-\-connection\-pooling\-stats\-users\fR=[\fISTATS_USERS\fR,...]] [\fB\-\-cpu\-count\fR=\fICPU_COUNT\fR] [\fB\-\-database\-flags\fR=\fIFLAG\fR=\fIVALUE\fR,[\fIFLAG\fR=\fIVALUE\fR,...]] [\fB\-\-[no\-]enable\-connection\-pooling\fR] [\fB\-\-insights\-config\-query\-plans\-per\-minute\fR=\fIINSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE\fR] [\fB\-\-insights\-config\-query\-string\-length\fR=\fIINSIGHTS_CONFIG_QUERY_STRING_LENGTH\fR] [\fB\-\-[no\-]insights\-config\-record\-application\-tags\fR] [\fB\-\-[no\-]insights\-config\-record\-client\-address\fR] [\fB\-\-machine\-type\fR=\fIMACHINE_TYPE\fR] [\fB\-\-[no\-]observability\-config\-enabled\fR] [\fB\-\-observability\-config\-max\-query\-string\-length\fR=\fIOBSERVABILITY_CONFIG_MAX_QUERY_STRING_LENGTH\fR] [\fB\-\-[no\-]observability\-config\-preserve\-comments\fR] [\fB\-\-observability\-config\-query\-plans\-per\-minute\fR=\fIOBSERVABILITY_CONFIG_QUERY_PLANS_PER_MINUTE\fR] [\fB\-\-[no\-]observability\-config\-record\-application\-tags\fR] [\fB\-\-[no\-]observability\-config\-track\-active\-queries\fR] [\fB\-\-observability\-config\-track\-wait\-events\fR] [\fB\-\-[no\-]outbound\-public\-ip\fR] [\fB\-\-psc\-network\-attachment\-uri\fR=\fIPSC_NETWORK_ATTACHMENT_URI\fR] [\fB\-\-read\-pool\-node\-count\fR=\fIREAD_POOL_NODE_COUNT\fR] [\fB\-\-[no\-]require\-connectors\fR] [\fB\-\-ssl\-mode\fR=\fISSL_MODE\fR] [\fB\-\-update\-mode\fR=\fIUPDATE_MODE\fR] [\fB\-\-clear\-psc\-auto\-connections\fR\ |\ \fB\-\-psc\-auto\-connections\fR=[\fInetwork\fR=\fINETWORK\fR],[\fIproject\fR=\fIPROJECT\fR]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Updates an AlloyDB instance within a given cluster.



.SH "EXAMPLES"

To update the number of nodes in the read pool, run:

.RS 2m
$ gcloud beta alloydb instances update my\-read\-instance \e
    \-\-cluster=my\-cluster \-\-region=us\-central1 \e
    \-\-read\-pool\-node\-count=3
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIINSTANCE\fR

AlloyDB instance ID


.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-cluster\fR=\fICLUSTER\fR

AlloyDB cluster ID

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

Regional location (e.g. \f5asia\-east1\fR, \f5us\-east1\fR). See the full list
of regions at https://cloud.google.com/sql/docs/instance\-locations.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-activation\-policy\fR=\fIACTIVATION_POLICY\fR

Activation Policy for the instance. Required to START or STOP an instance.
ALWAYS \- The instance is up and running. NEVER \- The instance is stopped.
\fIACTIVATION_POLICY\fR must be one of: \fBALWAYS\fR, \fBNEVER\fR.

.TP 2m
\fB\-\-allowed\-psc\-projects\fR=[\fIALLOWED_PSC_PROJECTS\fR,...]

Comma\-separated list of allowed consumer projects to create endpoints for
Private Service Connect (PSC) connectivity for the instance. Only instances in
PSC\-enabled clusters are allowed to set this field.(e.g.,
\f5\-\-allowed\-psc\-projects=project1,12345678,project2)

.TP 2m
\fB\-\-assign\-inbound\-public\-ip\fR=\fIASSIGN_INBOUND_PUBLIC_IP\fR

Specify to enable or disable public IP on an instance. ASSIGN_INBOUND_PUBLIC_IP
must be one of:
.RS 2m
.IP "\(em" 2m
\fBNO_PUBLIC_IP\fR
.RS 2m
.IP "\(bu" 2m
This disables public IP on the instance. Updating an instance to disable public
IP will clear the list of authorized networks.
.RE
.sp
.IP "\(em" 2m
\fBASSIGN_IPV4\fR
.RS 2m
.IP "\(bu" 2m
Assign an inbound public IPv4 address for the instance. Public IP is enabled.
.RE
.sp

.RE
.sp
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.
The default is \fBTrue\fR. Enabled by default, use \fB\-\-no\-async\fR to
disable.

.TP 2m
\fB\-\-authorized\-external\-networks\fR=[\fIAUTHORIZED_NETWORK\fR,...]

Comma\-separated list of authorized external networks to set on the instance.
Authorized networks should use CIDR notation (e.g. 1.2.3.4/30). This flag is
only allowed to be set for instances with public IP enabled.

.TP 2m
\fB\-\-availability\-type\fR=\fIAVAILABILITY_TYPE\fR

Specifies level of availability. \fIAVAILABILITY_TYPE\fR must be one of:

.RS 2m
.TP 2m
\fBREGIONAL\fR
Provide high availability instances. Recommended for production instances;
instances automatically fail over to another zone within your selected region.
.TP 2m
\fBZONAL\fR
Provide zonal availability instances. Not recommended for production instances;
instance does not automatically fail over to another zone.
.RE
.sp


.TP 2m
\fB\-\-clear\-psc\-network\-attachment\-uri\fR

Disable outbound connectivity from an AlloyDB instance which uses Private
Service Connect (PSC).

.TP 2m
\fB\-\-connection\-pooling\-client\-connection\-idle\-timeout\fR=\fICONNECTION_POOLING_CLIENT_CONNECTION_IDLE_TIMEOUT\fR

The maximum number of seconds a client is allowed to be idle before it is
disconnected.

.TP 2m
\fB\-\-connection\-pooling\-ignore\-startup\-parameters\fR=[\fISTARTUP_PARAMETERS\fR,...]

Comma\-separated list of startup parameters that should be ignored by the
connection pool.

.TP 2m
\fB\-\-connection\-pooling\-max\-client\-connections\fR=\fICONNECTION_POOLING_MAX_CLIENT_CONNECTIONS\fR

The max client connections for managed connection pooling.

.TP 2m
\fB\-\-connection\-pooling\-max\-pool\-size\fR=\fICONNECTION_POOLING_MAX_POOL_SIZE\fR

The max pool size for managed connection pooling.

.TP 2m
\fB\-\-connection\-pooling\-max\-prepared\-statements\fR=\fICONNECTION_POOLING_MAX_PREPARED_STATEMENTS\fR

The maximum number of prepared statements allowed.

.TP 2m
\fB\-\-connection\-pooling\-min\-pool\-size\fR=\fICONNECTION_POOLING_MIN_POOL_SIZE\fR

The min pool size for managed connection pooling.

.TP 2m
\fB\-\-connection\-pooling\-pool\-mode\fR=\fICONNECTION_POOLING_POOL_MODE\fR

The pool mode for managed connection pooling. \fICONNECTION_POOLING_POOL_MODE\fR
must be one of:

.RS 2m
.TP 2m
\fBSESSION\fR
Session mode for managed connection pooling.
.TP 2m
\fBTRANSACTION\fR
Transaction mode for managed connection pooling.
.RE
.sp


.TP 2m
\fB\-\-connection\-pooling\-query\-wait\-timeout\fR=\fICONNECTION_POOLING_QUERY_WAIT_TIMEOUT\fR

The query wait timeout for managed connection pooling.

.TP 2m
\fB\-\-connection\-pooling\-server\-idle\-timeout\fR=\fICONNECTION_POOLING_SERVER_IDLE_TIMEOUT\fR

The server idle timeout for managed connection pooling.

.TP 2m
\fB\-\-connection\-pooling\-server\-lifetime\fR=\fICONNECTION_POOLING_SERVER_LIFETIME\fR

The lifetime of a server connection in seconds. The pooler will close an unused
(not currently linked to any client connection) server connection that has been
connected longer than this. Setting it to 0 means the connection is to be used
only once, then closed.

.TP 2m
\fB\-\-connection\-pooling\-stats\-users\fR=[\fISTATS_USERS\fR,...]

Comma\-separated list of database users to access connection pooling stats.

.TP 2m
\fB\-\-cpu\-count\fR=\fICPU_COUNT\fR

Whole number value indicating how many vCPUs the machine should contain. If the
instance does not have a machine\-type, the vCPU count will be used to determine
the machine type where each vCPU corresponds to an N2 high\-mem machine:
(https://cloud.google.com/compute/docs/general\-purpose\-machines#n2_machine_types).
where CPU_COUNT can be one of: 2, 4, 8, 16, 32, 64, 96, 128. If the instance has
a machine\-type, cpu\-count must have the same value as the vCPU count in the
machine\-type. Eg: if machine\-type is c4a\-highmem\-4\-lssd, cpu\-count must be
4. \fICPU_COUNT\fR must be one of: \fB1\fR, \fB2\fR, \fB4\fR, \fB8\fR, \fB16\fR,
\fB32\fR, \fB48\fR, \fB64\fR, \fB72\fR, \fB96\fR, \fB128\fR.

.TP 2m
\fB\-\-database\-flags\fR=\fIFLAG\fR=\fIVALUE\fR,[\fIFLAG\fR=\fIVALUE\fR,...]

Comma\-separated list of database flags to set on the instance. Use an equals
sign to separate flag name and value. Flags without values, like
skip_grant_tables, can be written out without a value after, e.g.,
\fRskip_grant_tables=\f5. Use on/off for booleans. View the Instance Resource
API for allowed flags. (e.g., \fR\-\-database\-flags
max_allowed_packet=55555,skip_grant_tables=,log_output=1\f5)

.TP 2m
\fB\-\-[no\-]enable\-connection\-pooling\fR

Enable connection pooling for the instance. Use
\fB\-\-enable\-connection\-pooling\fR to enable and
\fB\-\-no\-enable\-connection\-pooling\fR to disable.

.TP 2m
\fB\-\-insights\-config\-query\-plans\-per\-minute\fR=\fIINSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE\fR

Number of query plans to sample every minute. Default value is 5. Allowed range:
0 to 20.

.TP 2m
\fB\-\-insights\-config\-query\-string\-length\fR=\fIINSIGHTS_CONFIG_QUERY_STRING_LENGTH\fR

Query string length in bytes to be stored by the query insights feature. Default
length is 1024 bytes. Allowed range: 256 to 4500 bytes.

.TP 2m
\fB\-\-[no\-]insights\-config\-record\-application\-tags\fR

Allow application tags to be recorded by the query insights feature.

Use \fB\-\-insights\-config\-record\-application\-tags\fR to enable and
\fB\-\-no\-insights\-config\-record\-application\-tags\fR to disable.

.TP 2m
\fB\-\-[no\-]insights\-config\-record\-client\-address\fR

Allow the client address to be recorded by the query insights feature.

Use \fB\-\-insights\-config\-record\-client\-address\fR to enable and
\fB\-\-no\-insights\-config\-record\-client\-address\fR to disable.

.TP 2m
\fB\-\-machine\-type\fR=\fIMACHINE_TYPE\fR

Specifies machine type for the instance. \fIMACHINE_TYPE\fR must be one of:
\fBn2\-highmem\-2\fR, \fBn2\-highmem\-4\fR, \fBn2\-highmem\-8\fR,
\fBn2\-highmem\-16\fR, \fBn2\-highmem\-32\fR, \fBn2\-highmem\-64\fR,
\fBn2\-highmem\-96\fR, \fBn2\-highmem\-128\fR, \fBc4a\-highmem\-1\fR,
\fBc4a\-highmem\-4\-lssd\fR, \fBc4a\-highmem\-8\-lssd\fR,
\fBc4a\-highmem\-16\-lssd\fR, \fBc4a\-highmem\-32\-lssd\fR,
\fBc4a\-highmem\-48\-lssd\fR, \fBc4a\-highmem\-64\-lssd\fR,
\fBc4a\-highmem\-72\-lssd\fR, \fBc4\-highmem\-4\-lssd\fR,
\fBc4\-highmem\-8\-lssd\fR, \fBc4\-highmem\-16\-lssd\fR,
\fBc4\-highmem\-24\-lssd\fR, \fBc4\-highmem\-32\-lssd\fR,
\fBc4\-highmem\-48\-lssd\fR, \fBc4\-highmem\-96\-lssd\fR,
\fBc4\-highmem\-144\-lssd\fR, \fBc4\-highmem\-192\-lssd\fR,
\fBc4\-highmem\-288\-lssd\fR, \fBz3\-highmem\-14\-standardlssd\fR,
\fBz3\-highmem\-22\-standardlssd\fR, \fBz3\-highmem\-44\-standardlssd\fR,
\fBz3\-highmem\-88\-standardlssd\fR.

.TP 2m
\fB\-\-[no\-]observability\-config\-enabled\fR

Enable enhanced query insights feature. Use
\fB\-\-observability\-config\-enabled\fR to enable and
\fB\-\-no\-observability\-config\-enabled\fR to disable.

.TP 2m
\fB\-\-observability\-config\-max\-query\-string\-length\fR=\fIOBSERVABILITY_CONFIG_MAX_QUERY_STRING_LENGTH\fR

Query string length in bytes to be stored by the enhanced query insights
feature. Default length is 10k bytes.

.TP 2m
\fB\-\-[no\-]observability\-config\-preserve\-comments\fR

Allow preservation of comments in query string recorded by the enhanced query
insights feature.

Use \fB\-\-observability\-config\-preserve\-comments\fR to enable and
\fB\-\-no\-observability\-config\-preserve\-comments\fR to disable.

.TP 2m
\fB\-\-observability\-config\-query\-plans\-per\-minute\fR=\fIOBSERVABILITY_CONFIG_QUERY_PLANS_PER_MINUTE\fR

Number of query plans to sample every minute. Default value is 200. Allowed
range: 0 to 200.

.TP 2m
\fB\-\-[no\-]observability\-config\-record\-application\-tags\fR

Allow application tags to be recorded by the enhanced query insights feature.

Use \fB\-\-observability\-config\-record\-application\-tags\fR to enable and
\fB\-\-no\-observability\-config\-record\-application\-tags\fR to disable.

.TP 2m
\fB\-\-[no\-]observability\-config\-track\-active\-queries\fR

Track actively running queries. Use
\fB\-\-observability\-config\-track\-active\-queries\fR to enable and
\fB\-\-no\-observability\-config\-track\-active\-queries\fR to disable.

.TP 2m
\fB\-\-observability\-config\-track\-wait\-events\fR

Track wait events during query execution.

.TP 2m
\fB\-\-[no\-]outbound\-public\-ip\fR

Add outbound Public IP connectivity to an AlloyDB instance. Use
\fB\-\-outbound\-public\-ip\fR to enable and \fB\-\-no\-outbound\-public\-ip\fR
to disable.

.TP 2m
\fB\-\-psc\-network\-attachment\-uri\fR=\fIPSC_NETWORK_ATTACHMENT_URI\fR

Full URI of the network attachment that is configured to support outbound
connectivity from an AlloyDB instance which uses Private Service Connect (PSC).
For example, this would be of the
form:\fRpsc\-network\-attachment\-uri=projects/test\-project/regions/us\-central1/networkAttachments/my\-na\f5

.TP 2m
\fB\-\-read\-pool\-node\-count\fR=\fIREAD_POOL_NODE_COUNT\fR

Read capacity, i.e. number of nodes in a read pool instance.

.TP 2m
\fB\-\-[no\-]require\-connectors\fR

Enable or disable enforcing connectors only (ex: AuthProxy) connections to the
database. Use \fB\-\-require\-connectors\fR to enable and
\fB\-\-no\-require\-connectors\fR to disable.

.TP 2m
\fB\-\-ssl\-mode\fR=\fISSL_MODE\fR

Specify the SSL mode to use when the instance connects to the database.
\fISSL_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBALLOW_UNENCRYPTED_AND_ENCRYPTED\fR
SSL connections are optional. CA verification is not enforced.
.TP 2m
\fBENCRYPTED_ONLY\fR
SSL connections are required. CA verification is not enforced.
.RE
.sp


.TP 2m
\fB\-\-update\-mode\fR=\fIUPDATE_MODE\fR

Specify the mode for updating the instance. If unspecified, the update would
follow a least disruptive approach. \fIUPDATE_MODE\fR must be (only one value is
supported):

.RS 2m
.TP 2m
\fBFORCE_APPLY\fR
Performs a forced update when applicable. This will be fast but may incur a
downtime.
.RE
.sp


.TP 2m

PSC auto connection options for an AlloyDB instance.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-psc\-auto\-connections\fR

Remove all PSC auto connections for an AlloyDB instance.

.TP 2m
\fB\-\-psc\-auto\-connections\fR=[\fInetwork\fR=\fINETWORK\fR],[\fIproject\fR=\fIPROJECT\fR]

Comma\-separated list of consumer project and consumer network pairs to create
endpoints for Private Service Connect (PSC) connectivity for the instance. Only
instances in PSC\-enabled clusters are allowed to set this field. Both project
and network must be specified. (e.g.,
\fR\-\-psc\-auto\-connections=project=project1,network=projects/vpc\-host\-project1/global/networks/network1\f5
\fR\-\-psc\-auto\-connections=project=project2,network=projects/vpc\-host\-project2/global/networks/network2\f5).
Sets \fRpsc_auto_connections\f5 value.

.RS 2m
.TP 2m
\fBnetwork\fR
Required, sets \fRnetwork\f5 value.

.TP 2m
\fBproject\fR
Required, sets \fRproject\f5 value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-psc\-auto\-connections=network=string,project=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-psc\-auto\-connections='{"network": "string", "project": "string"}'
.RE


\fBFile Example:\fR


.RS 2m
\-\-psc\-auto\-connections=path_to_file.(yaml|json)
.RE



\fR
.RE
.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 "NOTES"

This command is currently in beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud alloydb instances update
.RE

.RS 2m
$ gcloud alpha alloydb instances update
.RE