gcloud alpha database-migration connection-profiles update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha database-migration connection-profiles update - update a Database Migration Service connection profile
- SYNOPSIS
gcloud alpha database-migration connection-profiles update(CONNECTION_PROFILE:--region=REGION)[--ca-certificate=CA_CERTIFICATE][--certificate=CERTIFICATE][--display-name=DISPLAY_NAME][--host=HOST][--instance=INSTANCE][--port=PORT][--private-key=PRIVATE_KEY][--update-labels=[KEY=VALUE,…]][--username=USERNAME][--clear-labels|--remove-labels=[KEY,…]][--password=PASSWORD|--prompt-for-password][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Update a Database Migration Service connection profile.- Draft connection profile: the user can update all flags available in
connection-profiles createcommand. - Existing connection profile: the user can update a limited list of flags, see
connection-profiles updateSynopsis. - If a migration job is using the connection profile, then updates to fields
host,port,username, andpasswordwill propagate to the destination instance.
- Draft connection profile: the user can update all flags available in
- EXAMPLES
- To update the username of a connection profile:
gcloudalphadatabase-migrationconnection-profilesupdatemy-profile--region=us-central1--username=new-user - POSITIONAL ARGUMENTS
- Connection profile resource - The connection profile to update. The arguments inthis group can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
connection_profileon the command line with afully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
CONNECTION_PROFILE- ID of the connection_profile or fully qualified identifier for theconnection_profile.
To set the
connection_profileattribute:- provide the argument
connection_profileon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--region=REGION- The Cloud region for the connection_profile.
To set the
regionattribute:- provide the argument
connection_profileon the command line with afully specified name; - provide the argument
--regionon the command line.
- provide the argument
- provide the argument
- Connection profile resource - The connection profile to update. The arguments inthis group can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
- FLAGS
--ca-certificate=CA_CERTIFICATE- x509 PEM-encoded certificate of the CA that signed the database server'scertificate. The value for this flag needs to be the content of the certificatefile, not the path to the file. For example, on a Linux machine you can usecommand substitution:<code>--ca-certificate=$(</path/to/certificate_file.pem)</code>.Database Migration Service will use this certificate to verify it's connectingto the correct host. Database Migration Service encrypts the value when storingit.
--certificate=CERTIFICATE- x509 PEM-encoded certificate that will be used by the replica to authenticateagainst the database server. The value for this flag needs to be the content ofthe certificate file, not the path to the file. For example, on a Linux machineyou can use command substitution:<code>--ca-certificate=$(</path/to/certificate_file.pem)</code>.
--display-name=DISPLAY_NAME- A user-friendly name for the connection profile. The display name can includeletters, numbers, spaces, and hyphens, and must start with a letter.
--host=HOST- IP or hostname of the database. When
--psc-service-attachmentisalso specified, this field value should be:1. For Cloud SQL PSC enabled instance - the dns_name field (e.g<uid>.<region>.sql.goog.).
2. For Cloud SQL PSA instance (vpc peering) - the private ip of the instance.
3. For AlloyDB PSC enabled cluster - the dns_name field of the primary instance(e.g <uid>.<region>.alloydb-psc.goog.).
4. For AlloyDB PSA cluster - the private ip of the primary instance.
--instance=INSTANCE- If the source is a Cloud SQL database, use this field to provide the Cloud SQLinstance ID of the source.
--port=PORT- Network port of the database.
--private-key=PRIVATE_KEY- Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the ClientCertificate. The value for this flag needs to be the content of the certificatefile, not the path to the file. For example, on a Linux machine you can usecommand substitution:<code>--ca-certificate=$(</path/to/certificate_file.pem)</code>.Database Migration Service encrypts the value when storing it.
--update-labels=[KEY=VALUE,…]- List of label KEY=VALUE pairs to update. If a label exists, its value ismodified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens(
-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers. --username=USERNAME- Username that Database Migration Service uses to connect to the database.Database Migration Service encrypts the value when storing it.
- At most one of these can be specified:
--clear-labels- Remove all labels. If
--update-labelsis also specified then--clear-labelsis applied first.For example, to remove all labels:
gcloudalphadatabase-migrationconnection-profilesupdate--clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloudalphadatabase-migrationconnection-profilesupdate--clear-labels--update-labelsfoo=bar,baz=qux --remove-labels=[KEY,…]- List of label keys to remove. If a label does not exist it is silently ignored.If
--update-labelsis also specified then--update-labelsis applied first.
- At most one of these can be specified:
--password=PASSWORD- Password for the user that Database Migration Service uses to connect to thedatabase. Database Migration Service encrypts the value when storing it, and thefield is not returned on request.
--prompt-for-password- Prompt for the password used to connect to the database.
- 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 thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gclouddatabase-migrationconnection-profilesupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-16 UTC.