Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigquerydatatransfer
  5. bigquerydatatransfer/v1
  6. TransferConfig

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.bigquerydatatransfer/v1.TransferConfig

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new data transfer configuration. Auto-naming is currently not supported for this resource.

    Create TransferConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TransferConfig(name: string, args?: TransferConfigArgs, opts?: CustomResourceOptions);
    @overload
def TransferConfig(resource_name: str,
                   args: Optional[TransferConfigArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def TransferConfig(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   authorization_code: Optional[str] = None,
                   data_refresh_window_days: Optional[int] = None,
                   data_source_id: Optional[str] = None,
                   destination_dataset_id: Optional[str] = None,
                   disabled: Optional[bool] = None,
                   display_name: Optional[str] = None,
                   email_preferences: Optional[EmailPreferencesArgs] = None,
                   encryption_configuration: Optional[EncryptionConfigurationArgs] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   notification_pubsub_topic: Optional[str] = None,
                   params: Optional[Mapping[str, str]] = None,
                   project: Optional[str] = None,
                   schedule: Optional[str] = None,
                   schedule_options: Optional[ScheduleOptionsArgs] = None,
                   service_account_name: Optional[str] = None,
                   user_id: Optional[str] = None,
                   version_info: Optional[str] = None)
    func NewTransferConfig(ctx *Context, name string, args *TransferConfigArgs, opts ...ResourceOption) (*TransferConfig, error)
    public TransferConfig(string name, TransferConfigArgs? args = null, CustomResourceOptions? opts = null)
    public TransferConfig(String name, TransferConfigArgs args)
public TransferConfig(String name, TransferConfigArgs args, CustomResourceOptions options)

    type: google-native:bigquerydatatransfer/v1:TransferConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TransferConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TransferConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TransferConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TransferConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TransferConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var transferConfigResource = new GoogleNative.BigQueryDataTransfer.V1.TransferConfig("transferConfigResource", new()
{
    AuthorizationCode = "string",
    DataRefreshWindowDays = 0,
    DataSourceId = "string",
    DestinationDatasetId = "string",
    Disabled = false,
    DisplayName = "string",
    EmailPreferences = new GoogleNative.BigQueryDataTransfer.V1.Inputs.EmailPreferencesArgs
    {
        EnableFailureEmail = false,
    },
    EncryptionConfiguration = new GoogleNative.BigQueryDataTransfer.V1.Inputs.EncryptionConfigurationArgs
    {
        KmsKeyName = "string",
    },
    Location = "string",
    Name = "string",
    NotificationPubsubTopic = "string",
    Params = 
    {
        { "string", "string" },
    },
    Project = "string",
    Schedule = "string",
    ScheduleOptions = new GoogleNative.BigQueryDataTransfer.V1.Inputs.ScheduleOptionsArgs
    {
        DisableAutoScheduling = false,
        EndTime = "string",
        StartTime = "string",
    },
    ServiceAccountName = "string",
    VersionInfo = "string",
});

    example, err := bigquerydatatransfer.NewTransferConfig(ctx, "transferConfigResource", &bigquerydatatransfer.TransferConfigArgs{
	AuthorizationCode:     pulumi.String("string"),
	DataRefreshWindowDays: pulumi.Int(0),
	DataSourceId:          pulumi.String("string"),
	DestinationDatasetId:  pulumi.String("string"),
	Disabled:              pulumi.Bool(false),
	DisplayName:           pulumi.String("string"),
	EmailPreferences: &bigquerydatatransfer.EmailPreferencesArgs{
		EnableFailureEmail: pulumi.Bool(false),
	},
	EncryptionConfiguration: &bigquerydatatransfer.EncryptionConfigurationArgs{
		KmsKeyName: pulumi.String("string"),
	},
	Location:                pulumi.String("string"),
	Name:                    pulumi.String("string"),
	NotificationPubsubTopic: pulumi.String("string"),
	Params: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project:  pulumi.String("string"),
	Schedule: pulumi.String("string"),
	ScheduleOptions: &bigquerydatatransfer.ScheduleOptionsArgs{
		DisableAutoScheduling: pulumi.Bool(false),
		EndTime:               pulumi.String("string"),
		StartTime:             pulumi.String("string"),
	},
	ServiceAccountName: pulumi.String("string"),
	VersionInfo:        pulumi.String("string"),
})

    var transferConfigResource = new TransferConfig("transferConfigResource", TransferConfigArgs.builder()
    .authorizationCode("string")
    .dataRefreshWindowDays(0)
    .dataSourceId("string")
    .destinationDatasetId("string")
    .disabled(false)
    .displayName("string")
    .emailPreferences(EmailPreferencesArgs.builder()
        .enableFailureEmail(false)
        .build())
    .encryptionConfiguration(EncryptionConfigurationArgs.builder()
        .kmsKeyName("string")
        .build())
    .location("string")
    .name("string")
    .notificationPubsubTopic("string")
    .params(Map.of("string", "string"))
    .project("string")
    .schedule("string")
    .scheduleOptions(ScheduleOptionsArgs.builder()
        .disableAutoScheduling(false)
        .endTime("string")
        .startTime("string")
        .build())
    .serviceAccountName("string")
    .versionInfo("string")
    .build());

    transfer_config_resource = google_native.bigquerydatatransfer.v1.TransferConfig("transferConfigResource",
    authorization_code="string",
    data_refresh_window_days=0,
    data_source_id="string",
    destination_dataset_id="string",
    disabled=False,
    display_name="string",
    email_preferences={
        "enable_failure_email": False,
    },
    encryption_configuration={
        "kms_key_name": "string",
    },
    location="string",
    name="string",
    notification_pubsub_topic="string",
    params={
        "string": "string",
    },
    project="string",
    schedule="string",
    schedule_options={
        "disable_auto_scheduling": False,
        "end_time": "string",
        "start_time": "string",
    },
    service_account_name="string",
    version_info="string")

    const transferConfigResource = new google_native.bigquerydatatransfer.v1.TransferConfig("transferConfigResource", {
    authorizationCode: "string",
    dataRefreshWindowDays: 0,
    dataSourceId: "string",
    destinationDatasetId: "string",
    disabled: false,
    displayName: "string",
    emailPreferences: {
        enableFailureEmail: false,
    },
    encryptionConfiguration: {
        kmsKeyName: "string",
    },
    location: "string",
    name: "string",
    notificationPubsubTopic: "string",
    params: {
        string: "string",
    },
    project: "string",
    schedule: "string",
    scheduleOptions: {
        disableAutoScheduling: false,
        endTime: "string",
        startTime: "string",
    },
    serviceAccountName: "string",
    versionInfo: "string",
});

    type: google-native:bigquerydatatransfer/v1:TransferConfig
properties:
    authorizationCode: string
    dataRefreshWindowDays: 0
    dataSourceId: string
    destinationDatasetId: string
    disabled: false
    displayName: string
    emailPreferences:
        enableFailureEmail: false
    encryptionConfiguration:
        kmsKeyName: string
    location: string
    name: string
    notificationPubsubTopic: string
    params:
        string: string
    project: string
    schedule: string
    scheduleOptions:
        disableAutoScheduling: false
        endTime: string
        startTime: string
    serviceAccountName: string
    versionInfo: string

    TransferConfig Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TransferConfig resource accepts the following input properties:

    AuthorizationCode string
    Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    DataRefreshWindowDays int
    The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 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
    Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
    DestinationDatasetId string
    The BigQuery target dataset id.
    Disabled bool
    Is this config disabled. When set to true, no runs are scheduled for a given transfer.
    DisplayName string
    User specified display name for the data transfer.
    EmailPreferences Pulumi.GoogleNative.BigQueryDataTransfer.V1.Inputs.EmailPreferences
    Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
    EncryptionConfiguration Pulumi.GoogleNative.BigQueryDataTransfer.V1.Inputs.EncryptionConfiguration
    The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
    Location string
    Name string
    The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
    NotificationPubsubTopic string
    Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: projects/{project}/topics/{topic}
    Params Dictionary<string, string>
    Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
    Project string
    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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
    ScheduleOptions Pulumi.GoogleNative.BigQueryDataTransfer.V1.Inputs.ScheduleOptions
    Options customizing the data transfer schedule.
    ServiceAccountName string
    Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
    UserId string
    Deprecated. Unique ID of the user on whose behalf transfer is done.

    Deprecated: Deprecated. Unique ID of the user on whose behalf transfer is done.

    VersionInfo string
    Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    AuthorizationCode string
    Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    DataRefreshWindowDays int
    The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 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
    Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
    DestinationDatasetId string
    The BigQuery target dataset id.
    Disabled bool
    Is this config disabled. When set to true, no runs are scheduled for a given transfer.
    DisplayName string
    User specified display name for the data transfer.
    EmailPreferences EmailPreferencesArgs
    Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
    EncryptionConfiguration EncryptionConfigurationArgs
    The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
    Location string
    Name string
    The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
    NotificationPubsubTopic string
    Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: projects/{project}/topics/{topic}
    Params map[string]string
    Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
    Project string
    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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
    ScheduleOptions ScheduleOptionsArgs
    Options customizing the data transfer schedule.
    ServiceAccountName string
    Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
    UserId string
    Deprecated. Unique ID of the user on whose behalf transfer is done.

    Deprecated: Deprecated. Unique ID of the user on whose behalf transfer is done.

    VersionInfo string
    Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    authorizationCode String
    Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    dataRefreshWindowDays Integer
    The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 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
    Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
    destinationDatasetId String
    The BigQuery target dataset id.
    disabled Boolean
    Is this config disabled. When set to true, no runs are scheduled for a given transfer.
    displayName String
    User specified display name for the data transfer.
    emailPreferences EmailPreferences
    Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
    encryptionConfiguration EncryptionConfiguration
    The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
    location String
    name String
    The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
    notificationPubsubTopic String
    Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: projects/{project}/topics/{topic}
    params Map<String,String>
    Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
    project String
    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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
    scheduleOptions ScheduleOptions
    Options customizing the data transfer schedule.
    serviceAccountName String
    Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
    userId String
    Deprecated. Unique ID of the user on whose behalf transfer is done.

    Deprecated: Deprecated. Unique ID of the user on whose behalf transfer is done.

    versionInfo String
    Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    authorizationCode string
    Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    dataRefreshWindowDays number
    The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 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
    Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
    destinationDatasetId string
    The BigQuery target dataset id.
    disabled boolean
    Is this config disabled. When set to true, no runs are scheduled for a given transfer.
    displayName string
    User specified display name for the data transfer.
    emailPreferences EmailPreferences
    Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
    encryptionConfiguration EncryptionConfiguration
    The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
    location string
    name string
    The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
    notificationPubsubTopic string
    Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: projects/{project}/topics/{topic}
    params {[key: string]: string}
    Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
    project string
    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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
    scheduleOptions ScheduleOptions
    Options customizing the data transfer schedule.
    serviceAccountName string
    Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
    userId string
    Deprecated. Unique ID of the user on whose behalf transfer is done.

    Deprecated: Deprecated. Unique ID of the user on whose behalf transfer is done.

    versionInfo string
    Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    authorization_code str
    Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    data_refresh_window_days int
    The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 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
    Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
    destination_dataset_id str
    The BigQuery target dataset id.
    disabled bool
    Is this config disabled. When set to true, no runs are scheduled for a given transfer.
    display_name str
    User specified display name for the data transfer.
    email_preferences EmailPreferencesArgs
    Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
    encryption_configuration EncryptionConfigurationArgs
    The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
    location str
    name str
    The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
    notification_pubsub_topic str
    Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: projects/{project}/topics/{topic}
    params Mapping[str, str]
    Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
    project str
    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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
    schedule_options ScheduleOptionsArgs
    Options customizing the data transfer schedule.
    service_account_name str
    Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
    user_id str
    Deprecated. Unique ID of the user on whose behalf transfer is done.

    Deprecated: Deprecated. Unique ID of the user on whose behalf transfer is done.

    version_info str
    Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    authorizationCode String
    Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
    dataRefreshWindowDays Number
    The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 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
    Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
    destinationDatasetId String
    The BigQuery target dataset id.
    disabled Boolean
    Is this config disabled. When set to true, no runs are scheduled for a given transfer.
    displayName String
    User specified display name for the data transfer.
    emailPreferences Property Map
    Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
    encryptionConfiguration Property Map
    The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
    location String
    name String
    The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
    notificationPubsubTopic String
    Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: projects/{project}/topics/{topic}
    params Map<String>
    Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
    project String
    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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
    scheduleOptions Property Map
    Options customizing the data transfer schedule.
    serviceAccountName String
    Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
    userId String
    Deprecated. Unique ID of the user on whose behalf transfer is done.

    Deprecated: Deprecated. Unique ID of the user on whose behalf transfer is done.

    versionInfo String
    Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL: https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.

    Outputs

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

    DatasetRegion string
    Region in which BigQuery dataset is located.
    Id string
    The provider-assigned unique ID for this managed resource.
    NextRunTime string
    Next time when data transfer will run.
    OwnerInfo Pulumi.GoogleNative.BigQueryDataTransfer.V1.Outputs.UserInfoResponse
    Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.
    State string
    State of the most recently updated transfer run.
    UpdateTime string
    Data transfer modification time. Ignored by server on input.
    DatasetRegion string
    Region in which BigQuery dataset is located.
    Id string
    The provider-assigned unique ID for this managed resource.
    NextRunTime string
    Next time when data transfer will run.
    OwnerInfo UserInfoResponse
    Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.
    State string
    State of the most recently updated transfer run.
    UpdateTime string
    Data transfer modification time. Ignored by server on input.
    datasetRegion String
    Region in which BigQuery dataset is located.
    id String
    The provider-assigned unique ID for this managed resource.
    nextRunTime String
    Next time when data transfer will run.
    ownerInfo UserInfoResponse
    Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.
    state String
    State of the most recently updated transfer run.
    updateTime String
    Data transfer modification time. Ignored by server on input.
    datasetRegion string
    Region in which BigQuery dataset is located.
    id string
    The provider-assigned unique ID for this managed resource.
    nextRunTime string
    Next time when data transfer will run.
    ownerInfo UserInfoResponse
    Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.
    state string
    State of the most recently updated transfer run.
    updateTime string
    Data transfer modification time. Ignored by server on input.
    dataset_region str
    Region in which BigQuery dataset is located.
    id str
    The provider-assigned unique ID for this managed resource.
    next_run_time str
    Next time when data transfer will run.
    owner_info UserInfoResponse
    Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.
    state str
    State of the most recently updated transfer run.
    update_time str
    Data transfer modification time. Ignored by server on input.
    datasetRegion String
    Region in which BigQuery dataset is located.
    id String
    The provider-assigned unique ID for this managed resource.
    nextRunTime String
    Next time when data transfer will run.
    ownerInfo Property Map
    Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.
    state String
    State of the most recently updated transfer run.
    updateTime String
    Data transfer modification time. Ignored by server on input.

    Supporting Types

    EmailPreferences, EmailPreferencesArgs

    EnableFailureEmail bool
    If true, email notifications will be sent on transfer run failures.
    EnableFailureEmail bool
    If true, email notifications will be sent on transfer run failures.
    enableFailureEmail Boolean
    If true, email notifications will be sent on transfer run failures.
    enableFailureEmail boolean
    If true, email notifications will be sent on transfer run failures.
    enable_failure_email bool
    If true, email notifications will be sent on transfer run failures.
    enableFailureEmail Boolean
    If true, email notifications will be sent on transfer run failures.

    EmailPreferencesResponse, EmailPreferencesResponseArgs

    EnableFailureEmail bool
    If true, email notifications will be sent on transfer run failures.
    EnableFailureEmail bool
    If true, email notifications will be sent on transfer run failures.
    enableFailureEmail Boolean
    If true, email notifications will be sent on transfer run failures.
    enableFailureEmail boolean
    If true, email notifications will be sent on transfer run failures.
    enable_failure_email bool
    If true, email notifications will be sent on transfer run failures.
    enableFailureEmail Boolean
    If true, email notifications will be sent on transfer run failures.

    EncryptionConfiguration, EncryptionConfigurationArgs

    KmsKeyName string
    The name of the KMS key used for encrypting BigQuery data.
    KmsKeyName string
    The name of the KMS key used for encrypting BigQuery data.
    kmsKeyName String
    The name of the KMS key used for encrypting BigQuery data.
    kmsKeyName string
    The name of the KMS key used for encrypting BigQuery data.
    kms_key_name str
    The name of the KMS key used for encrypting BigQuery data.
    kmsKeyName String
    The name of the KMS key used for encrypting BigQuery data.

    EncryptionConfigurationResponse, EncryptionConfigurationResponseArgs

    KmsKeyName string
    The name of the KMS key used for encrypting BigQuery data.
    KmsKeyName string
    The name of the KMS key used for encrypting BigQuery data.
    kmsKeyName String
    The name of the KMS key used for encrypting BigQuery data.
    kmsKeyName string
    The name of the KMS key used for encrypting BigQuery data.
    kms_key_name str
    The name of the KMS key used for encrypting BigQuery data.
    kmsKeyName String
    The name of the KMS key used for encrypting BigQuery data.

    ScheduleOptions, ScheduleOptionsArgs

    DisableAutoScheduling bool
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    EndTime string
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    StartTime string
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    DisableAutoScheduling bool
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    EndTime string
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    StartTime string
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    disableAutoScheduling Boolean
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    endTime String
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    startTime String
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    disableAutoScheduling boolean
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    endTime string
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    startTime string
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    disable_auto_scheduling bool
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    end_time str
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    start_time str
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    disableAutoScheduling Boolean
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    endTime String
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    startTime String
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.

    ScheduleOptionsResponse, ScheduleOptionsResponseArgs

    DisableAutoScheduling bool
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    EndTime string
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    StartTime string
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    DisableAutoScheduling bool
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    EndTime string
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    StartTime string
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    disableAutoScheduling Boolean
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    endTime String
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    startTime String
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    disableAutoScheduling boolean
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    endTime string
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    startTime string
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    disable_auto_scheduling bool
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    end_time str
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    start_time str
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    disableAutoScheduling Boolean
    If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
    endTime String
    Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
    startTime String
    Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.

    UserInfoResponse, UserInfoResponseArgs

    Email string
    E-mail address of the user.
    Email string
    E-mail address of the user.
    email String
    E-mail address of the user.
    email string
    E-mail address of the user.
    email str
    E-mail address of the user.
    email String
    E-mail address of the user.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native