mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-08 18:45:13 +00:00
135 lines
5.2 KiB
Text
135 lines
5.2 KiB
Text
NAME
|
|
gcloud database-migration connection-profiles update - update a Database
|
|
Migration Service connection profile
|
|
|
|
SYNOPSIS
|
|
gcloud database-migration connection-profiles update
|
|
(CONNECTION_PROFILE : --region=REGION)
|
|
[--ca-certificate=CA_CERTIFICATE]
|
|
[--client-certificate=CLIENT_CERTIFICATE]
|
|
[--cloudsql-instance=CLOUDSQL_INSTANCE] [--display-name=DISPLAY_NAME]
|
|
[--host=HOST] [--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
|
|
Update a Database Migration Service connection profile.
|
|
|
|
EXAMPLES
|
|
To update the display name of a connection profile:
|
|
|
|
$ gcloud database-migration connection-profiles update \
|
|
CONNECTION_PROFILE --region=us-central1 --display-name=new-name
|
|
|
|
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 project attribute:
|
|
◆ provide the argument connection_profile on the command line with a
|
|
fully specified name;
|
|
◆ provide the argument --project on 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_profile attribute:
|
|
▸ provide the argument connection_profile on the command line.
|
|
|
|
This positional must be specified if any of the other arguments in
|
|
this group are specified.
|
|
|
|
--region=REGION
|
|
The Cloud region for the connection_profile. To set the region
|
|
attribute:
|
|
▸ provide the argument connection_profile on the command line with
|
|
a fully specified name;
|
|
▸ provide the argument --region on the command line.
|
|
|
|
FLAGS
|
|
--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.
|
|
|
|
--cloudsql-instance=CLOUDSQL_INSTANCE
|
|
If the source is a Cloud SQL database, use this field to provide the
|
|
Cloud SQL instance ID of the source.
|
|
|
|
--display-name=DISPLAY_NAME
|
|
Friendly name for the connection profile.
|
|
|
|
--host=HOST
|
|
IP or hostname of the source database.
|
|
|
|
--port=PORT
|
|
Network port of the source database.
|
|
|
|
--private-key=PRIVATE_KEY
|
|
Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with
|
|
the Client Certificate.
|
|
|
|
--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.
|
|
|
|
--username=USERNAME
|
|
Username that Database Migration Service will use to connect to the
|
|
database. The value is encrypted when stored in Database Migration
|
|
Service.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-labels
|
|
Remove all labels. If --update-labels is also specified then
|
|
--clear-labels is applied first.
|
|
|
|
For example, to remove all labels:
|
|
|
|
$ gcloud database-migration connection-profiles update --clear-labels
|
|
|
|
To remove all existing labels and create two new labels, foo and baz:
|
|
|
|
$ gcloud database-migration 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-labels is also specified then
|
|
--update-labels is applied first.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--password=PASSWORD
|
|
Password for the user that Database Migration Service will be using
|
|
to connect to the database. This field is not returned on request,
|
|
and the value is encrypted when stored in Database Migration Service.
|
|
|
|
--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 help for details.
|
|
|
|
NOTES
|
|
This variant is also available:
|
|
|
|
$ gcloud alpha database-migration connection-profiles update
|
|
|