.TH "GCLOUD_ALPHA_ALLOYDB_CLUSTERS_RESTORE" 1



.SH "NAME"
.HP
gcloud alpha alloydb clusters restore \- restore an AlloyDB cluster from a given backup or a source cluster and a timestamp



.SH "SYNOPSIS"
.HP
\f5gcloud alpha alloydb clusters restore\fR \fICLUSTER\fR \fB\-\-region\fR=\fIREGION\fR (\fB\-\-backup\fR=\fIBACKUP\fR\ |\ \fB\-\-backupdr\-backup\fR=\fIBACKUPDR_BACKUP\fR\ |\ \fB\-\-point\-in\-time\fR=\fIPOINT_IN_TIME\fR\ (\fB\-\-backupdr\-data\-source\fR=\fIBACKUPDR_DATA_SOURCE\fR\ |\ \fB\-\-source\-cluster\fR=\fISOURCE_CLUSTER\fR)) [\fB\-\-allocated\-ip\-range\-name\fR=\fIALLOCATED_IP_RANGE_NAME\fR] [\fB\-\-async\fR] [\fB\-\-enable\-private\-service\-connect\fR] [\fB\-\-network\fR=\fINETWORK\fR] [\fB\-\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-kms\-key\fR=\fIKMS_KEY\fR\ :\ \fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR\ \fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR\ \fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Restore an AlloyDB cluster from a given backup or a source cluster
and a timestamp.



.SH "EXAMPLES"

To restore a cluster from a backup, run:

.RS 2m
$ gcloud alpha alloydb clusters restore my\-cluster \e
  \-\-region=us\-central1 \-\-backup=my\-backup
.RE

To restore a cluster from a source cluster and a timestamp, run:

.RS 2m
$ gcloud alpha alloydb clusters restore my\-cluster \e
  \-\-region=us\-central1 \-\-source\-cluster=old\-cluster \e
  \-\-point\-in\-time=2012\-11\-15T16:19:00.094Z
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fICLUSTER\fR

AlloyDB cluster ID


.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.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.

.TP 2m

RestoreCluster source types.

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-backup\fR=\fIBACKUP\fR

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 the
same as the restored cluster that is being created.

.TP 2m
\fB\-\-backupdr\-backup\fR=\fIBACKUPDR_BACKUP\fR

Backup DR backup to restore from. This is a resource path of the form
projects/myProject/locations/us\-central1/backupVaults/myBackupVault/dataSources/myDataSource/backups/myBackup.

.TP 2m

Restore a cluster from a source cluster at a given point in time.


.RS 2m
.TP 2m
\fB\-\-point\-in\-time\fR=\fIPOINT_IN_TIME\fR

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 group
are specified.

.TP 2m

Source for a point in time restore operation.

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-backupdr\-data\-source\fR=\fIBACKUPDR_DATA_SOURCE\fR

Backup DR data source to restore from. This is a resource path of the form
projects/myProject/locations/us\-central1/backupVaults/myBackupVault/dataSources/myDataSource.

.TP 2m
\fB\-\-source\-cluster\fR=\fISOURCE_CLUSTER\fR

AlloyDB source cluster to restore from. This must either be the full cluster
name (projects/myProject/locations/us\-central1/backups/myCluster) or the
cluster ID (myCluster). In the second case, the project and location are assumed
to be the same as the restored cluster that is being created.


.RE
.RE
.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-allocated\-ip\-range\-name\fR=\fIALLOCATED_IP_RANGE_NAME\fR

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 cluster
will be created in the allocated range. The range name must comply with RFC
1035. Specifically, the name must be 1\-63 characters long and match the regular
expression \f5[a\-z]([\-a\-z0\-9]*[a\-z0\-9])?\fR.

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

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-enable\-private\-service\-connect\fR

Enable Private Service Connect (PSC) connectivity for the cluster.

.TP 2m
\fB\-\-network\fR=\fINETWORK\fR

Network in the current project that the instance will be part of. To specify
using a network with a shared VPC, use the full URL of the network. For an
example host project, \f5testproject\fR, and shared network,
\f5testsharednetwork\fR, this would be of the
form:\f5\-\-network=projects/testproject/global/networks/testsharednetwork\fR

.TP 2m
\fB\-\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of tags KEY=VALUE pairs to bind. Each item must be expressed as
\f5<tag\-key\-namespaced\-name>=<tag\-value\-short\-name>\fR.

Example: \f5123/environment=production,123/costCenter=marketing\fR

.TP 2m

Key resource \- The Cloud KMS (Key Management Service) cryptokey that will be
used to protect the cluster. The 'AlloyDB Service Agent' service account must
hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. The arguments in this
group can be used to specify the attributes of this resource.


.RS 2m
.TP 2m
\fB\-\-kms\-key\fR=\fIKMS_KEY\fR

ID of the key or fully qualified identifier for the key.

To set the \f5kms\-key\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line.
.RE
.sp

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR

The KMS keyring of the key.

To set the \f5kms\-keyring\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-keyring\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR

The Google Cloud location for the key.

To set the \f5kms\-location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-location\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR

The Google Cloud project for the key.

To set the \f5kms\-project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-project\fR on the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp


.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 alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:

.RS 2m
$ gcloud alloydb clusters restore
.RE

.RS 2m
$ gcloud beta alloydb clusters restore
.RE