yandex_datatransfer_transfer (Data Source)

Transfer core entity

Example usageExample usage

//
// Get information about existing Datatransfer Endpoint
//
data "yandex_datatransfer_transfer" "pgpg_transfer_ds" {
  transfer_id = yandex_datatransfer_transfer.pgpg_transfer.id
}

SchemaSchema

OptionalOptional

• folder_id (String) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• id (String) Identifier of the transfer to be returned.

To get the list of all available transfers, make a [List] request.

• on_create_activate_mode (String) Activation action on create a new incremental transfer. It is not part of the transfer parameter and is used only on create. One of sync_activate, async_activate, dont_activate. The default is async_activate.
• timeouts (Attributes) (see below for nested schema)
• transfer_id (String) Identifier of the transfer to be returned.

To get the list of all available transfers, make a [List] request.

Read-OnlyRead-Only

• description (String) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• labels (Map of String) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• name (String) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• replication_runtime (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• runtime (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• transformation (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• type (String) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• warning (String) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto

Nested Schema for Nested Schema for timeouts

Optional:

• create (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
• delete (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
• read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
• update (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Nested Schema for Nested Schema for replication_runtime

Read-Only:

• yc_runtime (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)

Nested Schema for Nested Schema for replication_runtime.yc_runtime

Read-Only:

• job_count (Number) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• upload_shard_params (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)

Nested Schema for Nested Schema for replication_runtime.yc_runtime.upload_shard_params

Read-Only:

• job_count (Number) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• process_count (Number) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto

Nested Schema for Nested Schema for runtime

Read-Only:

• yc_runtime (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)

Nested Schema for Nested Schema for runtime.yc_runtime

Read-Only:

• job_count (Number) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• upload_shard_params (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)

Nested Schema for Nested Schema for runtime.yc_runtime.upload_shard_params

Read-Only:

• job_count (Number) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• process_count (Number) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto

Nested Schema for Nested Schema for transformation

Read-Only:

• transformers (Attributes List) Transformers are set as a list.
  When activating a transfer, a transformation plan is made for the tables that
  match the specified criteria.
  Transformers are applied to the tables in the sequence specified in the list. (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers

Read-Only:

• convert_to_string (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• filter_columns (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• filter_rows (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• mask_field (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• rename_tables (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• replace_primary_key (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• sharder_transformer (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• table_splitter_transformer (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.convert_to_string

Read-Only:

• columns (Attributes List) List of included and excluded columns (see below for nested schema)
• tables (Attributes List) List of included and excluded tables (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.convert_to_string.columns

Read-Only:

• exclude_columns (List of String) List of columns that will be excluded to transfer
• include_columns (List of String) List of columns that will be included to transfer

Nested Schema for Nested Schema for transformation.transformers.convert_to_string.tables

Read-Only:

• exclude_tables (List of String) List of tables that will be excluded to transfer
• include_tables (List of String) List of tables that will be included to transfer

Nested Schema for Nested Schema for transformation.transformers.filter_columns

Read-Only:

• columns (Attributes List) List of the columns to transfer to the target tables using lists of included and
  excluded columns. (see below for nested schema)
• tables (Attributes List) List of the tables to filter using lists of included and excluded tables. (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.filter_columns.columns

Read-Only:

• exclude_columns (List of String) List of columns that will be excluded to transfer
• include_columns (List of String) List of columns that will be included to transfer

Nested Schema for Nested Schema for transformation.transformers.filter_columns.tables

Read-Only:

• exclude_tables (List of String) List of tables that will be excluded to transfer
• include_tables (List of String) List of tables that will be included to transfer

Nested Schema for Nested Schema for transformation.transformers.filter_rows

Read-Only:

• filter (String) Filtering criterion. This can be comparison operators for numeric, string, and
  Boolean values,
  comparison to NULL, and checking whether a substring is part of a string.
  Details here:
  https://yandex.cloud/en-ru/docs/data-transfer/concepts/data-transformation#append-only-sources.
  Deprecated: Use filters instead.
• filters (List of String) Data is transported if it satisfies at least one of filters. Consider that there
  is OR statement between filters.
  Each filter can be comparison operators for numeric, string, and Boolean values,
  comparison to NULL, and
  checking whether a substring is part of a string.
  Details in docs:
  https://yandex.cloud/en-ru/docs/data-transfer/concepts/data-transformation#append-only-sources.
• tables (Attributes List) List of included and excluded tables. (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.filter_rows.tables

Read-Only:

• exclude_tables (List of String) List of tables that will be excluded to transfer
• include_tables (List of String) List of tables that will be included to transfer

Nested Schema for Nested Schema for transformation.transformers.mask_field

Read-Only:

• columns (List of String) Specify the name of the column for data masking (a regular expression).
• function (Attributes List) Mask function (see below for nested schema)
• tables (Attributes List) List of included and excluded tables (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.mask_field.function

Read-Only:

• mask_function_hash (Attributes List) Hash mask function (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.mask_field.tables.mask_function_hash

Read-Only:

• user_defined_salt (String) This string will be used in the HMAC(sha256, salt) function applied to the
  column data.

Nested Schema for Nested Schema for transformation.transformers.mask_field.tables

Read-Only:

• exclude_tables (List of String) List of tables that will be excluded to transfer
• include_tables (List of String) List of tables that will be included to transfer

Nested Schema for Nested Schema for transformation.transformers.rename_tables

Read-Only:

• rename_tables (Attributes List) List of renaming rules (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.rename_tables.rename_tables

Read-Only:

• new_name (Attributes List) Specify the new names for this table in the target (see below for nested schema)
• original_name (Attributes List) Specify the current names of the table in the source (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.rename_tables.rename_tables.new_name

Read-Only:

• name (String) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• name_space (String) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto

Nested Schema for Nested Schema for transformation.transformers.rename_tables.rename_tables.original_name

Read-Only:

• name (String) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto
• name_space (String) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto

Nested Schema for Nested Schema for transformation.transformers.replace_primary_key

Read-Only:

• keys (List of String) List of columns to be used as primary keys
• tables (Attributes List) List of included and excluded tables (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.replace_primary_key.tables

Read-Only:

• exclude_tables (List of String) List of tables that will be excluded to transfer
• include_tables (List of String) List of tables that will be included to transfer

Nested Schema for Nested Schema for transformation.transformers.sharder_transformer

Read-Only:

• columns (Attributes List) List of included and excluded columns (see below for nested schema)
• random (Attributes List) package: yandex.cloud.datatransfer.v1
  filename: yandex/cloud/datatransfer/v1/transfer.proto (see below for nested schema)
• shards_count (Number) Number of shards
• tables (Attributes List) List of included and excluded tables (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.sharder_transformer.columns

Read-Only:

• exclude_columns (List of String) List of columns that will be excluded to transfer
• include_columns (List of String) List of columns that will be included to transfer

Nested Schema for Nested Schema for transformation.transformers.sharder_transformer.random

Nested Schema for Nested Schema for transformation.transformers.sharder_transformer.tables

Read-Only:

• exclude_tables (List of String) List of tables that will be excluded to transfer
• include_tables (List of String) List of tables that will be included to transfer

Nested Schema for Nested Schema for transformation.transformers.table_splitter_transformer

Read-Only:

• columns (List of String) Specify the columns in the tables to be partitioned.
• splitter (String) Specify the split string to be used for merging components in a new table name.
• tables (Attributes List) List of included and excluded tables (see below for nested schema)

Nested Schema for Nested Schema for transformation.transformers.table_splitter_transformer.tables

Read-Only:

• exclude_tables (List of String) List of tables that will be excluded to transfer
• include_tables (List of String) List of tables that will be included to transfer