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 exportexports the configuration for a Cloud KMS key ring.

Key ring configurations can be exported in Kubernetes Resource Model (krm) orTerraform HCL formats. The default format iskrm.

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

Specifying--path allows you to export the configuration(s) to alocal directory.

EXAMPLES
To export the configuration for a key ring, run:
gcloudalphakmskeyringsconfigexportmy-key-ring

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

gcloudalphakmskeyringsconfigexportmy-key-ring--path=/path/to/dir/

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

gcloudalphakmskeyringsconfigexportmy-key-ring--resource-format=terraform

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

gcloudalphakmskeyringsconfigexport--all
POSITIONAL ARGUMENTS
Exactly one of these must be specified:
Keyring resource - Key ring to export the configuration for. The arguments inthis group can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentkeyring on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.
KEYRING
ID of the keyring or fully qualified identifier for the keyring.

To set thekeyring attribute:

  • provide the argumentkeyring on the command line.
  • This positional argument must be specified if any of the other arguments in thisgroup are specified.

    --location=LOCATION
    The location of the resource.

    To set thelocation attribute:

  • provide the argumentkeyring on the command line with a fullyspecified name;
  • provide the argument--location on the command line.
  • --all
    Retrieve all resources within the project. If--path is specifiedand is a valid directory, resources will be output as individual files based onresource name and scope. If--path is not specified, resources willbe streamed to stdout.
    FLAGS
    --path=PATH; default="-"
    Path of the directory or file to output configuration(s). To outputconfigurations to stdout, specify "--path=-".
    --resource-format=RESOURCE_FORMAT
    Format of the configuration to export. Available configuration formats areKubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Commanddefaults 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 thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist.

    Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

    Last updated 2026-01-21 UTC.