NAME

gcloud alpha bigtable instances config export - export the configuration for a Cloud Bigtable instance

SYNOPSIS

gcloud alpha bigtable instances config export (INSTANCE : --all) [--path=PATH; default="-"] [--resource-format=RESOURCE_FORMAT] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) gcloud alpha bigtable instances config export exports the configuration for a Cloud Bigtable instance.

Instance 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 instances within the project.

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

EXAMPLES

To export the configuration for an instance, run:

$ gcloud alpha bigtable instances config export my-instance

To export the configuration for an instance to a file, run:

$ gcloud alpha bigtable instances config export my-instance \ --path=/path/to/dir/

To export the configuration for an instance in Terraform HCL format, run:

$ gcloud alpha bigtable instances config export my-instance \ --resource-format=terraform

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

$ gcloud alpha bigtable instances config export --all

POSITIONAL ARGUMENTS

Exactly one of these must be specified:
INSTANCE

ID of the instance or fully qualified identifier for the instance. To set the instance attribute:

  • provide the argument instance on the command line.

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

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