File: //snap/google-cloud-cli/394/help/man/man1/gcloud_alpha_sql_instances_config_export.1
.TH "GCLOUD_ALPHA_SQL_INSTANCES_CONFIG_EXPORT" 1
.SH "NAME"
.HP
gcloud alpha sql instances config export \- export the configuration for a Sqladmin instance
.SH "SYNOPSIS"
.HP
\f5gcloud alpha sql instances config export\fR ([\fIINSTANCE\fR]] \fB\-\-all\fR)\ [\fB\-\-path\fR=\fIPATH\fR; default="\-"]\ [\fB\-\-resource\-format\fR=\fIRESOURCE_FORMAT\fR]\ [\fIGCLOUD_WIDE_FLAG ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR \fBgcloud alpha sql instances config export\fR exports the
configuration for a Sqladmin instance.
Instance configurations can be exported in Kubernetes Resource Model (krm) or
Terraform HCL formats. The default format is \f5krm\fR.
Specifying \f5\-\-all\fR allows you to export the configurations for all
instances within the project.
Specifying \f5\-\-path\fR allows you to export the configuration(s) to a local
directory.
.SH "EXAMPLES"
To export the configuration for an instance, run:
.RS 2m
$ gcloud alpha sql instances config export my\-instance
.RE
To export the configuration for an instance to a file, run:
.RS 2m
$ gcloud alpha sql instances config export my\-instance \e
\-\-path=/path/to/dir/
.RE
To export the configuration for an instance in Terraform HCL format, run:
.RS 2m
$ gcloud alpha sql instances config export my\-instance \e
\-\-resource\-format=terraform
.RE
To export the configurations for all instances within a project, run:
.RS 2m
$ gcloud alpha sql instances config export \-\-all
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Exactly one of these must be specified:
.RS 2m
.TP 2m
\fIINSTANCE\fR
ID of the instance or fully qualified identifier for the instance.
To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\fR on the command line.
.RE
.sp
.TP 2m
\fB\-\-all\fR
Retrieve all resources within the project. If \f5\-\-path\fR is specified and is
a valid directory, resources will be output as individual files based on
resource name and scope. If \f5\-\-path\fR is not specified, resources will be
streamed to stdout.
.RE
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-path\fR=\fIPATH\fR; default="\-"
Path of the directory or file to output configuration(s). To output
configurations to stdout, specify "\-\-path=\-".
.TP 2m
\fB\-\-resource\-format\fR=\fIRESOURCE_FORMAT\fR
Format of the configuration to export. Available configuration formats are
Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command
defaults to "krm". \fIRESOURCE_FORMAT\fR must be one of: \fBkrm\fR,
\fBterraform\fR.
.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.