Console
Start free

gcloud alpha kms keyrings config export

NAME
gcloud alpha kms keyrings config export - export the configuration for a Cloud KMS key ring
SYNOPSIS
gcloud alpha kms keyrings config export ([KEYRING : --location=LOCATION] --all) [--path=PATH; default="-"] [--resource-format=RESOURCE_FORMAT] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) gcloud alpha kms keyrings config export 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 krm.

Specifying --all allows you to export the configurations for all key rings within the project.

Specifying --path allows you to export the configuration(s) to a local directory.
EXAMPLES
To export the configuration for a key ring, run: 
gcloud alpha kms keyrings config export my-key-ring

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

gcloud alpha kms keyrings config export my-key-ring --path=/path/to/dir/

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

gcloud alpha kms keyrings config export my-key-ring --resource-format=terraform

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

gcloud alpha kms keyrings config export --all
POSITIONAL ARGUMENTS
Exactly one of these must be specified: 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 project attribute:
KEYRING
ID of the keyring or fully qualified identifier for the keyring. To set the keyring attribute: provide the argument keyring on the command line. This positional argument must be specified if any of the other arguments in this group are specified.
--location=LOCATION
The location of the resource. To set the location attribute:
  • provide the argument keyring on the command line with a fully specified name;
    • provide the argument --location on the command line.
    --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.
    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.