- NAME
-
- gcloud datastream connection-profiles update - update a Datastream connection profile
- SYNOPSIS
-
-
gcloud datastream connection-profiles update(CONNECTION_PROFILE:--location=LOCATION)--type=TYPE[--display-name=DISPLAY_NAME] [--force] [--update-labels=[KEY=VALUE,…]] [--bucket=BUCKET--root-path=ROOT_PATH|--database-service=DATABASE_SERVICE--oracle-hostname=ORACLE_HOSTNAME--oracle-port=ORACLE_PORT--oracle-username=ORACLE_USERNAME--oracle-password=ORACLE_PASSWORD|--oracle-prompt-for-password|--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|--postgresql-database=POSTGRESQL_DATABASE--postgresql-hostname=POSTGRESQL_HOSTNAME--postgresql-port=POSTGRESQL_PORT--postgresql-username=POSTGRESQL_USERNAME--postgresql-password=POSTGRESQL_PASSWORD|--postgresql-prompt-for-password|--sqlserver-database=SQLSERVER_DATABASE--sqlserver-hostname=SQLSERVER_HOSTNAME--sqlserver-port=SQLSERVER_PORT--sqlserver-username=SQLSERVER_USERNAME--sqlserver-password=SQLSERVER_PASSWORD|--sqlserver-prompt-for-password] [--clear-labels|--remove-labels=[KEY,…]] [--private-connection=PRIVATE_CONNECTION|--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
- Updates a Datastream connection profile
- EXAMPLES
-
To update a connection profile for Oracle:
gcloud datastream connection-profiles update CONNECTION_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:
gcloud datastream connection-profiles update CONNECTION_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 PostgreSQL:
gcloud datastream connection-profiles update CONNECTION_PROFILE --location=us-central1 --type=postgresql --postgresql-password=fakepassword --postgresql-username=fakeuser --display-name=my-profile --postgresql-hostname=35.188.150.50 --postgresql-port=5432 --postgresql-database=db --static-ip-connectivityTo update a connection profile for Google Cloud Storage:
gcloud datastream connection-profiles update CONNECTION_PROFILE --location=us-central1 --type=google-cloud-storage --bucket=fake-bucket --root-path=/root/path --display-name=my-profileTo update a connection profile for Google Cloud Storage:
gcloud datastream connection-profiles update CONNECTION_PROFILE --location=us-central1 --type=bigquery --display-name=my-profile - POSITIONAL ARGUMENTS
-
-
Connection profile resource - The connection profile to update. 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
connection_profileon the command line with a fully 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 the
connection_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 this group 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 a fully 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 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
-
--type=TYPE- Type can be MYSQL, ORACLE, POSTGRESQL, GOOGLE-CLOUD-STORAGE or BIGQUERY
- OPTIONAL FLAGS
-
--display-name=DISPLAY_NAME- Friendly name for the connection profile.
--force- Update the connection profile without validating it.
--update-labels=[KEY=VALUE,…]-
List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.
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. -
At most one of these can be specified:
--bucket=BUCKET- 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.
-
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 in Datastream.
--oracle-prompt-for-password- Prompt for the password used to connect to the 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's certificate. The replica will use this certificate to verify it's connecting to the right host.
--client-certificate=CLIENT_CERTIFICATE- x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.
--client-key=CLIENT_KEY- Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate.
-
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 in Datastream.
--mysql-prompt-for-password- Prompt for the password used to connect to the database.
--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.
-
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 in Datastream.
--postgresql-prompt-for-password- Prompt for the password used to connect to the database.
--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 in Datastream.
--sqlserver-prompt-for-password- Prompt for the password used to connect to the database.
-
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:
gcloud datastream connection-profiles update --clear-labelsTo remove all existing labels and create two new labels,
foobazgcloud datastream connection-profiles update --clear-labels --update-labels foo=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:
-
Private connection resource - Resource ID of the private connection. This
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
--private-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
--private-connectionon the command line with a fully specified name; -
provide the argument
--locationon the command line.
--private-connection=PRIVATE_CONNECTION-
ID of the private_connection or fully qualified identifier for the
private_connection.
To set the
private_connectionattribute:-
provide the argument
--private-connectionon 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..
-
Private connection resource - Resource ID of the private connection. This
represents a Cloud resource. (NOTE) Some attributes are not given arguments in
this group but can be set in other ways.
- 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 variant is also available:
gcloud beta datastream connection-profiles 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 2024-06-11 UTC.