Manage connection profiles

This page describes how to perform view, update, and delete operations for connection profiles.

View a connection profile

You can view the following information about your connection profiles:

  • All configuration details provided during profile creation. For more information, see Connection profiles overview.

  • Connection profile creation and last modification time.

  • A list of migration jobs that use this connection profile.

To view connection profile details, perform the following steps:

Console

  1. In the Google Cloud console, go to the Connection profiles page.

    Go to Connection profiles

  2. Click the display name of the connection profile that you want to view.

    A connection profile overview page appears.

gcloud

Before using any of the command data below, make the following replacements:

  • REGION with the identifier of the region where your connection profile is saved.
  • CONNECTION_PROFILE_ID with your connection profile identifier.

    If you don't know the identifier, you can use the gcloud database-migration connection-profiles list command to list all profiles in a given region and view their identifiers.

For more information on these values, see Connection profiles overview.

Execute the following command:

Linux, macOS, or Cloud Shell

gcloud database-migration connection-profiles \
describe CONNECTION_PROFILE_ID \
  --region=REGION

Windows (PowerShell)

gcloud database-migration connection-profiles `
describe CONNECTION_PROFILE_ID `
  --region=REGION

Windows (cmd.exe)

gcloud database-migration connection-profiles ^
describe CONNECTION_PROFILE_ID ^
  --region=REGION

Update a connection profile

To update a connection profile, perform the following steps:

  1. In the Google Cloud console, go to the Connection profiles page.

    Go to Connection profiles

  2. Click the display name of the connection profile that you want to modify.

    An overview page appears for the connection profile.

  3. Click Edit and update your connection profile.
  4. Click Save.

Delete a connection profile

You can delete a connection profile only if there are no migration jobs that use that profile. If you want to delete a connection profile that is in use by a migration job, first delete all migration jobs that are linked to the connection profile.

To delete a connection profile, perform the following steps:

Console

  1. In the Google Cloud console, go to the Connection profiles page.

    Go to Connection profiles

  2. Click the display name of the connection profile that you want to delete.

    A connection profile overview page appears.

  3. Click Delete.
  4. In the dialog, click Delete.

gcloud

This command returns an interactive confirmation prompt that requires your input to complete. You can skip the confirmation prompt by using the optional --quiet flag.

Before using any of the command data below, make the following replacements:

  • REGION with the identifier of the region where your connection profile is saved.
  • CONNECTION_PROFILE_ID with your connection profile identifier.

    If you don't know the identifier, you can use the gcloud database-migration connection-profiles list command to list all profiles in a given region and view their identifiers.

For more information on these values, see Connection profiles overview.

Execute the following command:

Linux, macOS, or Cloud Shell

gcloud database-migration connection-profiles \
delete CONNECTION_PROFILE_ID \
  --region=REGION

Windows (PowerShell)

gcloud database-migration connection-profiles `
delete CONNECTION_PROFILE_ID `
  --region=REGION

Windows (cmd.exe)

gcloud database-migration connection-profiles ^
delete CONNECTION_PROFILE_ID ^
  --region=REGION
Result

The delete returns an interactive prompt where you confirm the action. Enter Y to remove the connection profile:

You are about to delete connection_profile [CONNECTION_PROFILE_ID]

Do you want to continue (Y/n)?
You can skip Google Cloud CLI interactive confirmation prompts by using the optional --quiet flag.