Managing transfer process

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To get a list of transfers in a folder, run the following command:

yc datatransfer transfer list

Use the list API method.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To get information about a transfer, run the following command:

yc datatransfer transfer get <transfer_ID>

You can get the transfer ID with the list of transfers in the folder.

Use the get API method and provide the transfer ID value in the transferId request parameter.

To find out the transfer ID, get a list of transfers in the folder.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To create a transfer:

1. View a description of the CLI create transfer command:

   yc datatransfer transfer create --help
   

2. Specify the transfer parameters in the create command:

   yc datatransfer transfer create <transfer_name> \
      --source-id=<source_endpoint_ID> \
      --target-id=<target_endpoint_ID> \
      --type=<transfer_type>
   

   Where:

   • --source-id: Source endpoint ID.
   • --target-id: Target endpoint ID.
   • --type: Transfer type:
     • snapshot-only: Copy.
     • increment-only: Replicate.
     • snapshot-and-increment: Copy and replicate.

   Note

   The transfer name must be unique within the folder. It may contain Latin letters, numbers, and hyphens. The name may be up to 63 characters long.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the documentation on the Terraform website or mirror website.

If you do not have Terraform yet, install it and configure its Yandex Cloud provider.

To create a transfer:

1. Create a configuration file with a description of your transfer.

   Here is the configuration file example:

   resource "yandex_datatransfer_transfer" "<transer_name_in_Terraform>" {
     folder_id   = "<folder_ID>"
     name        = "<transfer_name>"
     description = "<transfer_description>"
     source_id   = "<source_endpoint_ID>"
     target_id   = "<target_endpoint_ID>"
     type        = "<transfer_type>"
   }
   

   The available transfer types include:

   • SNAPSHOT_ONLY: Snapshot
   • INCREMENT_ONLY: Replication
   • SNAPSHOT_AND_INCREMENT: Snapshot and increment

2. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

3. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

When created, INCREMENT_ONLY and SNAPSHOT_AND_INCREMENT transfers are activated and run automatically.
If you want to activate a SNAPSHOT_ONLY transfer once it is created, add the provisioner "local-exec" section with the following transfer activation command to the configuration file:

   provisioner "local-exec" {
      command = "yc --profile <profile> datatransfer transfer activate ${yandex_datatransfer_transfer.<transfer_Terraform_resource_name>.id
   }

In this case, copying will only take place once at the time of transfer creation.

Use the create API method and include the following information in the request:

• ID of the folder where the transfer should be placed, in the folderId parameter.
• Transfer name in the name parameter.
• Source endpoint ID in the sourceId parameter.
• Target endpoint ID in the targetId parameter.
• Transfer type in the type parameter.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To update the transfer settings:

1. View a description of the update transfer CLI command:

   yc datatransfer transfer update --help
   

2. Run the following command with the list of settings to update:

   yc datatransfer transfer update <transfer_ID> \
      --name=<transfer_name> \
      --description=<transfer_description>
   

   You can get the transfer ID with the list of transfers in the folder.

1. Open the current Terraform configuration file with the transfer description.

   For information on creating a transfer like this, please review Create transfer.

2. Edit the values in the name and the description fields (transfer name and description).

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

Use the update API method and include the following in the request:

• Transfer ID in the transferId parameter. To find out the ID, get a list of transfers in the folder.
• Transfer name in the name parameter.
• Transfer description in the description parameter.
• List of transfer configuration fields to update in the updateMask parameter.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To activate a transfer, run this command:

yc datatransfer transfer activate <transfer_ID>

You can get the transfer ID with the list of transfers in the folder.

Use the activate API method and provide the transfer ID in the transferId request parameter.

To find out the transfer ID, get a list of transfers in the folder.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To deactivate a transfer, run this command:

yc datatransfer transfer deactivate <transfer_ID>

You can get the transfer ID with the list of transfers in the folder.

Use the deactivate API method and provide the transfer ID in the transferId request parameter.

To find out the transfer ID, get a list of transfers in the folder.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To delete a transfer, run this command:

yc datatransfer transfer delete <transfer_ID>

You can get the transfer ID with the list of transfers in the folder.

To delete a transfer created using Terraform:

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating a transfer.

2. Delete the transfer description.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Type the word yes, then press Enter.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

Use the delete API method and provide the transfer ID in the transferId request parameter.

To find out the transfer ID, get a list of transfers in the folder.