.TH "GCLOUD_SQL_BACKUPS_RESTORE" 1



.SH "NAME"
.HP
gcloud sql backups restore \- restores a backup of a Cloud SQL instance



.SH "SYNOPSIS"
.HP
\f5gcloud sql backups restore\fR \fIID\fR \fB\-\-restore\-instance\fR=\fIRESTORE_INSTANCE\fR [\fB\-\-activation\-policy\fR=\fIACTIVATION_POLICY\fR] [\fB\-\-active\-directory\-dns\-servers\fR=[\fIDNS_SERVER_IP_ADDRESS\fR,...]] [\fB\-\-active\-directory\-domain\fR=\fIACTIVE_DIRECTORY_DOMAIN\fR] [\fB\-\-active\-directory\-mode\fR=\fIACTIVE_DIRECTORY_MODE\fR] [\fB\-\-active\-directory\-organizational\-unit\fR=\fIACTIVE_DIRECTORY_ORGANIZATIONAL_UNIT\fR] [\fB\-\-active\-directory\-secret\-manager\-key\fR=\fIACTIVE_DIRECTORY_SECRET_MANAGER_KEY\fR] [\fB\-\-[no\-]assign\-ip\fR] [\fB\-\-async\fR] [\fB\-\-audit\-bucket\-path\fR=\fIAUDIT_BUCKET_PATH\fR] [\fB\-\-audit\-retention\-interval\fR=\fIAUDIT_RETENTION_INTERVAL\fR] [\fB\-\-audit\-upload\-interval\fR=\fIAUDIT_UPLOAD_INTERVAL\fR] [\fB\-\-authorized\-networks\fR=\fINETWORK\fR,[\fINETWORK\fR,...]] [\fB\-\-availability\-type\fR=\fIAVAILABILITY_TYPE\fR] [\fB\-\-no\-backup\fR] [\fB\-\-backup\-instance\fR=\fIBACKUP_INSTANCE\fR] [\fB\-\-backup\-location\fR=\fIBACKUP_LOCATION\fR] [\fB\-\-backup\-project\fR=\fIBACKUP_PROJECT\fR] [\fB\-\-backup\-start\-time\fR=\fIBACKUP_START_TIME\fR] [\fB\-\-clear\-active\-directory\fR] [\fB\-\-clear\-active\-directory\-dns\-servers\fR] [\fB\-\-clear\-disk\-encryption\fR=\fICLEAR_DISK_ENCRYPTION\fR] [\fB\-\-clear\-network\fR] [\fB\-\-collation\fR=\fICOLLATION\fR] [\fB\-\-connector\-enforcement\fR=\fICONNECTOR_ENFORCEMENT\fR] [\fB\-\-cpu\fR=\fICPU\fR] [\fB\-\-database\-version\fR=\fIDATABASE_VERSION\fR] [\fB\-\-[no\-]deletion\-protection\fR] [\fB\-\-deny\-maintenance\-period\-end\-date\fR=\fIDENY_MAINTENANCE_PERIOD_END_DATE\fR] [\fB\-\-deny\-maintenance\-period\-start\-date\fR=\fIDENY_MAINTENANCE_PERIOD_START_DATE\fR] [\fB\-\-deny\-maintenance\-period\-time\fR=\fIDENY_MAINTENANCE_PERIOD_TIME\fR] [\fB\-\-edition\fR=\fIEDITION\fR] [\fB\-\-enable\-bin\-log\fR] [\fB\-\-enable\-google\-private\-path\fR] [\fB\-\-enable\-point\-in\-time\-recovery\fR] [\fB\-\-[no\-]final\-backup\fR] [\fB\-\-final\-backup\-retention\-days\fR=\fIFINAL_BACKUP_RETENTION_DAYS\fR] [\fB\-\-insights\-config\-query\-insights\-enabled\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\-\-insights\-config\-record\-application\-tags\fR] [\fB\-\-insights\-config\-record\-client\-address\fR] [\fB\-\-maintenance\-release\-channel\fR=\fIMAINTENANCE_RELEASE_CHANNEL\fR] [\fB\-\-maintenance\-window\-day\fR=\fIMAINTENANCE_WINDOW_DAY\fR] [\fB\-\-maintenance\-window\-hour\fR=\fIMAINTENANCE_WINDOW_HOUR\fR] [\fB\-\-memory\fR=\fIMEMORY\fR] [\fB\-\-network\fR=\fINETWORK\fR] [\fB\-\-require\-ssl\fR] [\fB\-\-retained\-backups\-count\fR=\fIRETAINED_BACKUPS_COUNT\fR] [\fB\-\-retained\-transaction\-log\-days\fR=\fIRETAINED_TRANSACTION_LOG_DAYS\fR] [\fB\-\-ssl\-mode\fR=\fISSL_MODE\fR] [\fB\-\-[no\-]storage\-auto\-increase\fR] [\fB\-\-storage\-provisioned\-iops\fR=\fISTORAGE_PROVISIONED_IOPS\fR] [\fB\-\-storage\-provisioned\-throughput\fR=\fISTORAGE_PROVISIONED_THROUGHPUT\fR] [\fB\-\-storage\-size\fR=\fISTORAGE_SIZE\fR] [\fB\-\-storage\-type\fR=\fISTORAGE_TYPE\fR] [\fB\-\-tier\fR=\fITIER\fR,\ \fB\-t\fR\ \fITIER\fR] [\fB\-\-time\-zone\fR=\fITIME_ZONE\fR] [\fB\-\-timeout\fR=\fITIMEOUT\fR;\ default=3600] [\fB\-\-allowed\-psc\-projects\fR=\fIPROJECT\fR,[\fIPROJECT\fR,...]\ \fB\-\-enable\-private\-service\-connect\fR] [\fB\-\-disk\-encryption\-key\fR=\fIDISK_ENCRYPTION_KEY\fR\ :\ \fB\-\-disk\-encryption\-key\-keyring\fR=\fIDISK_ENCRYPTION_KEY_KEYRING\fR\ \fB\-\-disk\-encryption\-key\-location\fR=\fIDISK_ENCRYPTION_KEY_LOCATION\fR\ \fB\-\-disk\-encryption\-key\-project\fR=\fIDISK_ENCRYPTION_KEY_PROJECT\fR] [\fB\-\-region\fR=\fIREGION\fR\ |\ \fB\-\-gce\-zone\fR=\fIGCE_ZONE\fR\ |\ \fB\-\-secondary\-zone\fR=\fISECONDARY_ZONE\fR\ \fB\-\-zone\fR=\fIZONE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

The command lets you restore to an existing instance using ID. To restore using
a backupDR backup, use the backupDR ID. When backup Name is used to restore it
lets you restore to an existing instance or a new instance. When restoring to
new instance, optional flags can be used to customize the new instance.



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIID\fR

The ID of the backup run to restore from or the backup NAME for restore to
existing/new instance. To find the NAME, run the following command: $ gcloud sql
backups list \-\-filter=instance:{instance}


.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-restore\-instance\fR=\fIRESTORE_INSTANCE\fR

The ID of the target Cloud SQL instance that the backup is restored to.


.RE
.sp

.SH "OPTIONAL FLAGS"

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

Activation policy for this instance. This specifies when the instance should be
activated and is applicable only when the instance state is \f5RUNNABLE\fR. The
default is \f5always\fR. More information on activation policies can be found
here:
https://cloud.google.com/sql/docs/mysql/start\-stop\-restart\-instance#activation_policy.
\fIACTIVATION_POLICY\fR must be one of: \fBalways\fR, \fBnever\fR.

.TP 2m
\fB\-\-active\-directory\-dns\-servers\fR=[\fIDNS_SERVER_IP_ADDRESS\fR,...]

A comma\-separated list of the DNS servers to be used for Active Directory. Only
available for SQL Server instances. E.g: 10.0.0.1,10.0.0.2

.TP 2m
\fB\-\-active\-directory\-domain\fR=\fIACTIVE_DIRECTORY_DOMAIN\fR

Managed Service for Microsoft Active Directory domain this instance is joined
to. Only available for SQL Server instances.

.TP 2m
\fB\-\-active\-directory\-mode\fR=\fIACTIVE_DIRECTORY_MODE\fR

Defines the Active Directory mode. Only available for SQL Server instances.
\fIACTIVE_DIRECTORY_MODE\fR must be one of: \fBMANAGED_ACTIVE_DIRECTORY\fR,
\fBCUSTOMER_MANAGED_ACTIVE_DIRECTORY\fR.

.TP 2m
\fB\-\-active\-directory\-organizational\-unit\fR=\fIACTIVE_DIRECTORY_ORGANIZATIONAL_UNIT\fR

Defines the organizational unit to be used for Active Directory. Only available
for SQL Server instances. E.g: OU=Cloud,DC=ad,DC=example,DC=com

.TP 2m
\fB\-\-active\-directory\-secret\-manager\-key\fR=\fIACTIVE_DIRECTORY_SECRET_MANAGER_KEY\fR

The secret manager key storing administrator credentials. Only available for SQL
Server instances.

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

Assign a public IP address to the instance. This is a public, externally
available IPv4 address that you can use to connect to your instance when
properly authorized. Use \fB\-\-assign\-ip\fR to enable and
\fB\-\-no\-assign\-ip\fR to disable.

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

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

.TP 2m
\fB\-\-audit\-bucket\-path\fR=\fIAUDIT_BUCKET_PATH\fR

The location, as a Cloud Storage bucket, to which audit files are uploaded. The
URI is in the form gs://bucketName/folderName. Only available for SQL Server
instances.

.TP 2m
\fB\-\-audit\-retention\-interval\fR=\fIAUDIT_RETENTION_INTERVAL\fR

The number of days for audit log retention on disk, for example, 3dfor 3 days.
Only available for SQL Server instances.

.TP 2m
\fB\-\-audit\-upload\-interval\fR=\fIAUDIT_UPLOAD_INTERVAL\fR

How often to upload audit logs (audit files), for example, 30mfor 30 minutes.
Only available for SQL Server instances.

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

The list of external networks that are allowed to connect to the instance.
Specified in CIDR notation, also known as 'slash' notation (e.g.
192.168.100.0/24).

.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
Provides high availability and is recommended for production instances; instance
automatically fails over to another zone within your selected region.
.TP 2m
\fBzonal\fR
Provides no failover capability. This is the default.
.RE
.sp


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

Enables daily backup. Enabled by default, use \fB\-\-no\-backup\fR to disable.

.TP 2m
\fB\-\-backup\-instance\fR=\fIBACKUP_INSTANCE\fR

The ID of the instance that the backup was taken from. This argument must be
specified when the backup instance is different from the restore instance. If it
is not specified, the backup instance is considered the same as the restore
instance. This flag is not supported when restore happens from backup name, only
supported when restore happens from backup ID in timestamp format.

.TP 2m
\fB\-\-backup\-location\fR=\fIBACKUP_LOCATION\fR

Choose where to store your backups. Backups are stored in the closest
multi\-region location to you by default. Only customize if needed.

.TP 2m
\fB\-\-backup\-project\fR=\fIBACKUP_PROJECT\fR

The project of the instance to which the backup belongs. If it isn't specified,
backup and restore instances are in the same project. This flag is not supported
when restore happens from backup name, only supported when restore happens from
backup ID in timestamp format.

.TP 2m
\fB\-\-backup\-start\-time\fR=\fIBACKUP_START_TIME\fR

Start time of daily backups, specified in the HH:MM format, in the UTC timezone.

.TP 2m
\fB\-\-clear\-active\-directory\fR

Clears the Active Directory configuration.

.TP 2m
\fB\-\-clear\-active\-directory\-dns\-servers\fR

Removes the list of DNS Servers from the Active Directory Config.

.TP 2m
\fB\-\-clear\-disk\-encryption\fR=\fICLEAR_DISK_ENCRYPTION\fR

Disables CMEK in the restored instance.

.TP 2m
\fB\-\-clear\-network\fR

Clears the network setting. This is useful to restore a backup to a different
project or region where the original network configuration isn't available.

.TP 2m
\fB\-\-collation\fR=\fICOLLATION\fR

Cloud SQL server\-level collation setting, which specifies the set of rules for
comparing characters in a character set.

.TP 2m
\fB\-\-connector\-enforcement\fR=\fICONNECTOR_ENFORCEMENT\fR

Cloud SQL Connector enforcement mode. It determines how Cloud SQL Connectors are
used in the connection. See the list of modes here
(https://cloud.google.com/sql/docs/mysql/admin\-api/rest/v1beta4/instances#connectorenforcement).
\fICONNECTOR_ENFORCEMENT\fR must be one of:

.RS 2m
.TP 2m
\fBCONNECTOR_ENFORCEMENT_UNSPECIFIED\fR
The requirement for Cloud SQL connectors is unknown.
.TP 2m
\fBNOT_REQUIRED\fR
Does not require Cloud SQL connectors.
.TP 2m
\fBREQUIRED\fR
Requires all connections to use Cloud SQL connectors, including the Cloud SQL
Auth Proxy and Cloud SQL Java, Python, and Go connectors. Note: This disables
all existing authorized networks.
.RE
.sp


.TP 2m
\fB\-\-cpu\fR=\fICPU\fR

Whole number value indicating how many cores are desired in the machine. Both
\-\-cpu and \-\-memory must be specified if a custom machine type is desired,
and the \-\-tier flag must be omitted.\-\-cpu and \-\-memory flags are not
compatible with the Enterprise Plus edition. These flags should not be used when
creating an Enterprise Plus edition, as the machine configuration is determined
by the \-\-tier flag instead.

.TP 2m
\fB\-\-database\-version\fR=\fIDATABASE_VERSION\fR

The database engine type and versions. If left unspecified, no changes occur.
See the list of database versions at
https://cloud.google.com/sql/docs/mysql/admin\-api/rest/v1beta4/SqlDatabaseVersion.
Note for restore to new instance major version upgrades are not supported. Only
minor version upgrades are allowed.

.TP 2m
\fB\-\-[no\-]deletion\-protection\fR

Enable deletion protection on a Cloud SQL instance. Use
\fB\-\-deletion\-protection\fR to enable and \fB\-\-no\-deletion\-protection\fR
to disable.

.TP 2m
\fB\-\-deny\-maintenance\-period\-end\-date\fR=\fIDENY_MAINTENANCE_PERIOD_END_DATE\fR

Date when the deny maintenance period ends, that is \f5\fI2021\-01\-10\fR\fR.

.TP 2m
\fB\-\-deny\-maintenance\-period\-start\-date\fR=\fIDENY_MAINTENANCE_PERIOD_START_DATE\fR

Date when the deny maintenance period begins, that is \f5\fI2020\-11\-01\fR\fR.

.TP 2m
\fB\-\-deny\-maintenance\-period\-time\fR=\fIDENY_MAINTENANCE_PERIOD_TIME\fR

Time when the deny maintenance period starts or ends, that is
\f5\fI05:00:00\fR\fR.

.TP 2m
\fB\-\-edition\fR=\fIEDITION\fR

Specifies the edition of Cloud SQL instance. \fIEDITION\fR must be one of:
\fBenterprise\fR, \fBenterprise\-plus\fR.

.TP 2m
\fB\-\-enable\-bin\-log\fR

Allows for data recovery from a specific point in time, down to a fraction of a
second. Must have automatic backups enabled to use. Make sure storage can
support at least 7 days of logs.

.TP 2m
\fB\-\-enable\-google\-private\-path\fR

Enable a private path for Google Cloud services. This flag specifies whether the
instance is accessible to internal Google Cloud services such as BigQuery. This
is only applicable to MySQL and PostgreSQL instances that don't use public IP.
Currently, SQL Server isn't supported.

.TP 2m
\fB\-\-enable\-point\-in\-time\-recovery\fR

Allows for data recovery from a specific point in time, down to a fraction of a
second, via write\-ahead logs. Must have automatic backups enabled to use. Make
sure storage can support at least 7 days of logs.

.TP 2m
\fB\-\-[no\-]final\-backup\fR

Enables the final backup to be taken at the time of instance deletion. Use
\fB\-\-final\-backup\fR to enable and \fB\-\-no\-final\-backup\fR to disable.

.TP 2m
\fB\-\-final\-backup\-retention\-days\fR=\fIFINAL_BACKUP_RETENTION_DAYS\fR

Specifies number of days to retain final backup. The valid range is between 1
and 365. For instances managed by BackupDR, the valid range is between 1 day and
99 years. Default value is 30 days.

.TP 2m
\fB\-\-insights\-config\-query\-insights\-enabled\fR

Enable query insights feature to provide query and query plan analytics.

.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

Sets the default query length limit. For Cloud SQL Enterprise edition, the range
is from 256 to 4500 (in bytes) and the default query length is 1024 bytes. For
Cloud SQL Enterprise Plus edition, the range is from 1024 to 100,000 (in bytes)
and the default query length is 10,000 bytes.

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

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

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

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

.TP 2m
\fB\-\-maintenance\-release\-channel\fR=\fIMAINTENANCE_RELEASE_CHANNEL\fR

Which channel's updates to apply during the maintenance window. If not
specified, Cloud SQL chooses the timing of updates to your instance.
\fIMAINTENANCE_RELEASE_CHANNEL\fR must be one of:

.RS 2m
.TP 2m
\fBpreview\fR
Preview updates release prior to production updates. You may wish to use the
preview channel for dev/test applications so that you can preview their
compatibility with your application prior to the production release.
.TP 2m
\fBproduction\fR
Production updates are stable and recommended for applications in production.
.TP 2m
\fBweek5\fR
week5 updates release after the production updates. Use the week5 channel to
receive a 5 week advance notification about the upcoming maintenance, so you can
prepare your application for the release.
.RE
.sp


.TP 2m
\fB\-\-maintenance\-window\-day\fR=\fIMAINTENANCE_WINDOW_DAY\fR

Day of week for maintenance window, in UTC time zone.
\fIMAINTENANCE_WINDOW_DAY\fR must be one of: \fBSUN\fR, \fBMON\fR, \fBTUE\fR,
\fBWED\fR, \fBTHU\fR, \fBFRI\fR, \fBSAT\fR.

.TP 2m
\fB\-\-maintenance\-window\-hour\fR=\fIMAINTENANCE_WINDOW_HOUR\fR

Hour of day for maintenance window, in UTC time zone.

.TP 2m
\fB\-\-memory\fR=\fIMEMORY\fR

Whole number value indicating how much memory is desired in the machine. A size
unit should be provided (eg. 3072MiB or 9GiB) \- if no units are specified, GiB
is assumed. Both \-\-cpu and \-\-memory must be specified if a custom machine
type is desired, and the \-\-tier flag must be omitted. \-\-cpu and \-\-memory
flags are not compatible with the Enterprise Plus edition. These flags should
not be used when creating an Enterprise Plus edition, as the machine
configuration is determined by the \-\-tier flag instead.

.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, 'testproject', and shared network, 'testsharednetwork',
this would use the form:
\f5\-\-network\fR=\f5projects/testproject/global/networks/testsharednetwork\fR

.TP 2m
\fB\-\-require\-ssl\fR

Specified if users connecting over IP must use SSL.

.TP 2m
\fB\-\-retained\-backups\-count\fR=\fIRETAINED_BACKUPS_COUNT\fR

How many backups to keep. The valid range is between 1 and 365. Default value is
7 for Enterprise edition instances. For Enterprise_Plus, default value is 15.
Applicable only if \-\-no\-backups is not specified.

.TP 2m
\fB\-\-retained\-transaction\-log\-days\fR=\fIRETAINED_TRANSACTION_LOG_DAYS\fR

How many days of transaction logs to keep. The valid range is between 1 and 35.
Only use this option when point\-in\-time recovery is enabled. If logs are
stored on disk, storage size for transaction logs could increase when the number
of days for log retention increases. For Enterprise, default and max retention
values are 7 and 7 respectively. For Enterprise_Plus, default and max retention
values are 14 and 35.

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

Set the SSL mode of the instance. \fISSL_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBALLOW_UNENCRYPTED_AND_ENCRYPTED\fR
Allow non\-SSL and SSL connections. For SSL connections, client certificate will
not be verified.
.TP 2m
\fBENCRYPTED_ONLY\fR
Only allow connections encrypted with SSL/TLS.
.TP 2m
\fBTRUSTED_CLIENT_CERTIFICATE_REQUIRED\fR
Only allow connections encrypted with SSL/TLS and with valid client
certificates.
.RE
.sp


.TP 2m
\fB\-\-[no\-]storage\-auto\-increase\fR

Storage size can be increased, but it cannot be decreased; storage increases are
permanent for the life of the instance. With this setting enabled, a spike in
storage requirements can result in permanently increased storage costs for your
instance. However, if an instance runs out of available space, it can result in
the instance going offline, dropping existing connections. This setting is
enabled by default. Use \fB\-\-storage\-auto\-increase\fR to enable and
\fB\-\-no\-storage\-auto\-increase\fR to disable.

.TP 2m
\fB\-\-storage\-provisioned\-iops\fR=\fISTORAGE_PROVISIONED_IOPS\fR

Indicates how many IOPS to provision for the data disk. This sets the number of
I/O operations per second that the disk can handle.

.TP 2m
\fB\-\-storage\-provisioned\-throughput\fR=\fISTORAGE_PROVISIONED_THROUGHPUT\fR

Indicates how much throughput to provision for the data disk. This sets the
throughput in MB per second that the disk can handle.

.TP 2m
\fB\-\-storage\-size\fR=\fISTORAGE_SIZE\fR

Amount of storage allocated to the instance. Must be an integer number of GB.
The default is 10GB. Information on storage limits can be found here:
https://cloud.google.com/sql/docs/quotas#storage_limits

.TP 2m
\fB\-\-storage\-type\fR=\fISTORAGE_TYPE\fR

The storage type for the instance. The default is SSD. \fISTORAGE_TYPE\fR must
be one of: \fBSSD\fR, \fBHDD\fR, \fBHYPERDISK_BALANCED\fR.

.TP 2m
\fB\-\-tier\fR=\fITIER\fR, \fB\-t\fR \fITIER\fR

Machine type for a shared\-core instance e.g. \f5\fIdb\-g1\-small\fR\fR. For all
other instances, instead of using tiers, customize your instance by specifying
its CPU and memory. You can do so with the \f5\-\-cpu\fR and \f5\-\-memory\fR
flags. Learn more about how CPU and memory affects pricing:
https://cloud.google.com/sql/pricing.

.TP 2m
\fB\-\-time\-zone\fR=\fITIME_ZONE\fR

Set a non\-default time zone. Only available for SQL Server instances.

.TP 2m
\fB\-\-timeout\fR=\fITIMEOUT\fR; default=3600

Time to synchronously wait for the operation to complete, after which the
operation continues asynchronously. Ignored if \-\-async flag is specified. By
default, set to 3600s. To wait indefinitely, set to \fBunlimited\fR.

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

A comma\-separated list of projects. Each project in this list might be
represented by a project number (numeric) or by a project ID (alphanumeric).
This allows Private Service Connect connections to be established from specified
consumer projects.

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

Enable connecting to the Cloud SQL instance with Private Service Connect.

.TP 2m

Key resource \- The Cloud KMS (Key Management Service) cryptokey that will be
used to protect the instance. The 'Compute Engine 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\-\-disk\-encryption\-key\fR=\fIDISK_ENCRYPTION_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\-\-disk\-encryption\-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\-\-disk\-encryption\-key\-keyring\fR=\fIDISK_ENCRYPTION_KEY_KEYRING\fR

The KMS keyring of the key.

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

.TP 2m
\fB\-\-disk\-encryption\-key\-location\fR=\fIDISK_ENCRYPTION_KEY_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\-\-disk\-encryption\-key\fR on the command line with a
fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-disk\-encryption\-key\-location\fR on the command
line.
.RE
.sp

.TP 2m
\fB\-\-disk\-encryption\-key\-project\fR=\fIDISK_ENCRYPTION_KEY_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\-\-disk\-encryption\-key\fR on the command line with a
fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-disk\-encryption\-key\-project\fR on the command
line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp

.RE
.sp
.TP 2m

At most one of these can be specified:


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

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

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-gce\-zone\fR=\fIGCE_ZONE\fR

(DEPRECATED) Preferred Compute Engine zone (e.g. us\-central1\-a,
us\-central1\-b, etc.).

Flag \f5\-\-gce\-zone\fR is deprecated and will be removed by release 255.0.0.
Use \f5\-\-zone\fR instead.

.TP 2m
\fB\-\-secondary\-zone\fR=\fISECONDARY_ZONE\fR

Preferred secondary Compute Engine zone (e.g. us\-central1\-a, us\-central1\-b,
etc.).

.TP 2m
\fB\-\-zone\fR=\fIZONE\fR

Preferred Compute Engine zone (e.g. us\-central1\-a, us\-central1\-b, etc.).


.RE
.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"

These variants are also available:

.RS 2m
$ gcloud alpha sql backups restore
.RE

.RS 2m
$ gcloud beta sql backups restore
.RE