DataTransferConfig

Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer.

To get more information about Config, see:

API documentation
How-to Guides
- Official Documentation

Create a DataTransferConfig Resource

new DataTransferConfig(name: string, args: DataTransferConfigArgs, opts?: CustomResourceOptions);

def DataTransferConfig(resource_name, opts=None, data_refresh_window_days=None, data_source_id=None, destination_dataset_id=None, disabled=None, display_name=None, location=None, params=None, project=None, schedule=None, service_account_name=None, __props__=None);

func NewDataTransferConfig(ctx *Context, name string, args DataTransferConfigArgs, opts ...ResourceOption) (*DataTransferConfig, error)

public DataTransferConfig(string name, DataTransferConfigArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args DataTransferConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DataTransferConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DataTransferConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

DataTransferConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The DataTransferConfig resource accepts the following input properties:

DataSourceId string: The data source id. Cannot be changed once the transfer config is created.
DestinationDatasetId string: The BigQuery target dataset id.
DisplayName string: The user specified display name for the transfer config.
Params Dictionary<string, string>: These parameters are specific to each data source.
DataRefreshWindowDays int: The number of days to look back to automatically refresh the data. For example, if dataRefreshWindowDays = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
Disabled bool: When set to true, no runs are scheduled for a given transfer.
Location string: The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Schedule string: Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan, jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
ServiceAccountName string: Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

DataSourceId string: The data source id. Cannot be changed once the transfer config is created.
DestinationDatasetId string: The BigQuery target dataset id.
DisplayName string: The user specified display name for the transfer config.
Params map[string]string: These parameters are specific to each data source.
DataRefreshWindowDays int: The number of days to look back to automatically refresh the data. For example, if dataRefreshWindowDays = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
Disabled bool: When set to true, no runs are scheduled for a given transfer.
Location string: The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Schedule string: Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan, jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
ServiceAccountName string: Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

dataSourceId string: The data source id. Cannot be changed once the transfer config is created.
destinationDatasetId string: The BigQuery target dataset id.
displayName string: The user specified display name for the transfer config.
params {[key: string]: string}: These parameters are specific to each data source.
dataRefreshWindowDays number: The number of days to look back to automatically refresh the data. For example, if dataRefreshWindowDays = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
disabled boolean: When set to true, no runs are scheduled for a given transfer.
location string: The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
schedule string: Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan, jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
serviceAccountName string: Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

data_source_id str: The data source id. Cannot be changed once the transfer config is created.
destination_dataset_id str: The BigQuery target dataset id.
display_name str: The user specified display name for the transfer config.
params Dict[str, str]: These parameters are specific to each data source.
data_refresh_window_days float: The number of days to look back to automatically refresh the data. For example, if dataRefreshWindowDays = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
disabled bool: When set to true, no runs are scheduled for a given transfer.
location str: The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
schedule str: Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan, jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
service_account_name str: Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

Outputs

All input properties are implicitly available as output properties. Additionally, the DataTransferConfig resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Name string: The resource name of the transfer config. Transfer config names have the form projects/{projectId}/locations/{location}/transferConfigs/{configId}. Where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.

Id string: The provider-assigned unique ID for this managed resource.
Name string: The resource name of the transfer config. Transfer config names have the form projects/{projectId}/locations/{location}/transferConfigs/{configId}. Where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.

id string: The provider-assigned unique ID for this managed resource.
name string: The resource name of the transfer config. Transfer config names have the form projects/{projectId}/locations/{location}/transferConfigs/{configId}. Where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.

id str: The provider-assigned unique ID for this managed resource.
name str: The resource name of the transfer config. Transfer config names have the form projects/{projectId}/locations/{location}/transferConfigs/{configId}. Where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.

Look up an Existing DataTransferConfig Resource

Get an existing DataTransferConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DataTransferConfigState, opts?: CustomResourceOptions): DataTransferConfig

static get(resource_name, id, opts=None, data_refresh_window_days=None, data_source_id=None, destination_dataset_id=None, disabled=None, display_name=None, location=None, name=None, params=None, project=None, schedule=None, service_account_name=None, __props__=None);

func GetDataTransferConfig(ctx *Context, name string, id IDInput, state *DataTransferConfigState, opts ...ResourceOption) (*DataTransferConfig, error)

public static DataTransferConfig Get(string name, Input<string> id, DataTransferConfigState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DataRefreshWindowDays int: The number of days to look back to automatically refresh the data. For example, if dataRefreshWindowDays = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
DataSourceId string: The data source id. Cannot be changed once the transfer config is created.
DestinationDatasetId string: The BigQuery target dataset id.
Disabled bool: When set to true, no runs are scheduled for a given transfer.
DisplayName string: The user specified display name for the transfer config.
Location string: The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
Name string: The resource name of the transfer config. Transfer config names have the form projects/{projectId}/locations/{location}/transferConfigs/{configId}. Where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
Params Dictionary<string, string>: These parameters are specific to each data source.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Schedule string: Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan, jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
ServiceAccountName string: Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

DataRefreshWindowDays int: The number of days to look back to automatically refresh the data. For example, if dataRefreshWindowDays = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
DataSourceId string: The data source id. Cannot be changed once the transfer config is created.
DestinationDatasetId string: The BigQuery target dataset id.
Disabled bool: When set to true, no runs are scheduled for a given transfer.
DisplayName string: The user specified display name for the transfer config.
Location string: The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
Name string: The resource name of the transfer config. Transfer config names have the form projects/{projectId}/locations/{location}/transferConfigs/{configId}. Where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
Params map[string]string: These parameters are specific to each data source.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Schedule string: Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan, jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
ServiceAccountName string: Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

dataRefreshWindowDays number: The number of days to look back to automatically refresh the data. For example, if dataRefreshWindowDays = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
dataSourceId string: The data source id. Cannot be changed once the transfer config is created.
destinationDatasetId string: The BigQuery target dataset id.
disabled boolean: When set to true, no runs are scheduled for a given transfer.
displayName string: The user specified display name for the transfer config.
location string: The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
name string: The resource name of the transfer config. Transfer config names have the form projects/{projectId}/locations/{location}/transferConfigs/{configId}. Where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
params {[key: string]: string}: These parameters are specific to each data source.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
schedule string: Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan, jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
serviceAccountName string: Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

data_refresh_window_days float: The number of days to look back to automatically refresh the data. For example, if dataRefreshWindowDays = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
data_source_id str: The data source id. Cannot be changed once the transfer config is created.
destination_dataset_id str: The BigQuery target dataset id.
disabled bool: When set to true, no runs are scheduled for a given transfer.
display_name str: The user specified display name for the transfer config.
location str: The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
name str: The resource name of the transfer config. Transfer config names have the form projects/{projectId}/locations/{location}/transferConfigs/{configId}. Where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
params Dict[str, str]: These parameters are specific to each data source.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
schedule str: Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan, jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
service_account_name str: Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud