.TH "GCLOUD_ALPHA_KMS_KEYRINGS_CONFIG_EXPORT" 1



.SH "NAME"
.HP
gcloud alpha kms keyrings config export \- export the configuration for a Cloud KMS key ring



.SH "SYNOPSIS"
.HP
\f5gcloud alpha kms keyrings config export\fR ([\fIKEYRING\fR\ :\ \fB\-\-location\fR=\fILOCATION\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 kms keyrings config export\fR exports the
configuration for a Cloud KMS key ring.

Key ring 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 key
rings 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 a key ring, run:

.RS 2m
$ gcloud alpha kms keyrings config export my\-key\-ring
.RE

To export the configuration for a key ring to a file, run:

.RS 2m
$ gcloud alpha kms keyrings config export my\-key\-ring \e
    \-\-path=/path/to/dir/
.RE

To export the configuration for a key ring in Terraform HCL format, run:

.RS 2m
$ gcloud alpha kms keyrings config export my\-key\-ring \e
    \-\-resource\-format=terraform
.RE

To export the configurations for all key rings within a project, run:

.RS 2m
$ gcloud alpha kms keyrings config export \-\-all
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m

Keyring resource \- Key ring to export the configuration for. The arguments in
this group can be used to specify the attributes of this resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.

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


.RS 2m
.TP 2m
\fIKEYRING\fR

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

To set the \f5keyring\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5keyring\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location of the resource.

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

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