- NAME
-
- gcloud alpha pubsub topics config export - export the configuration for a Pub/Sub topic
- SYNOPSIS
-
-
gcloud alpha pubsub topics config export([TOPIC]]--all) [--path=PATH; default="-"] [--resource-format=RESOURCE_FORMAT] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)gcloud alpha pubsub topics config exportexports the configuration for a Pub/Sub topic.Topic configurations can be exported in Kubernetes Resource Model (krm) or Terraform HCL formats. The default format is
krm.Specifying
--allallows you to export the configurations for all topics within the project.Specifying
--pathallows you to export the configuration(s) to a local directory. - EXAMPLES
-
To export the configuration for a topic, run:
gcloud alpha pubsub topics config export my-topicTo export the configuration for a topic to a file, run:
gcloud alpha pubsub topics config export my-topic --path=/path/to/dir/To export the configuration for a topic in Terraform HCL format, run:
gcloud alpha pubsub topics config export my-topic --resource-format=terraformTo export the configurations for all topics within a project, run:
gcloud alpha pubsub topics config export --all - POSITIONAL ARGUMENTS
-
-
Exactly one of these must be specified:
TOPIC-
ID of the topic or fully qualified identifier for the topic.
To set the
topicattribute:-
provide the argument
topicon the command line.
-
provide the argument
--all-
Retrieve all resources within the project. If
--pathis specified and is a valid directory, resources will be output as individual files based on resource name and scope. If--pathis not specified, resources will be streamed to stdout.
-
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_FORMATmust 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 helpfor 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.
gcloud alpha pubsub topics config export
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 2025-05-07 UTC.