- NAME
-
- gcloud alpha redis instances config export - export the configuration for a Redis instance
- SYNOPSIS
-
-
gcloud alpha redis instances config export
([INSTANCE
:--region
=REGION
]--all
) [--path
=PATH
; default="-"] [--resource-format
=RESOURCE_FORMAT
] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
gcloud alpha redis instances config export
exports the configuration for a Redis 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 redis instances config export my-instance
To export the configuration for an instance to a file, run:
gcloud alpha redis instances config export my-instance --path=/path/to/dir/
To export the configuration for an instance in Terraform HCL format, run:
gcloud alpha redis instances config export my-instance --resource-format=terraform
To export the configurations for all instances within a project, run:
gcloud alpha redis instances config export --all
- POSITIONAL ARGUMENTS
-
-
Exactly one of these must be specified:
-
Instance resource - Instance 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
instance
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
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.
-
provide the argument
--region
=REGION
-
The name of the Redis region of the instance. Overrides the default redis/region
property value for this command invocation.
To set the
region
attribute:-
provide the argument
instance
on the command line with a fully specified name; -
provide the argument
--region
on the command line; -
set the property
redis/region
.
-
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.
-
Instance resource - Instance 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.