- NAME
-
- gcloud alpha design-center spaces application-templates components connections update - update a connection
- SYNOPSIS
-
-
gcloud alpha design-center spaces application-templates components connections update(CONNECTION:--component=COMPONENT) [--application-template=APPLICATION_TEMPLATE] [--destination-component-uri=DESTINATION_COMPONENT_URI] [--location=LOCATION] [--space=SPACE] [--destination-component-parameters=[key=KEY],[value=VALUE] |--add-destination-component-parameters=[key=KEY],[value=VALUE]--clear-destination-component-parameters|--remove-destination-component-parameters=[key=KEY],[value=VALUE]] [--source-component-parameters=[key=KEY],[value=VALUE] |--add-source-component-parameters=[key=KEY],[value=VALUE]--clear-source-component-parameters|--remove-source-component-parameters=[key=KEY],[value=VALUE]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Update a connection between components in an application template. - EXAMPLES
-
To update the destination component URI to
projects/my-project/locations/us-central1/spaces/my-space/applicationTemplates/my-app-template/components/other-new-componentin the connectionmy-connectionin componentmy-componentof application templatemy-app-template, spacemy-space, projectmy-projectand locationus-central1, run:gcloud alpha design-center spaces application-templates components connections update my-connection --component=my-component --application-template=my-app-template --space=my-space --project=my-project --location=us-central1 --destination-component-uri=other-new-componentOr run:
gcloud alpha design-center spaces application-templates components connections update my-connection --component=my-component --application-template=my-app-template --space=my-space --project=my-project --location=us-central1 --destination-component-uri=projects/my-project/locations/us-central1/spaces/my-space/applicationTemplates/my-app-template/components/other-new-componentOr run:
gcloud alpha design-center spaces application-templates components connections update projects/my-project/locations/us-central1/spaces/my-space/applicationTemplates/my-app-template/components/my-component/connections/my-connection --destination-component-uri=projects/my-project/locations/us-central1/spaces/my-space/applicationTemplates/my-app-template/components/other-new-componentTo add a new parameter key-value pair of
new_parameter_key:new-parameterto the connectionmy-connectionin componentmy-componentof application templatemy-app-template, spacemy-space, projectmy-projectand locationus-central1, run the following shorthand example:gcloud alpha design-center spaces application-templates components connections update my-connection --application-template=my-app-template --component=my-component --space=my-space --project=my-project --location=us-central1 --add-parameters=key=project_id,value=new-project --add-parameters=key=new_parameter_key,value=new-parameterOr run the following JSON example:
gcloud alpha design-center spaces application-templates components connections update my-connection --application-template=my-app-template --component=my-component --space=my-space --project=my-project --location=us-central1 --add-parameters='[{"key": "project_id", "value":"new-project"}, {"key": "new_parameter_key", "value": "new-parameter"}]'Or create a YAML or JSON file with the parameters and run the following file example:
gcloud alpha design-center spaces application-templates components connections update my-connection --application-template=my-app-template --component=my-component --space=my-space --project=my-project --location=us-central1 --add-parameters=my-parameters.yamlTo clear all parameters from the connection
my-connectionin componentmy-componentof application templatemy-app-template, spacemy-space, projectmy-projectand locationus-central1, run:gcloud alpha design-center spaces application-templates components connections update my-connection --component=my-component --application-template=my-app-template --space=my-space --project=my-project --location=us-central1 --clear-parametersTo remove an existing parameter key-value pair of
type:connection-typefrom the connectionmy-connectionin componentmy-componentof application templatemy-app-template, spacemy-space, projectmy-projectand locationus-central1, run:gcloud alpha design-center spaces application-templates components connections update my-connection --component=my-component --application-template=my-app-template --space=my-space --project=my-project --location=us-central1 --remove-parameters=key=type,value=connection-type - POSITIONAL ARGUMENTS
-
-
Connection resource - Identifier. The connection name. 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
connectionon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
locationattribute:-
provide the argument
connectionon the command line with a fully specified name; -
provide the argument
--locationon the command line.
To set the
spaceattribute:-
provide the argument
connectionon the command line with a fully specified name; -
provide the argument
--spaceon the command line.
To set the
application-templateattribute:-
provide the argument
connectionon the command line with a fully specified name; -
provide the argument
--application-templateon the command line.
This must be specified.
CONNECTION-
ID of the connection or fully qualified identifier for the connection.
To set the
connectionattribute:-
provide the argument
connectionon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--component=COMPONENT-
The component id of the connection resource.
To set the
componentattribute:-
provide the argument
connectionon the command line with a fully specified name; -
provide the argument
--componenton the command line.
-
provide the argument
-
provide the argument
-
Connection resource - Identifier. The connection name. 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.
- FLAGS
-
--application-template=APPLICATION_TEMPLATE- For resources [connection, destination-component-uri], provides fallback value for resource application-template attribute. When the resource's full URI path is not provided, application-template will fallback to this flag value.
-
Component resource - The destination component URI used to generate the
connection. Format is
projects/$project/locations/$location/spaces/$space/applicationTemplates/$application_template/components/$componentThis represents a Cloud 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
--destination-component-urion the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
locationattribute:-
provide the argument
--destination-component-urion the command line with a fully specified name; -
provide the argument
--locationon the command line.
To set the
spaceattribute:-
provide the argument
--destination-component-urion the command line with a fully specified name; -
provide the argument
--spaceon the command line.
To set the
application-templateattribute:-
provide the argument
--destination-component-urion the command line with a fully specified name; -
provide the argument
--application-templateon the command line.
--destination-component-uri=DESTINATION_COMPONENT_URI-
ID of the component or fully qualified identifier for the component.
To set the
componentattribute:-
provide the argument
--destination-component-urion the command line.
-
provide the argument
-
provide the argument
--location=LOCATION- For resources [connection, destination-component-uri], provides fallback value for resource location attribute. When the resource's full URI path is not provided, location will fallback to this flag value.
--space=SPACE- For resources [connection, destination-component-uri], provides fallback value for resource space attribute. When the resource's full URI path is not provided, space will fallback to this flag value.
-
Update destination_component_parameters.
At most one of these can be specified:
--destination-component-parameters=[key=KEY],[value=VALUE]-
Set destination_component_parameters to new value. The parameters of the
connection associated with the destination component.
key- The key of the parameter.
value- The value of the parameter.
Shorthand Example:--destination-component-parameters=key=string,value={…} --destination-component-parameters=key=string,value={…}
JSON Example:--destination-component-parameters='[{"key": "string", "value": {…}}]'
File Example:--destination-component-parameters=path_to_file.(yaml|json)
--add-destination-component-parameters=[key=KEY],[value=VALUE]-
Add new value to destination_component_parameters list. The parameters of the
connection associated with the destination component.
key- The key of the parameter.
value- The value of the parameter.
Shorthand Example:--add-destination-component-parameters=key=string,value={…} --add-destination-component-parameters=key=string,value={…}
JSON Example:--add-destination-component-parameters='[{"key": "string", "value": {…}}]'
File Example:--add-destination-component-parameters=path_to_file.(yaml|json)
-
At most one of these can be specified:
--clear-destination-component-parameters- Clear destination_component_parameters value and set to empty list.
--remove-destination-component-parameters=[key=KEY],[value=VALUE]-
Remove existing value from destination_component_parameters list. The parameters
of the connection associated with the destination component.
key- The key of the parameter.
value- The value of the parameter.
Shorthand Example:--remove-destination-component-parameters=key=string,value={…} --remove-destination-component-parameters=key=string,value={…}
JSON Example:--remove-destination-component-parameters='[{"key": "string", "value": {…}}]'
File Example:--remove-destination-component-parameters=path_to_file.(yaml|json)
-
Update source_component_parameters.
At most one of these can be specified:
--source-component-parameters=[key=KEY],[value=VALUE]-
Set source_component_parameters to new value. The parameters of the connection
associated with the source component.
key- The key of the parameter.
value- The value of the parameter.
Shorthand Example:--source-component-parameters=key=string,value={…} --source-component-parameters=key=string,value={…}
JSON Example:--source-component-parameters='[{"key": "string", "value": {…}}]'
File Example:--source-component-parameters=path_to_file.(yaml|json)
--add-source-component-parameters=[key=KEY],[value=VALUE]-
Add new value to source_component_parameters list. The parameters of the
connection associated with the source component.
key- The key of the parameter.
value- The value of the parameter.
Shorthand Example:--add-source-component-parameters=key=string,value={…} --add-source-component-parameters=key=string,value={…}
JSON Example:--add-source-component-parameters='[{"key": "string", "value": {…}}]'
File Example:--add-source-component-parameters=path_to_file.(yaml|json)
-
At most one of these can be specified:
--clear-source-component-parameters- Clear source_component_parameters value and set to empty list.
--remove-source-component-parameters=[key=KEY],[value=VALUE]-
Remove existing value from source_component_parameters list. The parameters of
the connection associated with the source component.
key- The key of the parameter.
value- The value of the parameter.
Shorthand Example:--remove-source-component-parameters=key=string,value={…} --remove-source-component-parameters=key=string,value={…}
JSON Example:--remove-source-component-parameters='[{"key": "string", "value": {…}}]'
File Example:--remove-source-component-parameters=path_to_file.(yaml|json)
- 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. - API REFERENCE
-
This command uses the
designcenter/v1alphaAPI. The full documentation for this API can be found at: http://cloud.google.com/application-design-center/docs - 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 design-center spaces application-templates components connections update
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-09-16 UTC.