gcloud alpha database-migration connection-profiles update

gcloud alpha database-migration connection-profiles update - update a Database Migration Service connection profile

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 …]

• Draft connection profile: the user can update all flags available in connection-profiles create command.
• Existing connection profile: the user can update a limited list of flags, see connection-profiles update Synopsis.
• If a migration job is using the connection profile, then updates to fields host, port, username, and password will propagate to the destination instance.

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 argument 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.

--ca-certificate=CA_CERTIFICATE

x509 PEM-encoded certificate of the CA that signed the database server's certificate. The value for this flag needs to be the content of the certificate file, not the path to the file. For example, on a Linux machine you can use command substitution: <code>--ca-certificate=$(</path/to/certificate_file.pem)</code>. Database Migration Service will use this certificate to verify it's connecting to the correct host. Database Migration Service encrypts the value when storing it.

--certificate=CERTIFICATE

x509 PEM-encoded certificate that will be used by the replica to authenticate against the database server. The value for this flag needs to be the content of the certificate file, not the path to the file. For example, on a Linux machine you 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 include letters, numbers, spaces, and hyphens, and must start with a letter.

--host=HOST

IP or hostname of the database. When --psc-service-attachment is also 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.

--instance=INSTANCE

If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance 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 Client Certificate. The value for this flag needs to be the content of the certificate file, not the path to the file. For example, on a Linux machine you can use command 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 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 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-labels is also specified then --clear-labels is applied first.

For example, to remove all labels:

gcloud alpha database-migration connection-profiles update --clear-labels

To remove all existing labels and create two new labels, foo and baz:

gcloud alpha 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 uses to connect to the database. Database Migration Service encrypts the value when storing it, and the field is not returned on request.

--prompt-for-password

Prompt for the password used to connect to the database.

Run $ gcloud help for details.