- NAME
-
- gcloud alpha kms keys config export - export the configuration for a Cloud KMS crypto key
- SYNOPSIS
-
-
gcloud alpha kms keys config export
([KEY
:--keyring
=KEYRING
--location
=LOCATION
]--all
) [--path
=PATH
; default="-"] [--resource-format
=RESOURCE_FORMAT
] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
gcloud alpha kms keys config export
exports the configuration for a Cloud KMS crypto key.Crypto key configurations can be exported in Kubernetes Resource Model (krm) or Terraform HCL formats. The default format is
krm
.Specifying
--all
allows you to export the configurations for all crypto keys within the project.Specifying
--path
allows you to export the configuration(s) to a local directory. - EXAMPLES
-
To export the configuration for a crypto key, run:
gcloud alpha kms keys config export my-crypto-key
To export the configuration for a crypto key to a file, run:
gcloud alpha kms keys config export my-crypto-key --path=/path/to/dir/
To export the configuration for a crypto key in Terraform HCL format, run:
gcloud alpha kms keys config export my-crypto-key --resource-format=terraform
To export the configurations for all crypto keys within a project, run:
gcloud alpha kms keys config export --all
- POSITIONAL ARGUMENTS
-
-
Exactly one of these must be specified:
-
Key resource - Crypto key 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
project
attribute:-
provide the argument
key
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
KEY
-
ID of the key or fully qualified identifier for the key.
To set the
key
attribute:-
provide the argument
key
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--keyring
=KEYRING
-
The containing keyring.
To set the
keyring
attribute:-
provide the argument
key
on the command line with a fully specified name; -
provide the argument
--keyring
on the command line.
-
provide the argument
--location
=LOCATION
-
The location of the resource.
To set the
location
attribute:-
provide the argument
key
on the command line with a fully specified name; -
provide the argument
--location
on the command line.
-
provide the argument
-
provide the argument
--all
-
Retrieve all resources within the project. If
--path
is specified and is a valid directory, resources will be output as individual files based on resource name and scope. If--path
is not specified, resources will be streamed to stdout.
-
Key resource - Crypto key 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.
-
Exactly one of these must be specified:
- FLAGS
-
--path
=PATH
; default="-"- Path of the directory or file to output configuration(s). To output configurations to stdout, specify "--path=-".
--resource-format
=RESOURCE_FORMAT
-
Format of the configuration to export. Available configuration formats are
Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command
defaults to "krm".
RESOURCE_FORMAT
must be one of:krm
,terraform
.
- 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 help
for details. - 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-06 UTC.