gcloud beta alloydb clusters create-secondary Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta alloydb clusters create-secondary - create a new AlloyDB SECONDARY cluster within a given project
- SYNOPSIS
gcloud beta alloydb clusters create-secondaryCLUSTER--primary-cluster=PRIMARY_CLUSTER--region=REGION[--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME][--async][--tags=[KEY=VALUE,…]][--automated-backup-days-of-week=[DAYS_OF_WEEK,…]--automated-backup-start-times=[START_TIMES,…]--automated-backup-window=TIMEOUT_PERIOD--enable-automated-backup[--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY:--automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING--automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION--automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT]--automated-backup-retention-count=RETENTION_COUNT|--automated-backup-retention-period=RETENTION_PERIOD][--continuous-backup-recovery-window-days=RECOVERY_PERIOD--enable-continuous-backup[--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY:--continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING--continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION--continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT]][--kms-key=KMS_KEY:--kms-keyring=KMS_KEYRING--kms-location=KMS_LOCATION--kms-project=KMS_PROJECT][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(BETA)Create a new AlloyDB SECONDARY cluster within a givenproject.- EXAMPLES
- To create a new cluster, run:
gcloudbetaalloydbclusterscreate-secondarymy-cluster--region=us-central1--primary-cluster=projects/12345/locations/us-central1/clusters/cluster1 - POSITIONAL ARGUMENTS
CLUSTER- AlloyDB cluster ID
- REQUIRED FLAGS
--primary-cluster=PRIMARY_CLUSTER- AlloyDB primary 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-name=ALLOCATED_IP_RANGE_NAME- Name of the allocated IP range for the private IP AlloyDB cluster, for example:"google-managed-services-default". If set, the instance IPs for this clusterwill be created in the allocated range. The range name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regularexpression
[a-z]([-a-z0-9]*[a-z0-9])?. --async- Return immediately, without waiting for the operation in progress to complete.
--tags=[KEY=VALUE,…]- List of tags KEY=VALUE pairs to bind. Each item must be expressed as
<tag-key-namespaced-name>=<tag-value-short-name>.Example:
123/environment=production,123/costCenter=marketing - Automated backup policy. If unspecified, automated backups are copied from theassociated primary cluster.
--automated-backup-days-of-week=[DAYS_OF_WEEK,…]- Comma-separated list of days of the week to perform a backup. At least one dayof the week must be provided. (e.g.,--automated-backup-days-of-week=MONDAY,WEDNESDAY,SUNDAY).
DAYS_OF_WEEKmust be one of:MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY. --automated-backup-start-times=[START_TIMES,…]- Comma-separated list of times during the day to start a backup. At least onestart time must be provided. The start times are assumed to be in UTC andrequired to be an exact hour in the format HH:00. (e.g.,
--automated-backup-start-times=01:00,13:00) --automated-backup-window=TIMEOUT_PERIOD- The length of the time window beginning at start time during which a backup canbe taken. If a backup does not succeed within this time window, it will becanceled and considered failed. The backup window must be at least 5 minuteslong. There is no upper bound on the window. If not set, it will default to 1hour.
--enable-automated-backup- Enables Automated Backups on the cluster.
- Key resource - The Cloud KMS (Key Management Service) cryptokey that will beused to protect the automated backups. The 'AlloyDB Service Agent' serviceaccount must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. Thearguments in this group can be used to specify the attributes of this resource.
--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY- ID of the key or fully qualified identifier for the key.
To set the
kms-keyattribute:- provide the argument
--automated-backup-encryption-keyon thecommand line.
This flag argument must be specified if any of the other arguments in this groupare specified.
- provide the argument
--automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING- The KMS keyring of the key.
To set the
kms-keyringattribute:- provide the argument
--automated-backup-encryption-keyon thecommand line with a fully specified name; - provide the argument
--automated-backup-encryption-key-keyringonthe command line.
- provide the argument
--automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION- The Google Cloud location for the key.
To set the
kms-locationattribute:- provide the argument
--automated-backup-encryption-keyon thecommand line with a fully specified name; - provide the argument
--automated-backup-encryption-key-locationonthe command line.
- provide the argument
--automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT- The Google Cloud project for the key.
To set the
kms-projectattribute:- provide the argument
--automated-backup-encryption-keyon thecommand line with a fully specified name; - provide the argument
--automated-backup-encryption-key-projectonthe command line; - set the property
core/project.
- provide the argument
- Retention policy. If no retention policy is provided, all automated backups willbe retained.
At most one of these can be specified:
--automated-backup-retention-count=RETENTION_COUNT- Number of most recent successful backups retained.
--automated-backup-retention-period=RETENTION_PERIOD- Retention period of the backup relative to creation time. See
$gcloud topic datetimesfor information on duration formats.
- Continuous Backup configuration. If unspecified, continuous backups are copiedfrom the associated primary cluster.
--continuous-backup-recovery-window-days=RECOVERY_PERIOD- Recovery window of the log files and backups saved to support ContinuousBackups.
--enable-continuous-backup- Enables Continuous Backups on the cluster.
- Key resource - The Cloud KMS (Key Management Service) cryptokey that will beused to protect the continuous backup. The 'AlloyDB Service Agent's serviceaccount must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. Thearguments in this group can be used to specify the attributes of this resource.
--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY- ID of the key or fully qualified identifier for the key.
To set the
kms-keyattribute:- provide the argument
--continuous-backup-encryption-keyon thecommand line.
This flag argument must be specified if any of the other arguments in this groupare specified.
- provide the argument
--continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING- The KMS keyring of the key.
To set the
kms-keyringattribute:- provide the argument
--continuous-backup-encryption-keyon thecommand line with a fully specified name; - provide the argument
--continuous-backup-encryption-key-keyringonthe command line.
- provide the argument
--continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION- The Google Cloud location for the key.
To set the
kms-locationattribute:- provide the argument
--continuous-backup-encryption-keyon thecommand line with a fully specified name; - provide the argument
--continuous-backup-encryption-key-locationonthe command line.
- provide the argument
--continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT- The Google Cloud project for the key.
To set the
kms-projectattribute:- provide the argument
--continuous-backup-encryption-keyon thecommand line with a fully specified name; - provide the argument
--continuous-backup-encryption-key-projectonthe command line; - set the property
core/project.
- provide the argument
- Key resource - The Cloud KMS (Key Management Service) cryptokey that will beused to protect the cluster. The 'AlloyDB Service Agent' service account musthold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. The arguments in thisgroup can be used to specify the attributes of this resource.
--kms-key=KMS_KEY- ID of the key or fully qualified identifier for the key.
To set the
kms-keyattribute:- provide the argument
--kms-keyon the command line.
This flag argument must be specified if any of the other arguments in this groupare specified.
- provide the argument
--kms-keyring=KMS_KEYRING- The KMS keyring of the key.
To set the
kms-keyringattribute:- provide the argument
--kms-keyon the command line with a fullyspecified name; - provide the argument
--kms-keyringon the command line.
- provide the argument
--kms-location=KMS_LOCATION- The Google Cloud location for the key.
To set the
kms-locationattribute:- provide the argument
--kms-keyon the command line with a fullyspecified name; - provide the argument
--kms-locationon the command line.
- provide the argument
--kms-project=KMS_PROJECT- The Google Cloud project for the key.
To set the
kms-projectattribute:- provide the argument
--kms-keyon the command line with a fullyspecified name; - provide the argument
--kms-projecton the command line; - set the property
core/project.
- provide the argument
- 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. - NOTES
- This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudalloydbclusterscreate-secondarygcloudalphaalloydbclusterscreate-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 2026-01-21 UTC.