gcloud beta alloydb instances create-secondary

NAME
gcloud beta alloydb instances create-secondary - creates a new AlloyDB SECONDARY instance within a given cluster
SYNOPSIS
gcloud beta alloydb instances create-secondaryINSTANCE--cluster=CLUSTER--region=REGION[--allocated-ip-range-override=ALLOCATED_IP_RANGE_OVERRIDE][--allowed-psc-projects=[ALLOWED_PSC_PROJECTS,…]][--assign-inbound-public-ip=ASSIGN_INBOUND_PUBLIC_IP][--async][--authorized-external-networks=[AUTHORIZED_NETWORK,…]][--availability-type=AVAILABILITY_TYPE][--connection-pooling-client-connection-idle-timeout=CONNECTION_POOLING_CLIENT_CONNECTION_IDLE_TIMEOUT][--connection-pooling-ignore-startup-parameters=[STARTUP_PARAMETERS,…]][--connection-pooling-max-client-connections=CONNECTION_POOLING_MAX_CLIENT_CONNECTIONS][--connection-pooling-max-pool-size=CONNECTION_POOLING_MAX_POOL_SIZE][--connection-pooling-max-prepared-statements=CONNECTION_POOLING_MAX_PREPARED_STATEMENTS][--connection-pooling-min-pool-size=CONNECTION_POOLING_MIN_POOL_SIZE][--connection-pooling-pool-mode=CONNECTION_POOLING_POOL_MODE][--connection-pooling-query-wait-timeout=CONNECTION_POOLING_QUERY_WAIT_TIMEOUT][--connection-pooling-server-idle-timeout=CONNECTION_POOLING_SERVER_IDLE_TIMEOUT][--connection-pooling-server-lifetime=CONNECTION_POOLING_SERVER_LIFETIME][--connection-pooling-stats-users=[STATS_USERS,…]][--database-flags=FLAG=VALUE,[FLAG=VALUE,…]][--[no-]enable-connection-pooling][--[no-]outbound-public-ip][--psc-auto-connections=[network=NETWORK],[project=PROJECT]][--psc-network-attachment-uri=PSC_NETWORK_ATTACHMENT_URI][--[no-]require-connectors][--ssl-mode=SSL_MODE][GCLOUD_WIDE_FLAG]
DESCRIPTION
(BETA) Creates a new AlloyDB SECONDARY instance within a givencluster.
EXAMPLES
To create a new secondary instance, run:
gcloudbetaalloydbinstancescreate-secondarymy-instance--cluster=my-cluster--region=us-central1
POSITIONAL ARGUMENTS
INSTANCE
AlloyDB instance ID
REQUIRED FLAGS
--cluster=CLUSTER
AlloyDB cluster ID
--region=REGION
Regional location (e.g.asia-east1,us-east1). See thefull list of regions athttps://cloud.google.com/sql/docs/instance-locations.
OPTIONAL FLAGS
--allocated-ip-range-override=ALLOCATED_IP_RANGE_OVERRIDE
Name of the allocated IP range for the private IP AlloyDB instance, for example:"google-managed-services-default". If set, the instance IPs will be created fromthis allocated range and will override the IP range used by the parent cluster.The range name must comply with RFC 1035. Specifically, the name must be 1-63characters long and match the regular expression[a-z]([-a-z0-9]*[a-z0-9])?.
--allowed-psc-projects=[ALLOWED_PSC_PROJECTS,…]
Comma-separated list of allowed consumer projects to create endpoints forPrivate Service Connect (PSC) connectivity for the instance. Only instances inPSC-enabled clusters are allowed to set this field.(e.g.,--allowed-psc-projects=project1,12345678,project2)
--assign-inbound-public-ip=ASSIGN_INBOUND_PUBLIC_IP
Specify to enable or disable public IP on an instance. ASSIGN_INBOUND_PUBLIC_IPmust be one of:
  • NO_PUBLIC_IP
    • This disables public IP on the instance. Updating an instance to disable publicIP will clear the list of authorized networks.
  • ASSIGN_IPV4
    • Assign an inbound public IPv4 address for the instance. Public IP is enabled.
