gcloud beta alloydb clusters restore Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta alloydb clusters restore - restore an AlloyDB cluster from a given backup or a source cluster and a timestamp
- SYNOPSIS
gcloud beta alloydb clusters restoreCLUSTER--region=REGION(--backup=BACKUP|--backupdr-backup=BACKUPDR_BACKUP|--point-in-time=POINT_IN_TIME(--backupdr-data-source=BACKUPDR_DATA_SOURCE|--source-cluster=SOURCE_CLUSTER))[--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME][--async][--enable-private-service-connect][--network=NETWORK][--tags=[KEY=VALUE,…]][--kms-key=KMS_KEY:--kms-keyring=KMS_KEYRING--kms-location=KMS_LOCATION--kms-project=KMS_PROJECT][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(BETA)Restore an AlloyDB cluster from a given backup or a sourcecluster and a timestamp.- EXAMPLES
- To restore a cluster from a backup, run:
gcloudbetaalloydbclustersrestoremy-cluster--region=us-central1--backup=my-backupTo restore a cluster from a source cluster and a timestamp, run:
gcloudbetaalloydbclustersrestoremy-cluster--region=us-central1--source-cluster=old-cluster--point-in-time=2012-11-15T16:19:00.094Z - POSITIONAL ARGUMENTS
CLUSTER- AlloyDB cluster ID
- REQUIRED FLAGS
--region=REGION- Regional location (e.g.
asia-east1,us-east1). See thefull list of regions athttps://cloud.google.com/sql/docs/instance-locations. - RestoreCluster source types.
Exactly one of these must be specified:
--backup=BACKUP- AlloyDB backup to restore from. This must either be the full backup name(projects/myProject/locations/us-central1/backups/myBackup) or the backup ID(myBackup). In the second case, the project and location are assumed to be thesame as the restored cluster that is being created.
--backupdr-backup=BACKUPDR_BACKUP- Backup DR backup to restore from. This is a resource path of the formprojects/myProject/locations/us-central1/backupVaults/myBackupVault/dataSources/myDataSource/backups/myBackup.
- Or at least one of these can be specified:
- Restore a cluster from a source cluster at a given point in time.
--point-in-time=POINT_IN_TIME- Point in time to restore to, in RFC 3339 format. For example,2012-11-15T16:19:00.094Z.
This flag argument must be specified if any of the other arguments in this groupare specified.
- Source for a point in time restore operation.
Exactly one of these must be specified:
--backupdr-data-source=BACKUPDR_DATA_SOURCE- Backup DR data source to restore from. This is a resource path of the formprojects/myProject/locations/us-central1/backupVaults/myBackupVault/dataSources/myDataSource.
--source-cluster=SOURCE_CLUSTER- AlloyDB source cluster to restore from. This must either be the full clustername (projects/myProject/locations/us-central1/backups/myCluster) or the clusterID (myCluster). In the second case, the project and location are assumed to bethe same as the restored cluster that is being created.
- 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.
--enable-private-service-connect- Enable Private Service Connect (PSC) connectivity for the cluster.
--network=NETWORK- Network in the current project that the instance will be part of. To specifyusing a network with a shared VPC, use the full URL of the network. For anexample host project,
testproject, and shared network,testsharednetwork, this would be of theform:--network=projects/testproject/global/networks/testsharednetwork --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 - 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:
gcloudalloydbclustersrestoregcloudalphaalloydbclustersrestore
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.