gcloud beta datastream connection-profiles update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta datastream connection-profiles update - update a Datastream connection profile
- SYNOPSIS
gcloud beta datastream connection-profiles update(CONNECTION_PROFILE:--location=LOCATION)--type=TYPE[--display-name=DISPLAY_NAME][--update-labels=[KEY=VALUE,…]][--bucket-name=BUCKET_NAME--root-path=ROOT_PATH|--database-service=DATABASE_SERVICE--oracle-hostname=ORACLE_HOSTNAME--oracle-port=ORACLE_PORT--oracle-username=ORACLE_USERNAME--oracle-ca-certificate=ORACLE_CA_CERTIFICATE--oracle-server-certificate-distinguished-name=ORACLE_SERVER_CERTIFICATE_DISTINGUISHED_NAME--oracle-password=ORACLE_PASSWORD|--oracle-prompt-for-password|--oracle-secret-manager-stored-password=ORACLE_SECRET_MANAGER_STORED_PASSWORD|--mongodb-direct-connection--mongodb-host-addresses=IPv4_ADDRESS_OR_HOSTNAME:PORT,[…]--mongodb-replica-set=MONGODB_REPLICA_SET--mongodb-username=MONGODB_USERNAME--mongodb-ca-certificate=MONGODB_CA_CERTIFICATE--mongodb-tls--mongodb-password=MONGODB_PASSWORD|--mongodb-prompt-for-password|--mongodb-secret-manager-stored-password=MONGODB_SECRET_MANAGER_STORED_PASSWORD--mongodb-srv-connection-format|--mongodb-standard-connection-format|--mysql-hostname=MYSQL_HOSTNAME--mysql-port=MYSQL_PORT--mysql-username=MYSQL_USERNAME--ca-certificate=CA_CERTIFICATE--client-certificate=CLIENT_CERTIFICATE--client-key=CLIENT_KEY--mysql-password=MYSQL_PASSWORD|--mysql-prompt-for-password|--mysql-secret-manager-stored-password=MYSQL_SECRET_MANAGER_STORED_PASSWORD|--postgresql-database=POSTGRESQL_DATABASE--postgresql-hostname=POSTGRESQL_HOSTNAME--postgresql-port=POSTGRESQL_PORT--postgresql-username=POSTGRESQL_USERNAME--postgresql-ca-certificate=POSTGRESQL_CA_CERTIFICATE--postgresql-server-certificate-hostname=POSTGRESQL_SERVER_CERTIFICATE_HOSTNAME--postgresql-client-certificate=POSTGRESQL_CLIENT_CERTIFICATE--postgresql-client-key=POSTGRESQL_CLIENT_KEY--postgresql-password=POSTGRESQL_PASSWORD|--postgresql-prompt-for-password|--postgresql-secret-manager-stored-password=POSTGRESQL_SECRET_MANAGER_STORED_PASSWORD|--salesforce-domain=SALESFORCE_DOMAIN--salesforce-oauth2-client-id=SALESFORCE_OAUTH2_CLIENT_ID--salesforce-oauth2-client-secret=SALESFORCE_OAUTH2_CLIENT_SECRET|--salesforce-prompt-for-oauth2-client-secret|--salesforce-secret-manager-stored-oauth2-client-secret=SALESFORCE_SECRET_MANAGER_STORED_OAUTH2_CLIENT_SECRET|--salesforce-username=SALESFORCE_USERNAME--salesforce-password=SALESFORCE_PASSWORD|--salesforce-prompt-for-password|--salesforce-secret-manager-stored-password=SALESFORCE_SECRET_MANAGER_STORED_PASSWORD--salesforce-prompt-for-security-token|--salesforce-secret-manager-stored-security-token=SALESFORCE_SECRET_MANAGER_STORED_SECURITY_TOKEN|--salesforce-security-token=SALESFORCE_SECURITY_TOKEN|--sqlserver-database=SQLSERVER_DATABASE--sqlserver-hostname=SQLSERVER_HOSTNAME--sqlserver-port=SQLSERVER_PORT--sqlserver-username=SQLSERVER_USERNAME--sqlserver-password=SQLSERVER_PASSWORD|--sqlserver-prompt-for-password|--sqlserver-secret-manager-stored-password=SQLSERVER_SECRET_MANAGER_STORED_PASSWORD][--clear-labels|--remove-labels=[KEY,…]][--no-connectivity|--private-connection-name=PRIVATE_CONNECTION_NAME|--static-ip-connectivity|--forward-ssh-hostname=FORWARD_SSH_HOSTNAME--forward-ssh-port=FORWARD_SSH_PORT; default=22--forward-ssh-username=FORWARD_SSH_USERNAME--forward-ssh-password=FORWARD_SSH_PASSWORD|--forward-ssh-private-key=FORWARD_SSH_PRIVATE_KEY][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(BETA)(DEPRECATED)Datastream beta version isdeprecated. Please use`gclouddatastream connection-profiles updatecommand instead.Updates a Datastream connection profile
- EXAMPLES
- To update a connection profile for Oracle:
gcloudbetadatastreamconnection-profilesupdateCONNECTION_PROFILE--location=us-central1--type=oracle--oracle-password=fakepassword--oracle-username=fakeuser--display-name=my-profile--oracle-hostname=35.188.150.50--oracle-port=1521--database-service=ORCL--static-ip-connectivityTo update a connection profile for MySQL:
gcloudbetadatastreamconnection-profilesupdateCONNECTION_PROFILE--location=us-central1--type=mysql--mysql-password=fakepassword--mysql-username=fakeuser--display-name=my-profile--mysql-hostname=35.188.150.50--mysql-port=3306--static-ip-connectivityTo update a connection profile for Google Cloud Storage:
gcloudbetadatastreamconnection-profilesupdateCONNECTION_PROFILE--location=us-central1--type=google-cloud-storage--bucket-name=fake-bucket--root-path=/root/path--display-name=my-profile--no-connectivity - 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
--location=LOCATION- The Cloud location for the connection_profile.
To set the
locationattribute:- provide the argument
connection_profileon the command line with afully specified name; - provide the argument
--locationon 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.
- REQUIRED FLAGS
--type=TYPE- Type can be MYSQL, ORACLE, POSTGRESQL, SQLSERVER, SALESFORCE,GOOGLE-CLOUD-STORAGE or BIGQUERY
- OPTIONAL FLAGS
--display-name=DISPLAY_NAME- Friendly name for the connection profile.
--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. - At most one of these can be specified:
--bucket-name=BUCKET_NAME- The full project and resource path for Cloud Storage bucket including the name.
--root-path=ROOT_PATH- The root path inside the Cloud Storage bucket.
--database-service=DATABASE_SERVICE- Database service for the Oracle connection.
--oracle-hostname=ORACLE_HOSTNAME- IP or hostname of the oracle source database.
--oracle-port=ORACLE_PORT- Network port of the oracle source database.
--oracle-username=ORACLE_USERNAME- Username Datastream will use to connect to the database.
--oracle-ca-certificate=ORACLE_CA_CERTIFICATE- PEM-encoded certificate of the CA that signed the source database server'scertificate.
--oracle-server-certificate-distinguished-name=ORACLE_SERVER_CERTIFICATE_DISTINGUISHED_NAME- The distinguished name (DN) mentioned in the server certificate. Thiscorresponds to the SSL_SERVER_CERT_DN sqlnet parameter. If this field is notprovided, the DN matching is not enforced.
- At most one of these can be specified:
--oracle-password=ORACLE_PASSWORD- Password for the user that Datastream will be using to connect to the database.This field is not returned on request, and the value is encrypted when stored inDatastream.
--oracle-prompt-for-password- Prompt for the password used to connect to the database.
--oracle-secret-manager-stored-password=ORACLE_SECRET_MANAGER_STORED_PASSWORD- Path to secret manager, storing the password for the user used to connect to thedatabase.
--mongodb-direct-connection- Connect to the mongodb hosts directly and do not try to resolve any of thereplicas from the replica set.
--mongodb-host-addresses=IPv4_ADDRESS_OR_HOSTNAME:PORT,[…]- IP or hostname and port of the MongoDB source database.
--mongodb-replica-set=MONGODB_REPLICA_SET- Replica set of the MongoDB source database.
--mongodb-username=MONGODB_USERNAME- Username Datastream will use to connect to the database.
--mongodb-ca-certificate=MONGODB_CA_CERTIFICATE- x509 PEM-encoded certificate of the CA that signed the source database server'scertificate. The replica will use this certificate to verify it's connecting tothe right host.
--mongodb-tls- Enable Transport Layer Security for the monogodb connection.
- At most one of these can be specified:
--mongodb-password=MONGODB_PASSWORD- Password for the user that Datastream will be using to connect to the database.This field is not returned on request, and the value is encrypted when stored inDatastream.
--mongodb-prompt-for-password- Prompt for the password used to connect to the database.
--mongodb-secret-manager-stored-password=MONGODB_SECRET_MANAGER_STORED_PASSWORD- Path to secret manager, storing the password for the user used to connect to thedatabase.
- At most one of these can be specified:
--mongodb-srv-connection-format- SRV Connection format for the MongoDB source database.
--mongodb-standard-connection-format- Standard connection format for the MongoDB source database.
--mysql-hostname=MYSQL_HOSTNAME- IP or hostname of the MySQL source database.
--mysql-port=MYSQL_PORT- Network port of the MySQL source database.
--mysql-username=MYSQL_USERNAME- Username Datastream will use to connect to the database.
--ca-certificate=CA_CERTIFICATE- x509 PEM-encoded certificate of the CA that signed the source database server'scertificate. The replica will use this certificate to verify it's connecting tothe right host.
--client-certificate=CLIENT_CERTIFICATE- x509 PEM-encoded certificate that will be used by the replica to authenticateagainst the source database server.
--client-key=CLIENT_KEY- Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the ClientCertificate.
- At most one of these can be specified:
--mysql-password=MYSQL_PASSWORD- Password for the user that Datastream will be using to connect to the database.This field is not returned on request, and the value is encrypted when stored inDatastream.
--mysql-prompt-for-password- Prompt for the password used to connect to the database.
--mysql-secret-manager-stored-password=MYSQL_SECRET_MANAGER_STORED_PASSWORD- Path to secret manager, storing the password for the user used to connect to thedatabase.
--postgresql-database=POSTGRESQL_DATABASE- Database service for the PostgreSQL connection.
--postgresql-hostname=POSTGRESQL_HOSTNAME- IP or hostname of the PostgreSQL source database.
--postgresql-port=POSTGRESQL_PORT- Network port of the PostgreSQL source database.
--postgresql-username=POSTGRESQL_USERNAME- Username Datastream will use to connect to the database.
--postgresql-ca-certificate=POSTGRESQL_CA_CERTIFICATE- x509 PEM-encoded certificate of the CA that signed the source database server'scertificate. The replica will use this certificate to verify it's connecting tothe right host.
--postgresql-server-certificate-hostname=POSTGRESQL_SERVER_CERTIFICATE_HOSTNAME- The hostname mentioned in the Subject or SAN extension of the servercertificate. If this field is not provided, the hostname in the servercertificate is not validated.
--postgresql-client-certificate=POSTGRESQL_CLIENT_CERTIFICATE- x509 PEM-encoded certificate that will be used by the replica to authenticateagainst the source database server.
--postgresql-client-key=POSTGRESQL_CLIENT_KEY- Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the ClientCertificate.
- At most one of these can be specified:
--postgresql-password=POSTGRESQL_PASSWORD- Password for the user that Datastream will be using to connect to the database.This field is not returned on request, and the value is encrypted when stored inDatastream.
--postgresql-prompt-for-password- Prompt for the password used to connect to the database.
--postgresql-secret-manager-stored-password=POSTGRESQL_SECRET_MANAGER_STORED_PASSWORD- Path to secret manager, storing the password for the user used to connect to thedatabase.
--salesforce-domain=SALESFORCE_DOMAIN- Domain of the Salesforce organization. For example, 'myorg.my.salesforce.com'
- At most one of these can be specified:
--salesforce-oauth2-client-id=SALESFORCE_OAUTH2_CLIENT_ID- OAuth 2.0 Client ID used to connect to Salesforce.
- At most one of these can be specified:
--salesforce-oauth2-client-secret=SALESFORCE_OAUTH2_CLIENT_SECRET- OAuth 2.0 Client secret used to connect to Salesforce.
--salesforce-prompt-for-oauth2-client-secret- Prompt for the OAuth 2.0 Client secret used to connect to Salesforce.
--salesforce-secret-manager-stored-oauth2-client-secret=SALESFORCE_SECRET_MANAGER_STORED_OAUTH2_CLIENT_SECRET- Path to secret manager, storing the OAuth 2.0 Client secret used to connect toSalesforce.
--salesforce-username=SALESFORCE_USERNAME- Username Datastream will use to connect to the database.
- At most one of these can be specified:
--salesforce-password=SALESFORCE_PASSWORD- Password for the user that Datastream will be using to connect to Salesforce.This field is not returned on request, and the value is encrypted when stored inDatastream.
--salesforce-prompt-for-password- Prompt for the password used to connect to Salesforce.
--salesforce-secret-manager-stored-password=SALESFORCE_SECRET_MANAGER_STORED_PASSWORD- Path to secret manager, storing the password for the user used to connect toSalesforce.
- At most one of these can be specified:
--salesforce-prompt-for-security-token- Prompt for the security token used to connect to Salesforce.
--salesforce-secret-manager-stored-security-token=SALESFORCE_SECRET_MANAGER_STORED_SECURITY_TOKEN- Path to secret manager, storing the security token used to connect toSalesforce.
--salesforce-security-token=SALESFORCE_SECURITY_TOKEN- Security token for the user that Datastream will be using to connect toSalesforce.
--sqlserver-database=SQLSERVER_DATABASE- Database service for the SQL Server connection.
--sqlserver-hostname=SQLSERVER_HOSTNAME- IP or hostname of the SQL Server source database.
--sqlserver-port=SQLSERVER_PORT- Network port of the SQL Server source database.
--sqlserver-username=SQLSERVER_USERNAME- Username Datastream will use to connect to the database.
- At most one of these can be specified:
--sqlserver-password=SQLSERVER_PASSWORD- Password for the user that Datastream will be using to connect to the database.This field is not returned on request, and the value is encrypted when stored inDatastream.
--sqlserver-prompt-for-password- Prompt for the password used to connect to the database.
--sqlserver-secret-manager-stored-password=SQLSERVER_SECRET_MANAGER_STORED_PASSWORD- Path to secret manager, storing the password for the user used to connect to thedatabase.
- 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:
gcloudbetadatastreamconnection-profilesupdate--clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloudbetadatastreamconnection-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:
--no-connectivity- no connectivity
- Private connection resource - Resource ID of the private connection. Thisrepresents a Cloud resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.
To set the
projectattribute:- provide the argument
--private-connection-nameon the command linewith a fully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
To set the
locationattribute:- provide the argument
--private-connection-nameon the command linewith a fully specified name; - provide the argument
--locationon the command line.
--private-connection-name=PRIVATE_CONNECTION_NAME- ID of the private_connection or fully qualified identifier for theprivate_connection.
To set the
private_connectionattribute:- provide the argument
--private-connection-nameon the command line.
- provide the argument
- provide the argument
--static-ip-connectivity- use static ip connectivity
--forward-ssh-hostname=FORWARD_SSH_HOSTNAME- Hostname for the SSH tunnel.
--forward-ssh-port=FORWARD_SSH_PORT; default=22- Port for the SSH tunnel, default value is 22.
--forward-ssh-username=FORWARD_SSH_USERNAME- Username for the SSH tunnel.
- At most one of these can be specified:
--forward-ssh-password=FORWARD_SSH_PASSWORD- SSH password.
--forward-ssh-private-key=FORWARD_SSH_PRIVATE_KEY- SSH private key..
- 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 beta and might change without notice. This variantis also available:
gclouddatastreamconnection-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-08-19 UTC.