gcloud-help/gcloud/beta/alloydb/clusters/migrate-cloud-sql

NAME
    gcloud beta alloydb clusters migrate-cloud-sql - migrate Cloud SQL instance
        to an AlloyDB cluster

SYNOPSIS
    gcloud beta alloydb clusters migrate-cloud-sql CLUSTER
        --cloud-sql-backup-id=CLOUD_SQL_BACKUP_ID
        --cloud-sql-instance-id=CLOUD_SQL_INSTANCE_ID
        --cloud-sql-project-id=CLOUD_SQL_PROJECT_ID --password=PASSWORD
        --region=REGION [--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME]
        [--async] [--database-version=DATABASE_VERSION]
        [--[no-]enable-dataplex-integration] [--enable-private-service-connect]
        [--network=NETWORK] [--subscription-type=SUBSCRIPTION_TYPE]
        [--tags=[KEY=VALUE,...]]
        [--continuous-backup-recovery-window-days=RECOVERY_PERIOD
          --enable-continuous-backup
          [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY
          : --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT]]
        [--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE
          --deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE --deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME]
        [--disable-automated-backup
          | [--automated-backup-days-of-week=[DAYS_OF_WEEK,...]
          --automated-backup-start-times=[START_TIMES,...]
          : --automated-backup-window=TIMEOUT_PERIOD
          [--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY
          : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]]
        [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING
          --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]
        [--maintenance-window-day=MAINTENANCE_WINDOW_DAY
          --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR]
        [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    (BETA) This command migrates a Cloud SQL instance to an AlloyDB cluster
    using an existing Cloud SQL backup.

EXAMPLES
    To migrate a Cloud SQL instance to an AlloyDB cluster from a backup, run:

        $ gcloud beta alloydb clusters migrate-cloud-sql \
          my-alloydb-cluster --region=us-central1 \
          --cloud-sql-project-id=my-cloud-sql-project-id \
          --cloud-sql-instance-id=my-cloud-sql-cluster-id \
          --cloud-sql-backup-id=my-cloud-sql-backup-id

POSITIONAL ARGUMENTS
     CLUSTER
        AlloyDB cluster ID

REQUIRED FLAGS
     Migrate Cloud SQL strategy.

     This must be specified.

       Migrate CloudSQL instance to an AlloyDB cluster by restoring from an
       existing backup.

       --cloud-sql-backup-id=CLOUD_SQL_BACKUP_ID
          CloudSQL backup ID to migrate from. This must be the backup ID
          (myBackup).

     --cloud-sql-instance-id=CLOUD_SQL_INSTANCE_ID
        CloudSQL instance ID to migrate from. This must be the instance ID
        (myInstance).

     --cloud-sql-project-id=CLOUD_SQL_PROJECT_ID
        CloudSQL project to migrate from. This must be the project ID
        (myProject).

     --password=PASSWORD
        Initial postgres user password to set up during cluster creation.

     --region=REGION
        Regional location (e.g. asia-east1, us-east1). See the full list of
        regions at https://cloud.google.com/sql/docs/instance-locations.

OPTIONAL FLAGS
     --allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME
        Name of the allocated IP range for the private IP AlloyDB cluster, for
        example: "google-managed-services-default". If set, the instance IPs
        for this cluster will be created in the allocated range. The range name
        must comply with RFC 1035. Specifically, the name must be 1-63
        characters long and match the regular expression
        [a-z]([-a-z0-9]*[a-z0-9])?.

     --async
        Return immediately, without waiting for the operation in progress to
        complete.

     --database-version=DATABASE_VERSION
        Database version of the cluster. DATABASE_VERSION must be one of:
        POSTGRES_14, POSTGRES_15, POSTGRES_16, POSTGRES_17, POSTGRES_18.

     --[no-]enable-dataplex-integration
        Enable or disable Dataplex integration for this cluster (Enabled by
        default). Use --enable-dataplex-integration to enable and
        --no-enable-dataplex-integration to disable.

     --enable-private-service-connect
        Enable Private Service Connect (PSC) connectivity for the cluster.

     --network=NETWORK
        Network in the current project that the instance will be part of. To
        specify using a network with a shared VPC, use the full URL of the
        network. For an example host project, testproject, and shared network,
        testsharednetwork, this would be of the
        form:--network=projects/testproject/global/networks/testsharednetwork

     --subscription-type=SUBSCRIPTION_TYPE
        Subscription type of the cluster. SUBSCRIPTION_TYPE must be one of:
        STANDARD, TRIAL.

     --tags=[KEY=VALUE,...]
        List of tags KEY=VALUE pairs to bind. Each item must be expressed as
        <tag-key-namespaced-name>=<tag-value-short-name>.

        Example: 123/environment=production,123/costCenter=marketing

     Continuous Backup configuration. If unspecified, continuous backups are
     enabled.

     --continuous-backup-recovery-window-days=RECOVERY_PERIOD
        Recovery window of the log files and backups saved to support
        Continuous Backups.

     --enable-continuous-backup
        Enables Continuous Backups on the cluster.

     Key resource - The Cloud KMS (Key Management Service) cryptokey that will
     be used to protect the continuous backup. The 'AlloyDB Service Agent's
     service account must hold permission 'Cloud KMS CryptoKey
     Encrypter/Decrypter'. The arguments in this group can be used to specify
     the attributes of this resource.

     --continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY
        ID of the key or fully qualified identifier for the key.

        To set the kms-key attribute:
        ◆ provide the argument --continuous-backup-encryption-key on the
          command line.

        This flag argument must be specified if any of the other arguments in
        this group are specified.

     --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING
        The KMS keyring of the key.

        To set the kms-keyring attribute:
        ◆ provide the argument --continuous-backup-encryption-key on the
          command line with a fully specified name;
        ◆ provide the argument --continuous-backup-encryption-key-keyring on
          the command line.

     --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION
        The Google Cloud location for the key.

        To set the kms-location attribute:
        ◆ provide the argument --continuous-backup-encryption-key on the
          command line with a fully specified name;
        ◆ provide the argument --continuous-backup-encryption-key-location on
          the command line.

     --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT
        The Google Cloud project for the key.

        To set the kms-project attribute:
        ◆ provide the argument --continuous-backup-encryption-key on the
          command line with a fully specified name;
        ◆ provide the argument --continuous-backup-encryption-key-project on
          the command line;
        ◆ set the property core/project.

     Specify preferred day and time for maintenance deny period.

     --deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE
        Date when the deny maintenance period ends, that is 2020-11-01 or 11-01
        for recurring.

        This flag argument must be specified if any of the other arguments in
        this group are specified.

     --deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE
        Date when the deny maintenance period begins, that is 2020-11-01 or
        11-01 for recurring.

        This flag argument must be specified if any of the other arguments in
        this group are specified.

     --deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME
        Time when the deny maintenance period starts and ends, for example
        05:00, in UTC time zone.

        This flag argument must be specified if any of the other arguments in
        this group are specified.

     Automated backup policy. If unspecified, automated backups are disabled.

     At most one of these can be specified:

       --disable-automated-backup
          Disables automated backups on the cluster.

       Or at least one of these can be specified:

         Enable automated backup policy.

         --automated-backup-days-of-week=[DAYS_OF_WEEK,...]
            Comma-separated list of days of the week to perform a backup. At
            least one day of the week must be provided. (e.g.,
            --automated-backup-days-of-week=MONDAY,WEDNESDAY,SUNDAY).
            DAYS_OF_WEEK must be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY,
            FRIDAY, SATURDAY, SUNDAY.

            This flag argument must be specified if any of the other arguments
            in this group are specified.

         --automated-backup-start-times=[START_TIMES,...]
            Comma-separated list of times during the day to start a backup. At
            least one start time must be provided. The start times are assumed
            to be in UTC and required to be an exact hour in the format HH:00.
            (e.g., --automated-backup-start-times=01:00,13:00)

            This flag argument must be specified if any of the other arguments
            in this group are specified.

         --automated-backup-window=TIMEOUT_PERIOD
            Length of the time window beginning at start time during which a
            backup can be taken. If a backup does not succeed within this time
            window, it will be canceled and considered failed. The backup
            window must be at least 5 minutes long. There is no upper bound on
            the window. If not set, it will default to 1 hour.

         Key resource - The Cloud KMS (Key Management Service) cryptokey that
         will be used to protect the automated backups. The 'AlloyDB Service
         Agent' service account must hold permission 'Cloud KMS CryptoKey
         Encrypter/Decrypter'. The arguments in this group can be used to
         specify the attributes of this resource.

         --automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY
            ID of the key or fully qualified identifier for the key.

            To set the kms-key attribute:
            ▫ provide the argument --automated-backup-encryption-key on the
              command line.

            This flag argument must be specified if any of the other arguments
            in this group are specified.

         --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING
            The KMS keyring of the key.

            To set the kms-keyring attribute:
            ▫ provide the argument --automated-backup-encryption-key on the
              command line with a fully specified name;
            ▫ provide the argument --automated-backup-encryption-key-keyring
              on the command line.

         --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION
            The Google Cloud location for the key.

            To set the kms-location attribute:
            ▫ provide the argument --automated-backup-encryption-key on the
              command line with a fully specified name;
            ▫ provide the argument --automated-backup-encryption-key-location
              on the command line.

         --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT
            The Google Cloud project for the key.

            To set the kms-project attribute:
            ▫ provide the argument --automated-backup-encryption-key on the
              command line with a fully specified name;
            ▫ provide the argument --automated-backup-encryption-key-project
              on the command line;
            ▫ set the property core/project.

         Retention policy. If no retention policy is provided, all automated
         backups will be retained.

         At most one of these can be specified:

           --automated-backup-retention-count=RETENTION_COUNT
              Number of most recent successful backups retained.

           --automated-backup-retention-period=RETENTION_PERIOD
              Retention period of the backup relative to creation time. See $
              gcloud topic datetimes for information on duration formats.

     Key resource - The Cloud KMS (Key Management Service) cryptokey that will
     be used to protect the cluster. The 'AlloyDB Service Agent' service
     account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'.
     The arguments in this group can be used to specify the attributes of this
     resource.

     --kms-key=KMS_KEY
        ID of the key or fully qualified identifier for the key.

        To set the kms-key attribute:
        ◆ provide the argument --kms-key on the command line.

        This flag argument must be specified if any of the other arguments in
        this group are specified.

     --kms-keyring=KMS_KEYRING
        The KMS keyring of the key.

        To set the kms-keyring attribute:
        ◆ provide the argument --kms-key on the command line with a fully
          specified name;
        ◆ provide the argument --kms-keyring on the command line.

     --kms-location=KMS_LOCATION
        The Google Cloud location for the key.

        To set the kms-location attribute:
        ◆ provide the argument --kms-key on the command line with a fully
          specified name;
        ◆ provide the argument --kms-location on the command line.

     --kms-project=KMS_PROJECT
        The Google Cloud project for the key.

        To set the kms-project attribute:
        ◆ provide the argument --kms-key on the command line with a fully
          specified name;
        ◆ provide the argument --kms-project on the command line;
        ◆ set the property core/project.

     Specify preferred day and time for maintenance.

     --maintenance-window-day=MAINTENANCE_WINDOW_DAY
        Day of week for maintenance window, in UTC time zone.
        MAINTENANCE_WINDOW_DAY must be one of: MONDAY, TUESDAY, WEDNESDAY,
        THURSDAY, FRIDAY, SATURDAY, SUNDAY.

        This flag argument must be specified if any of the other arguments in
        this group are specified.

     --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR
        Hour of day for maintenance window, in UTC time zone.

        This flag argument must be specified if any of the other arguments in
        this group are specified.

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 beta and might change without notice. These
    variants are also available:

        $ gcloud alloydb clusters migrate-cloud-sql

        $ gcloud alpha alloydb clusters migrate-cloud-sql