NAME

gcloud alpha database-migration migration-jobs update - update a Database Migration Service migration job

SYNOPSIS

gcloud alpha database-migration migration-jobs update (MIGRATION_JOB : --region=REGION) --destination=DESTINATION --source=SOURCE [--no-async] [--display-name=DISPLAY_NAME] [--dump-path=DUMP_PATH] [--type=TYPE] [--update-labels=[KEY=VALUE,...]] [--clear-labels | --remove-labels=[KEY,...]] [--peer-vpc=PEER_VPC | --static-ip | --vm=VM --vm-ip=VM_IP --vm-port=VM_PORT --vpc=VPC] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) Update a Database Migration Service migration job.

• Draft migration job: user can update all available flags.

• Any other state can only update flags: --display-name, --dump-path, and connectivity method flags.

EXAMPLES

To update the source and destination connection profiles of a draft migration job:

$ gcloud alpha database-migration migration-jobs update \ my-migration-job --region=us-central1 --source=new-src \ --destination=new-dest

To update the display name of a running migration job:

$ gcloud alpha database-migration migration-jobs update \ my-migration-job --region=us-central1 --display-name=new-name

POSITIONAL ARGUMENTS

Migration job resource - The migration job 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 migration_job 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.

MIGRATION_JOB

ID of the migration_job or fully qualified identifier for the migration_job. To set the migration_job attribute:

• provide the argument migration_job 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 migration_job. To set the region attribute:

• provide the argument migration_job on the command line with a fully specified name;

• provide the argument --region on the command line.

FLAGS

Connection profile resource - ID of the destination connection profile,

representing the destination database. 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 project attribute:

—

provide the argument --destination on the command line with a fully specified name;

—

provide the argument --project on the command line;

—

set the property core/project. To set the region attribute:

—

provide the argument --destination on the command line with a fully specified name;

—

provide the argument --region on the command line.

--destination=DESTINATION

ID of the connection_profile or fully qualified identifier for the connection_profile. To set the connection_profile attribute:

• provide the argument --destination on the command line.

Connection profile resource - ID of the source connection profile, representing

the source database. 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 project attribute:

—

provide the argument --source on the command line with a fully specified name;

—

provide the argument --project on the command line;

—

set the property core/project. To set the region attribute:

—

provide the argument --source on the command line with a fully specified name;

—

provide the argument --region on the command line.

--source=SOURCE

ID of the connection_profile or fully qualified identifier for the connection_profile. To set the connection_profile attribute:

• provide the argument --source on the command line.

--no-async

Waits for the operation in progress to complete before returning.

--display-name=DISPLAY_NAME

A user-friendly name for the migration job. The display name can include letters, numbers, spaces, and hyphens, and must start with a letter.

--dump-path=DUMP_PATH

Path to the dump file in Google Cloud Storage, in the format: gs://[BUCKET_NAME]/[OBJECT_NAME].

--type=TYPE

Type of the migration job. TYPE must be one of: ONE_TIME, CONTINUOUS.

--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:

--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 migration-jobs update \ --clear-labels

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

$ gcloud alpha database-migration migration-jobs 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.

The connectivity method used by the migration job. If a connectivity method

isn't specified, then it isn't updated for the migration job.

At most one of these can be specified:

--peer-vpc=PEER_VPC

Name of the VPC network to peer with the Cloud SQL private network.

--static-ip

Use the default IP allowlist method. This method creates a public IP that will be used with the destination Cloud SQL database. The method works by configuring the source database server to accept connections from the outgoing IP of the Cloud SQL instance.

Parameters for the reverse-SSH tunnel connectivity method.

--vm=VM

Name of VM that will host the SSH tunnel bastion.

--vm-ip=VM_IP

Bastion Virtual Machine IP.

--vm-port=VM_PORT

Forwarding port for the SSH tunnel.

--vpc=VPC

Name of the VPC network where the VM is hosted.

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 command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. This variant is also available:

$ gcloud database-migration migration-jobs update