--async
Return immediately, without waiting for the operation in progress to complete.
--authorized-external-networks=[AUTHORIZED_NETWORK,…]
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 isonly allowed to be set for instances with public IP enabled.
--availability-type=AVAILABILITY_TYPE
Specifies level of availability.AVAILABILITY_TYPE mustbe one of:
REGIONAL
Provide high availability instances. Recommended for production instances;instances automatically fail over to another zone within your selected region.
ZONAL
Provide zonal availability instances. Not recommended for production instances;instance does not automatically fail over to another zone.
--connection-pooling-client-connection-idle-timeout=CONNECTION_POOLING_CLIENT_CONNECTION_IDLE_TIMEOUT
The maximum number of seconds a client is allowed to be idle before it isdisconnected.
--connection-pooling-ignore-startup-parameters=[STARTUP_PARAMETERS,…]
Comma-separated list of startup parameters that should be ignored by theconnection pool.
--connection-pooling-max-client-connections=CONNECTION_POOLING_MAX_CLIENT_CONNECTIONS
The max client connections for managed connection pooling.
--connection-pooling-max-pool-size=CONNECTION_POOLING_MAX_POOL_SIZE
The max pool size for managed connection pooling.
--connection-pooling-max-prepared-statements=CONNECTION_POOLING_MAX_PREPARED_STATEMENTS
The maximum number of prepared statements allowed.
--connection-pooling-min-pool-size=CONNECTION_POOLING_MIN_POOL_SIZE
The min pool size for managed connection pooling.
--connection-pooling-pool-mode=CONNECTION_POOLING_POOL_MODE
The pool mode for managed connection pooling.CONNECTION_POOLING_POOL_MODE must be one of:
SESSION
Session mode for managed connection pooling.
TRANSACTION
Transaction mode for managed connection pooling.
--connection-pooling-query-wait-timeout=CONNECTION_POOLING_QUERY_WAIT_TIMEOUT
The query wait timeout for managed connection pooling.
--connection-pooling-server-idle-timeout=CONNECTION_POOLING_SERVER_IDLE_TIMEOUT
The server idle timeout for managed connection pooling.
--connection-pooling-server-lifetime=CONNECTION_POOLING_SERVER_LIFETIME
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 beenconnected longer than this. Setting it to 0 means the connection is to be usedonly once, then closed.
--connection-pooling-stats-users=[STATS_USERS,…]
Comma-separated list of database users to access connection pooling stats.
--database-flags=FLAG=VALUE,[FLAG=VALUE,…]
Comma-separated list of database flags to set on the instance. Use an equalssign to separate flag name and value. Flags without values, likeskip_grant_tables, can be written out without a value after, e.g.,skip_grant_tables=. Use on/off for booleans. View the InstanceResource API for allowed flags. (e.g.,--database-flagsmax_allowed_packet=55555,skip_grant_tables=,log_output=1)
--[no-]enable-connection-pooling
Enable connection pooling for the instance. Use--enable-connection-pooling to enable and--no-enable-connection-pooling to disable.
--[no-]outbound-public-ip
Add outbound Public IP connectivity to an AlloyDB instance. Use--outbound-public-ip to enable and--no-outbound-public-ip to disable.
--psc-auto-connections=[network=NETWORK],[project=PROJECT]
Comma-separated list of consumer project and consumer network pairs to createendpoints for Private Service Connect (PSC) connectivity for the instance. Onlyinstances in PSC-enabled clusters are allowed to set this field. Both projectand network must be specified. (e.g.,--psc-auto-connections=project=project1,network=projects/vpc-host-project1/global/networks/network1--psc-auto-connections=project=project2,network=projects/vpc-host-project2/global/networks/network2).Setspsc_auto_connections value.
network
Required, setsnetwork value.
project
Required, setsproject value.
Shorthand Example:
--psc-auto-connections=network=string,project=string

JSON Example:

--psc-auto-connections='{"network": "string", "project": "string"}'

File Example:

--psc-auto-connections=path_to_file.(yaml|json)
--psc-network-attachment-uri=PSC_NETWORK_ATTACHMENT_URI
Full URI of the network attachment that is configured to support outboundconnectivity from an AlloyDB instance which uses Private Service Connect (PSC).For example, this would be of theform:psc-network-attachment-uri=projects/test-project/regions/us-central1/networkAttachments/my-na
--[no-]require-connectors
Enable or disable enforcing connectors only (ex: AuthProxy) connections to thedatabase. Use--require-connectors to enable and--no-require-connectors to disable.
--ssl-mode=SSL_MODE
Specify the SSL mode to use when the instance connects to the database. DefaultSSL mode will match what is set on the primary instance.SSL_MODE must be one of:
ALLOW_UNENCRYPTED_AND_ENCRYPTED
SSL connections are optional. CA verification is not enforced.
ENCRYPTED_ONLY
SSL connections are required. CA verification is not enforced.
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.

NOTES
This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudalloydbinstancescreate-secondary
gcloudalphaalloydbinstancescreate-secondary

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-09-24 UTC.