- NAME
-
- gcloud beta datastream routes create - create a Datastream private connection route
- SYNOPSIS
-
-
gcloud beta datastream routes create(ROUTE:--location=LOCATION--private-connection=PRIVATE_CONNECTION)--destination-address=DESTINATION_ADDRESS--display-name=DISPLAY_NAME[--destination-port=DESTINATION_PORT] [--endpoint-mode=ENDPOINT_MODE] [--labels=[KEY=VALUE,…]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(BETA)(DEPRECATED)Datastream beta version is deprecated. Please use`gcloud datastream routes createcommand instead.Create a Datastream private connection route
- EXAMPLES
-
To create a route called 'my-route', run:
gcloud beta datastream routes create my-route --location=us-central1 --private-connection=private-connection --display-name=my-display-name --destination-address=addr.path.to.somewhere --destination-port=33665 - POSITIONAL ARGUMENTS
-
-
Route resource - The route to create. 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
projectattribute:-
provide the argument
routeon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
ROUTE-
ID of the route or fully qualified identifier for the route.
To set the
routeattribute:-
provide the argument
routeon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
The Cloud location for the route.
To set the
locationattribute:-
provide the argument
routeon the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
--private-connection=PRIVATE_CONNECTION-
The private connection of the route.
To set the
private-connectionattribute:-
provide the argument
routeon the command line with a fully specified name; -
provide the argument
--private-connectionon the command line.
-
provide the argument
-
provide the argument
-
Route resource - The route to create. 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.
- REQUIRED FLAGS
-
--destination-address=DESTINATION_ADDRESS- Destination address for connection.
--display-name=DISPLAY_NAME- Friendly name for the route.
- OPTIONAL FLAGS
-
--destination-port=DESTINATION_PORT- Destination port for connection.
--endpoint-mode=ENDPOINT_MODE-
Specifies endpoint mode for a given command. Regional endpoints provide enhanced
data residency and reliability by ensuring your request is handled entirely
within the specified Google Cloud region. This differs from global endpoints,
which may process parts of the request outside the target region. Overrides the
default
regional/endpoint_modeproperty value for this command invocation.ENDPOINT_MODEmust be one of:global- (Default) Use global rather than regional endpoints.
regional- Only use regional endpoints. An error will be raised if a regional endpoint is not available for a given command.
regional-preferred- Use regional endpoints when available, otherwise use global endpoints. Recommended for most users.
--labels=[KEY=VALUE,…]-
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens (
-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
- 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. - REGIONAL ENDPOINTS
-
This command supports regional endpoints. To use regional endpoints for this
command, use the
--endpoint-mode=regional-preferredflag. To use regional endpoints by default, run$ gcloud config set regional/endpoint_mode regional-preferred. - NOTES
-
This command is currently in beta and might change without notice. This variant
is also available:
gcloud datastream routes create
gcloud beta datastream routes create
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 2026-06-23 UTC.