published on Wednesday, Nov 18, 2026 by Pulumi
published on Wednesday, Nov 18, 2026 by Pulumi
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
Note: All arguments marked as write-only values will not be stored in the state:
sensitive_params.secret_access_key_wo. Read more about Write-only Arguments.
Example Usage
Bigquerydatatransfer Config Scheduled Query
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const project = gcp.organizations.getProject({});
const permissions = new gcp.projects.IAMMember("permissions", {
project: project.then(project => project.projectId),
role: "roles/iam.serviceAccountTokenCreator",
member: project.then(project => `serviceAccount:service-${project.number}@gcp-sa-bigquerydatatransfer.iam.gserviceaccount.com`),
});
const myDataset = new gcp.bigquery.Dataset("my_dataset", {
datasetId: "my_dataset",
friendlyName: "foo",
description: "bar",
location: "asia-northeast1",
}, {
dependsOn: [permissions],
});
const keyRing = new gcp.kms.KeyRing("key_ring", {
name: "example-keyring",
location: "asia-northeast1",
});
const cryptoKey = new gcp.kms.CryptoKey("crypto_key", {
name: "example-key",
keyRing: keyRing.id,
});
const bigqueryEncrypter = new gcp.kms.CryptoKeyIAMMember("bigquery_encrypter", {
cryptoKeyId: cryptoKey.id,
role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
member: project.then(project => `serviceAccount:bq-${project.number}@bigquery-encryption.iam.gserviceaccount.com`),
});
const queryConfig = new gcp.bigquery.DataTransferConfig("query_config", {
displayName: "my-query",
location: "asia-northeast1",
dataSourceId: "scheduled_query",
schedule: "first sunday of quarter 00:00",
destinationDatasetId: myDataset.datasetId,
params: {
destination_table_name_template: "my_table",
write_disposition: "WRITE_APPEND",
query: "SELECT name FROM tabl WHERE x = 'y'",
},
encryptionConfiguration: {
kmsKeyName: cryptoKey.id,
},
}, {
dependsOn: [
permissions,
bigqueryEncrypter,
],
});
import pulumi
import pulumi_gcp as gcp
project = gcp.organizations.get_project()
permissions = gcp.projects.IAMMember("permissions",
project=project.project_id,
role="roles/iam.serviceAccountTokenCreator",
member=f"serviceAccount:service-{project.number}@gcp-sa-bigquerydatatransfer.iam.gserviceaccount.com")
my_dataset = gcp.bigquery.Dataset("my_dataset",
dataset_id="my_dataset",
friendly_name="foo",
description="bar",
location="asia-northeast1",
opts = pulumi.ResourceOptions(depends_on=[permissions]))
key_ring = gcp.kms.KeyRing("key_ring",
name="example-keyring",
location="asia-northeast1")
crypto_key = gcp.kms.CryptoKey("crypto_key",
name="example-key",
key_ring=key_ring.id)
bigquery_encrypter = gcp.kms.CryptoKeyIAMMember("bigquery_encrypter",
crypto_key_id=crypto_key.id,
role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
member=f"serviceAccount:bq-{project.number}@bigquery-encryption.iam.gserviceaccount.com")
query_config = gcp.bigquery.DataTransferConfig("query_config",
display_name="my-query",
location="asia-northeast1",
data_source_id="scheduled_query",
schedule="first sunday of quarter 00:00",
destination_dataset_id=my_dataset.dataset_id,
params={
"destination_table_name_template": "my_table",
"write_disposition": "WRITE_APPEND",
"query": "SELECT name FROM tabl WHERE x = 'y'",
},
encryption_configuration={
"kms_key_name": crypto_key.id,
},
opts = pulumi.ResourceOptions(depends_on=[
permissions,
bigquery_encrypter,
]))
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/bigquery"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/kms"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/organizations"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/projects"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
if err != nil {
return err
}
permissions, err := projects.NewIAMMember(ctx, "permissions", &projects.IAMMemberArgs{
Project: pulumi.String(project.ProjectId),
Role: pulumi.String("roles/iam.serviceAccountTokenCreator"),
Member: pulumi.Sprintf("serviceAccount:service-%v@gcp-sa-bigquerydatatransfer.iam.gserviceaccount.com", project.Number),
})
if err != nil {
return err
}
myDataset, err := bigquery.NewDataset(ctx, "my_dataset", &bigquery.DatasetArgs{
DatasetId: pulumi.String("my_dataset"),
FriendlyName: pulumi.String("foo"),
Description: pulumi.String("bar"),
Location: pulumi.String("asia-northeast1"),
}, pulumi.DependsOn([]pulumi.Resource{
permissions,
}))
if err != nil {
return err
}
keyRing, err := kms.NewKeyRing(ctx, "key_ring", &kms.KeyRingArgs{
Name: pulumi.String("example-keyring"),
Location: pulumi.String("asia-northeast1"),
})
if err != nil {
return err
}
cryptoKey, err := kms.NewCryptoKey(ctx, "crypto_key", &kms.CryptoKeyArgs{
Name: pulumi.String("example-key"),
KeyRing: keyRing.ID(),
})
if err != nil {
return err
}
bigqueryEncrypter, err := kms.NewCryptoKeyIAMMember(ctx, "bigquery_encrypter", &kms.CryptoKeyIAMMemberArgs{
CryptoKeyId: cryptoKey.ID(),
Role: pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
Member: pulumi.Sprintf("serviceAccount:bq-%v@bigquery-encryption.iam.gserviceaccount.com", project.Number),
})
if err != nil {
return err
}
_, err = bigquery.NewDataTransferConfig(ctx, "query_config", &bigquery.DataTransferConfigArgs{
DisplayName: pulumi.String("my-query"),
Location: pulumi.String("asia-northeast1"),
DataSourceId: pulumi.String("scheduled_query"),
Schedule: pulumi.String("first sunday of quarter 00:00"),
DestinationDatasetId: myDataset.DatasetId,
Params: pulumi.StringMap{
"destination_table_name_template": pulumi.String("my_table"),
"write_disposition": pulumi.String("WRITE_APPEND"),
"query": pulumi.String("SELECT name FROM tabl WHERE x = 'y'"),
},
EncryptionConfiguration: &bigquery.DataTransferConfigEncryptionConfigurationArgs{
KmsKeyName: cryptoKey.ID(),
},
}, pulumi.DependsOn([]pulumi.Resource{
permissions,
bigqueryEncrypter,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var project = Gcp.Organizations.GetProject.Invoke();
var permissions = new Gcp.Projects.IAMMember("permissions", new()
{
Project = project.Apply(getProjectResult => getProjectResult.ProjectId),
Role = "roles/iam.serviceAccountTokenCreator",
Member = $"serviceAccount:service-{project.Apply(getProjectResult => getProjectResult.Number)}@gcp-sa-bigquerydatatransfer.iam.gserviceaccount.com",
});
var myDataset = new Gcp.BigQuery.Dataset("my_dataset", new()
{
DatasetId = "my_dataset",
FriendlyName = "foo",
Description = "bar",
Location = "asia-northeast1",
}, new CustomResourceOptions
{
DependsOn =
{
permissions,
},
});
var keyRing = new Gcp.Kms.KeyRing("key_ring", new()
{
Name = "example-keyring",
Location = "asia-northeast1",
});
var cryptoKey = new Gcp.Kms.CryptoKey("crypto_key", new()
{
Name = "example-key",
KeyRing = keyRing.Id,
});
var bigqueryEncrypter = new Gcp.Kms.CryptoKeyIAMMember("bigquery_encrypter", new()
{
CryptoKeyId = cryptoKey.Id,
Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
Member = $"serviceAccount:bq-{project.Apply(getProjectResult => getProjectResult.Number)}@bigquery-encryption.iam.gserviceaccount.com",
});
var queryConfig = new Gcp.BigQuery.DataTransferConfig("query_config", new()
{
DisplayName = "my-query",
Location = "asia-northeast1",
DataSourceId = "scheduled_query",
Schedule = "first sunday of quarter 00:00",
DestinationDatasetId = myDataset.DatasetId,
Params =
{
{ "destination_table_name_template", "my_table" },
{ "write_disposition", "WRITE_APPEND" },
{ "query", "SELECT name FROM tabl WHERE x = 'y'" },
},
EncryptionConfiguration = new Gcp.BigQuery.Inputs.DataTransferConfigEncryptionConfigurationArgs
{
KmsKeyName = cryptoKey.Id,
},
}, new CustomResourceOptions
{
DependsOn =
{
permissions,
bigqueryEncrypter,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.projects.IAMMember;
import com.pulumi.gcp.projects.IAMMemberArgs;
import com.pulumi.gcp.bigquery.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.kms.KeyRing;
import com.pulumi.gcp.kms.KeyRingArgs;
import com.pulumi.gcp.kms.CryptoKey;
import com.pulumi.gcp.kms.CryptoKeyArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMMember;
import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
import com.pulumi.gcp.bigquery.DataTransferConfig;
import com.pulumi.gcp.bigquery.DataTransferConfigArgs;
import com.pulumi.gcp.bigquery.inputs.DataTransferConfigEncryptionConfigurationArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
.build());
var permissions = new IAMMember("permissions", IAMMemberArgs.builder()
.project(project.projectId())
.role("roles/iam.serviceAccountTokenCreator")
.member(String.format("serviceAccount:service-%s@gcp-sa-bigquerydatatransfer.iam.gserviceaccount.com", project.number()))
.build());
var myDataset = new Dataset("myDataset", DatasetArgs.builder()
.datasetId("my_dataset")
.friendlyName("foo")
.description("bar")
.location("asia-northeast1")
.build(), CustomResourceOptions.builder()
.dependsOn(permissions)
.build());
var keyRing = new KeyRing("keyRing", KeyRingArgs.builder()
.name("example-keyring")
.location("asia-northeast1")
.build());
var cryptoKey = new CryptoKey("cryptoKey", CryptoKeyArgs.builder()
.name("example-key")
.keyRing(keyRing.id())
.build());
var bigqueryEncrypter = new CryptoKeyIAMMember("bigqueryEncrypter", CryptoKeyIAMMemberArgs.builder()
.cryptoKeyId(cryptoKey.id())
.role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
.member(String.format("serviceAccount:bq-%s@bigquery-encryption.iam.gserviceaccount.com", project.number()))
.build());
var queryConfig = new DataTransferConfig("queryConfig", DataTransferConfigArgs.builder()
.displayName("my-query")
.location("asia-northeast1")
.dataSourceId("scheduled_query")
.schedule("first sunday of quarter 00:00")
.destinationDatasetId(myDataset.datasetId())
.params(Map.ofEntries(
Map.entry("destination_table_name_template", "my_table"),
Map.entry("write_disposition", "WRITE_APPEND"),
Map.entry("query", "SELECT name FROM tabl WHERE x = 'y'")
))
.encryptionConfiguration(DataTransferConfigEncryptionConfigurationArgs.builder()
.kmsKeyName(cryptoKey.id())
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(
permissions,
bigqueryEncrypter)
.build());
}
}
resources:
permissions:
type: gcp:projects:IAMMember
properties:
project: ${project.projectId}
role: roles/iam.serviceAccountTokenCreator
member: serviceAccount:service-${project.number}@gcp-sa-bigquerydatatransfer.iam.gserviceaccount.com
queryConfig:
type: gcp:bigquery:DataTransferConfig
name: query_config
properties:
displayName: my-query
location: asia-northeast1
dataSourceId: scheduled_query
schedule: first sunday of quarter 00:00
destinationDatasetId: ${myDataset.datasetId}
params:
destination_table_name_template: my_table
write_disposition: WRITE_APPEND
query: SELECT name FROM tabl WHERE x = 'y'
encryptionConfiguration:
kmsKeyName: ${cryptoKey.id}
options:
dependsOn:
- ${permissions}
- ${bigqueryEncrypter}
myDataset:
type: gcp:bigquery:Dataset
name: my_dataset
properties:
datasetId: my_dataset
friendlyName: foo
description: bar
location: asia-northeast1
options:
dependsOn:
- ${permissions}
cryptoKey:
type: gcp:kms:CryptoKey
name: crypto_key
properties:
name: example-key
keyRing: ${keyRing.id}
keyRing:
type: gcp:kms:KeyRing
name: key_ring
properties:
name: example-keyring
location: asia-northeast1
bigqueryEncrypter:
type: gcp:kms:CryptoKeyIAMMember
name: bigquery_encrypter
properties:
cryptoKeyId: ${cryptoKey.id}
role: roles/cloudkms.cryptoKeyEncrypterDecrypter
member: serviceAccount:bq-${project.number}@bigquery-encryption.iam.gserviceaccount.com
variables:
project:
fn::invoke:
function: gcp:organizations:getProject
arguments: {}
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
data "gcp_organizations_project" "project" {
}
resource "gcp_projects_i_a_m_member" "permissions" {
lifecycle {
create_before_destroy = true
}
project = data.gcp_organizations_project.project.project_id
role = "roles/iam.serviceAccountTokenCreator"
member ="serviceAccount:service-${data.gcp_organizations_project.project.number}@gcp-sa-bigquerydatatransfer.iam.gserviceaccount.com"
}
resource "gcp_bigquery_data_transfer_config" "query_config" {
depends_on = [gcp_projects_i_a_m_member.permissions, gcp_kms_crypto_key_i_a_m_member.bigquery_encrypter]
lifecycle {
create_before_destroy = true
}
display_name = "my-query"
location = "asia-northeast1"
data_source_id = "scheduled_query"
schedule = "first sunday of quarter 00:00"
destination_dataset_id = gcp_bigquery_dataset.my_dataset.dataset_id
params = {
"destination_table_name_template" = "my_table"
"write_disposition" = "WRITE_APPEND"
"query" = "SELECT name FROM tabl WHERE x = 'y'"
}
encryption_configuration = {
kms_key_name = gcp_kms_crypto_key.crypto_key.id
}
}
resource "gcp_bigquery_dataset" "my_dataset" {
depends_on = [gcp_projects_i_a_m_member.permissions]
lifecycle {
create_before_destroy = true
}
dataset_id = "my_dataset"
friendly_name = "foo"
description = "bar"
location = "asia-northeast1"
}
resource "gcp_kms_crypto_key" "crypto_key" {
lifecycle {
create_before_destroy = true
}
name = "example-key"
key_ring = gcp_kms_key_ring.key_ring.id
}
resource "gcp_kms_key_ring" "key_ring" {
lifecycle {
create_before_destroy = true
}
name = "example-keyring"
location = "asia-northeast1"
}
resource "gcp_kms_crypto_key_i_a_m_member" "bigquery_encrypter" {
lifecycle {
create_before_destroy = true
}
crypto_key_id = gcp_kms_crypto_key.crypto_key.id
role = "roles/cloudkms.cryptoKeyEncrypterDecrypter"
member ="serviceAccount:bq-${data.gcp_organizations_project.project.number}@bigquery-encryption.iam.gserviceaccount.com"
}
Bigquerydatatransfer Config Schedule Options V2
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const eventDriven = new gcp.pubsub.Topic("event_driven", {name: "my-topic"});
const eventDrivenSubscription = new gcp.pubsub.Subscription("event_driven", {
name: "my-subscription",
topic: eventDriven.id,
});
const eventDrivenBucket = new gcp.storage.Bucket("event_driven", {
name: "my-bucket",
location: "US",
uniformBucketLevelAccess: true,
forceDestroy: true,
});
const eventDrivenDataset = new gcp.bigquery.Dataset("event_driven", {
datasetId: "my_dataset",
friendlyName: "foo",
description: "bar",
location: "US",
});
const eventDrivenTable = new gcp.bigquery.Table("event_driven", {
deletionProtection: false,
datasetId: eventDrivenDataset.datasetId,
tableId: "my_table",
schema: "[{\"name\":\"name\",\"type\":\"STRING\"}]",
});
const eventDrivenConfig = new gcp.bigquery.DataTransferConfig("event_driven_config", {
displayName: "my-event-driven-config",
location: eventDrivenDataset.location,
dataSourceId: "google_cloud_storage",
destinationDatasetId: eventDrivenDataset.datasetId,
scheduleOptionsV2: {
eventDrivenSchedule: {
pubsubSubscription: eventDrivenSubscription.id,
},
},
params: {
data_path_template: pulumi.interpolate`${eventDrivenBucket.url}/*.json`,
destination_table_name_template: eventDrivenTable.tableId,
file_format: "JSON",
write_disposition: "APPEND",
},
});
import pulumi
import pulumi_gcp as gcp
event_driven = gcp.pubsub.Topic("event_driven", name="my-topic")
event_driven_subscription = gcp.pubsub.Subscription("event_driven",
name="my-subscription",
topic=event_driven.id)
event_driven_bucket = gcp.storage.Bucket("event_driven",
name="my-bucket",
location="US",
uniform_bucket_level_access=True,
force_destroy=True)
event_driven_dataset = gcp.bigquery.Dataset("event_driven",
dataset_id="my_dataset",
friendly_name="foo",
description="bar",
location="US")
event_driven_table = gcp.bigquery.Table("event_driven",
deletion_protection=False,
dataset_id=event_driven_dataset.dataset_id,
table_id="my_table",
schema="[{\"name\":\"name\",\"type\":\"STRING\"}]")
event_driven_config = gcp.bigquery.DataTransferConfig("event_driven_config",
display_name="my-event-driven-config",
location=event_driven_dataset.location,
data_source_id="google_cloud_storage",
destination_dataset_id=event_driven_dataset.dataset_id,
schedule_options_v2={
"event_driven_schedule": {
"pubsub_subscription": event_driven_subscription.id,
},
},
params={
"data_path_template": event_driven_bucket.url.apply(lambda url: f"{url}/*.json"),
"destination_table_name_template": event_driven_table.table_id,
"file_format": "JSON",
"write_disposition": "APPEND",
})
package main
import (
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/bigquery"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/pubsub"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
eventDriven, err := pubsub.NewTopic(ctx, "event_driven", &pubsub.TopicArgs{
Name: pulumi.String("my-topic"),
})
if err != nil {
return err
}
eventDrivenSubscription, err := pubsub.NewSubscription(ctx, "event_driven", &pubsub.SubscriptionArgs{
Name: pulumi.String("my-subscription"),
Topic: eventDriven.ID(),
})
if err != nil {
return err
}
eventDrivenBucket, err := storage.NewBucket(ctx, "event_driven", &storage.BucketArgs{
Name: pulumi.String("my-bucket"),
Location: pulumi.String("US"),
UniformBucketLevelAccess: pulumi.Bool(true),
ForceDestroy: pulumi.Bool(true),
})
if err != nil {
return err
}
eventDrivenDataset, err := bigquery.NewDataset(ctx, "event_driven", &bigquery.DatasetArgs{
DatasetId: pulumi.String("my_dataset"),
FriendlyName: pulumi.String("foo"),
Description: pulumi.String("bar"),
Location: pulumi.String("US"),
})
if err != nil {
return err
}
eventDrivenTable, err := bigquery.NewTable(ctx, "event_driven", &bigquery.TableArgs{
DeletionProtection: pulumi.Bool(false),
DatasetId: eventDrivenDataset.DatasetId,
TableId: pulumi.String("my_table"),
Schema: pulumi.String("[{\"name\":\"name\",\"type\":\"STRING\"}]"),
})
if err != nil {
return err
}
_, err = bigquery.NewDataTransferConfig(ctx, "event_driven_config", &bigquery.DataTransferConfigArgs{
DisplayName: pulumi.String("my-event-driven-config"),
Location: eventDrivenDataset.Location,
DataSourceId: pulumi.String("google_cloud_storage"),
DestinationDatasetId: eventDrivenDataset.DatasetId,
ScheduleOptionsV2: &bigquery.DataTransferConfigScheduleOptionsV2Args{
EventDrivenSchedule: &bigquery.DataTransferConfigScheduleOptionsV2EventDrivenScheduleArgs{
PubsubSubscription: eventDrivenSubscription.ID(),
},
},
Params: pulumi.StringMap{
"data_path_template": eventDrivenBucket.Url.ApplyT(func(url string) (string, error) {
return fmt.Sprintf("%v/*.json", url), nil
}).(pulumi.StringOutput),
"destination_table_name_template": eventDrivenTable.TableId,
"file_format": pulumi.String("JSON"),
"write_disposition": pulumi.String("APPEND"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var eventDriven = new Gcp.PubSub.Topic("event_driven", new()
{
Name = "my-topic",
});
var eventDrivenSubscription = new Gcp.PubSub.Subscription("event_driven", new()
{
Name = "my-subscription",
Topic = eventDriven.Id,
});
var eventDrivenBucket = new Gcp.Storage.Bucket("event_driven", new()
{
Name = "my-bucket",
Location = "US",
UniformBucketLevelAccess = true,
ForceDestroy = true,
});
var eventDrivenDataset = new Gcp.BigQuery.Dataset("event_driven", new()
{
DatasetId = "my_dataset",
FriendlyName = "foo",
Description = "bar",
Location = "US",
});
var eventDrivenTable = new Gcp.BigQuery.Table("event_driven", new()
{
DeletionProtection = false,
DatasetId = eventDrivenDataset.DatasetId,
TableId = "my_table",
Schema = "[{\"name\":\"name\",\"type\":\"STRING\"}]",
});
var eventDrivenConfig = new Gcp.BigQuery.DataTransferConfig("event_driven_config", new()
{
DisplayName = "my-event-driven-config",
Location = eventDrivenDataset.Location,
DataSourceId = "google_cloud_storage",
DestinationDatasetId = eventDrivenDataset.DatasetId,
ScheduleOptionsV2 = new Gcp.BigQuery.Inputs.DataTransferConfigScheduleOptionsV2Args
{
EventDrivenSchedule = new Gcp.BigQuery.Inputs.DataTransferConfigScheduleOptionsV2EventDrivenScheduleArgs
{
PubsubSubscription = eventDrivenSubscription.Id,
},
},
Params =
{
{ "data_path_template", eventDrivenBucket.Url.Apply(url => $"{url}/*.json") },
{ "destination_table_name_template", eventDrivenTable.TableId },
{ "file_format", "JSON" },
{ "write_disposition", "APPEND" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.pubsub.Topic;
import com.pulumi.gcp.pubsub.TopicArgs;
import com.pulumi.gcp.pubsub.Subscription;
import com.pulumi.gcp.pubsub.SubscriptionArgs;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.bigquery.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.bigquery.Table;
import com.pulumi.gcp.bigquery.TableArgs;
import com.pulumi.gcp.bigquery.DataTransferConfig;
import com.pulumi.gcp.bigquery.DataTransferConfigArgs;
import com.pulumi.gcp.bigquery.inputs.DataTransferConfigScheduleOptionsV2Args;
import com.pulumi.gcp.bigquery.inputs.DataTransferConfigScheduleOptionsV2EventDrivenScheduleArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var eventDriven = new Topic("eventDriven", TopicArgs.builder()
.name("my-topic")
.build());
var eventDrivenSubscription = new Subscription("eventDrivenSubscription", SubscriptionArgs.builder()
.name("my-subscription")
.topic(eventDriven.id())
.build());
var eventDrivenBucket = new Bucket("eventDrivenBucket", BucketArgs.builder()
.name("my-bucket")
.location("US")
.uniformBucketLevelAccess(true)
.forceDestroy(true)
.build());
var eventDrivenDataset = new Dataset("eventDrivenDataset", DatasetArgs.builder()
.datasetId("my_dataset")
.friendlyName("foo")
.description("bar")
.location("US")
.build());
var eventDrivenTable = new Table("eventDrivenTable", TableArgs.builder()
.deletionProtection(false)
.datasetId(eventDrivenDataset.datasetId())
.tableId("my_table")
.schema("[{\"name\":\"name\",\"type\":\"STRING\"}]")
.build());
var eventDrivenConfig = new DataTransferConfig("eventDrivenConfig", DataTransferConfigArgs.builder()
.displayName("my-event-driven-config")
.location(eventDrivenDataset.location())
.dataSourceId("google_cloud_storage")
.destinationDatasetId(eventDrivenDataset.datasetId())
.scheduleOptionsV2(DataTransferConfigScheduleOptionsV2Args.builder()
.eventDrivenSchedule(DataTransferConfigScheduleOptionsV2EventDrivenScheduleArgs.builder()
.pubsubSubscription(eventDrivenSubscription.id())
.build())
.build())
.params(Map.ofEntries(
Map.entry("data_path_template", eventDrivenBucket.url().applyValue(_url -> String.format("%s/*.json", _url))),
Map.entry("destination_table_name_template", eventDrivenTable.tableId()),
Map.entry("file_format", "JSON"),
Map.entry("write_disposition", "APPEND")
))
.build());
}
}
resources:
eventDriven:
type: gcp:pubsub:Topic
name: event_driven
properties:
name: my-topic
eventDrivenSubscription:
type: gcp:pubsub:Subscription
name: event_driven
properties:
name: my-subscription
topic: ${eventDriven.id}
eventDrivenBucket:
type: gcp:storage:Bucket
name: event_driven
properties:
name: my-bucket
location: US
uniformBucketLevelAccess: true
forceDestroy: true
eventDrivenDataset:
type: gcp:bigquery:Dataset
name: event_driven
properties:
datasetId: my_dataset
friendlyName: foo
description: bar
location: US
eventDrivenTable:
type: gcp:bigquery:Table
name: event_driven
properties:
deletionProtection: false
datasetId: ${eventDrivenDataset.datasetId}
tableId: my_table
schema: '[{"name":"name","type":"STRING"}]'
eventDrivenConfig:
type: gcp:bigquery:DataTransferConfig
name: event_driven_config
properties:
displayName: my-event-driven-config
location: ${eventDrivenDataset.location}
dataSourceId: google_cloud_storage
destinationDatasetId: ${eventDrivenDataset.datasetId}
scheduleOptionsV2:
eventDrivenSchedule:
pubsubSubscription: ${eventDrivenSubscription.id}
params:
data_path_template: ${eventDrivenBucket.url}/*.json
destination_table_name_template: ${eventDrivenTable.tableId}
file_format: JSON
write_disposition: APPEND
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_pubsub_topic" "event_driven" {
lifecycle {
create_before_destroy = true
}
name = "my-topic"
}
resource "gcp_pubsub_subscription" "event_driven" {
lifecycle {
create_before_destroy = true
}
name = "my-subscription"
topic = gcp_pubsub_topic.event_driven.id
}
resource "gcp_storage_bucket" "event_driven" {
lifecycle {
create_before_destroy = true
}
name = "my-bucket"
location = "US"
uniform_bucket_level_access = true
force_destroy = true
}
resource "gcp_bigquery_dataset" "event_driven" {
lifecycle {
create_before_destroy = true
}
dataset_id = "my_dataset"
friendly_name = "foo"
description = "bar"
location = "US"
}
resource "gcp_bigquery_table" "event_driven" {
lifecycle {
create_before_destroy = true
}
deletion_protection = false
dataset_id = gcp_bigquery_dataset.event_driven.dataset_id
table_id = "my_table"
schema = "[{\"name\":\"name\",\"type\":\"STRING\"}]"
}
resource "gcp_bigquery_data_transfer_config" "event_driven_config" {
lifecycle {
create_before_destroy = true
}
display_name = "my-event-driven-config"
location = gcp_bigquery_dataset.event_driven.location
data_source_id = "google_cloud_storage"
destination_dataset_id = gcp_bigquery_dataset.event_driven.dataset_id
schedule_options_v2 = {
event_driven_schedule = {
pubsub_subscription = gcp_pubsub_subscription.event_driven.id
}
}
params = {
"data_path_template" ="${gcp_storage_bucket.event_driven.url}/*.json"
"destination_table_name_template" = gcp_bigquery_table.event_driven.table_id
"file_format" = "JSON"
"write_disposition" = "APPEND"
}
}
Create DataTransferConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataTransferConfig(name: string, args: DataTransferConfigArgs, opts?: CustomResourceOptions);@overload
def DataTransferConfig(resource_name: str,
args: DataTransferConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DataTransferConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
data_source_id: Optional[str] = None,
params: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
deletion_policy: Optional[str] = None,
destination_dataset_id: Optional[str] = None,
email_preferences: Optional[DataTransferConfigEmailPreferencesArgs] = None,
encryption_configuration: Optional[DataTransferConfigEncryptionConfigurationArgs] = None,
data_refresh_window_days: Optional[int] = None,
notification_pubsub_topic: Optional[str] = None,
disabled: Optional[bool] = None,
project: Optional[str] = None,
schedule: Optional[str] = None,
schedule_options: Optional[DataTransferConfigScheduleOptionsArgs] = None,
schedule_options_v2: Optional[DataTransferConfigScheduleOptionsV2Args] = None,
sensitive_params: Optional[DataTransferConfigSensitiveParamsArgs] = None,
service_account_name: Optional[str] = None)func NewDataTransferConfig(ctx *Context, name string, args DataTransferConfigArgs, opts ...ResourceOption) (*DataTransferConfig, error)public DataTransferConfig(string name, DataTransferConfigArgs args, CustomResourceOptions? opts = null)
public DataTransferConfig(String name, DataTransferConfigArgs args)
public DataTransferConfig(String name, DataTransferConfigArgs args, CustomResourceOptions options)
type: gcp:bigquery:DataTransferConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "gcp_bigquery_data_transfer_config" "name" {
# resource properties
}Parameters
- 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.
- args DataTransferConfigArgs
- 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 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.
- name String
- The unique name of the resource.
- args DataTransferConfigArgs
- 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 dataTransferConfigResource = new Gcp.BigQuery.DataTransferConfig("dataTransferConfigResource", new()
{
DisplayName = "string",
DataSourceId = "string",
Params =
{
{ "string", "string" },
},
Location = "string",
DeletionPolicy = "string",
DestinationDatasetId = "string",
EmailPreferences = new Gcp.BigQuery.Inputs.DataTransferConfigEmailPreferencesArgs
{
EnableFailureEmail = false,
},
EncryptionConfiguration = new Gcp.BigQuery.Inputs.DataTransferConfigEncryptionConfigurationArgs
{
KmsKeyName = "string",
},
DataRefreshWindowDays = 0,
NotificationPubsubTopic = "string",
Disabled = false,
Project = "string",
Schedule = "string",
ScheduleOptions = new Gcp.BigQuery.Inputs.DataTransferConfigScheduleOptionsArgs
{
DisableAutoScheduling = false,
EndTime = "string",
StartTime = "string",
},
ScheduleOptionsV2 = new Gcp.BigQuery.Inputs.DataTransferConfigScheduleOptionsV2Args
{
EventDrivenSchedule = new Gcp.BigQuery.Inputs.DataTransferConfigScheduleOptionsV2EventDrivenScheduleArgs
{
PubsubSubscription = "string",
},
},
SensitiveParams = new Gcp.BigQuery.Inputs.DataTransferConfigSensitiveParamsArgs
{
SecretAccessKey = "string",
SecretAccessKeyWo = "string",
SecretAccessKeyWoVersion = "string",
},
ServiceAccountName = "string",
});
example, err := bigquery.NewDataTransferConfig(ctx, "dataTransferConfigResource", &bigquery.DataTransferConfigArgs{
DisplayName: pulumi.String("string"),
DataSourceId: pulumi.String("string"),
Params: pulumi.StringMap{
"string": pulumi.String("string"),
},
Location: pulumi.String("string"),
DeletionPolicy: pulumi.String("string"),
DestinationDatasetId: pulumi.String("string"),
EmailPreferences: &bigquery.DataTransferConfigEmailPreferencesArgs{
EnableFailureEmail: pulumi.Bool(false),
},
EncryptionConfiguration: &bigquery.DataTransferConfigEncryptionConfigurationArgs{
KmsKeyName: pulumi.String("string"),
},
DataRefreshWindowDays: pulumi.Int(0),
NotificationPubsubTopic: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Project: pulumi.String("string"),
Schedule: pulumi.String("string"),
ScheduleOptions: &bigquery.DataTransferConfigScheduleOptionsArgs{
DisableAutoScheduling: pulumi.Bool(false),
EndTime: pulumi.String("string"),
StartTime: pulumi.String("string"),
},
ScheduleOptionsV2: &bigquery.DataTransferConfigScheduleOptionsV2Args{
EventDrivenSchedule: &bigquery.DataTransferConfigScheduleOptionsV2EventDrivenScheduleArgs{
PubsubSubscription: pulumi.String("string"),
},
},
SensitiveParams: &bigquery.DataTransferConfigSensitiveParamsArgs{
SecretAccessKey: pulumi.String("string"),
SecretAccessKeyWo: pulumi.String("string"),
SecretAccessKeyWoVersion: pulumi.String("string"),
},
ServiceAccountName: pulumi.String("string"),
})
resource "gcp_bigquery_data_transfer_config" "dataTransferConfigResource" {
lifecycle {
create_before_destroy = true
}
display_name = "string"
data_source_id = "string"
params = {
"string" = "string"
}
location = "string"
deletion_policy = "string"
destination_dataset_id = "string"
email_preferences = {
enable_failure_email = false
}
encryption_configuration = {
kms_key_name = "string"
}
data_refresh_window_days = 0
notification_pubsub_topic = "string"
disabled = false
project = "string"
schedule = "string"
schedule_options = {
disable_auto_scheduling = false
end_time = "string"
start_time = "string"
}
schedule_options_v2 = {
event_driven_schedule = {
pubsub_subscription = "string"
}
}
sensitive_params = {
secret_access_key = "string"
secret_access_key_wo = "string"
secret_access_key_wo_version = "string"
}
service_account_name = "string"
}
var dataTransferConfigResource = new DataTransferConfig("dataTransferConfigResource", DataTransferConfigArgs.builder()
.displayName("string")
.dataSourceId("string")
.params(Map.of("string", "string"))
.location("string")
.deletionPolicy("string")
.destinationDatasetId("string")
.emailPreferences(DataTransferConfigEmailPreferencesArgs.builder()
.enableFailureEmail(false)
.build())
.encryptionConfiguration(DataTransferConfigEncryptionConfigurationArgs.builder()
.kmsKeyName("string")
.build())
.dataRefreshWindowDays(0)
.notificationPubsubTopic("string")
.disabled(false)
.project("string")
.schedule("string")
.scheduleOptions(DataTransferConfigScheduleOptionsArgs.builder()
.disableAutoScheduling(false)
.endTime("string")
.startTime("string")
.build())
.scheduleOptionsV2(DataTransferConfigScheduleOptionsV2Args.builder()
.eventDrivenSchedule(DataTransferConfigScheduleOptionsV2EventDrivenScheduleArgs.builder()
.pubsubSubscription("string")
.build())
.build())
.sensitiveParams(DataTransferConfigSensitiveParamsArgs.builder()
.secretAccessKey("string")
.secretAccessKeyWo("string")
.secretAccessKeyWoVersion("string")
.build())
.serviceAccountName("string")
.build());
data_transfer_config_resource = gcp.bigquery.DataTransferConfig("dataTransferConfigResource",
display_name="string",
data_source_id="string",
params={
"string": "string",
},
location="string",
deletion_policy="string",
destination_dataset_id="string",
email_preferences={
"enable_failure_email": False,
},
encryption_configuration={
"kms_key_name": "string",
},
data_refresh_window_days=0,
notification_pubsub_topic="string",
disabled=False,
project="string",
schedule="string",
schedule_options={
"disable_auto_scheduling": False,
"end_time": "string",
"start_time": "string",
},
schedule_options_v2={
"event_driven_schedule": {
"pubsub_subscription": "string",
},
},
sensitive_params={
"secret_access_key": "string",
"secret_access_key_wo": "string",
"secret_access_key_wo_version": "string",
},
service_account_name="string")
const dataTransferConfigResource = new gcp.bigquery.DataTransferConfig("dataTransferConfigResource", {
displayName: "string",
dataSourceId: "string",
params: {
string: "string",
},
location: "string",
deletionPolicy: "string",
destinationDatasetId: "string",
emailPreferences: {
enableFailureEmail: false,
},
encryptionConfiguration: {
kmsKeyName: "string",
},
dataRefreshWindowDays: 0,
notificationPubsubTopic: "string",
disabled: false,
project: "string",
schedule: "string",
scheduleOptions: {
disableAutoScheduling: false,
endTime: "string",
startTime: "string",
},
scheduleOptionsV2: {
eventDrivenSchedule: {
pubsubSubscription: "string",
},
},
sensitiveParams: {
secretAccessKey: "string",
secretAccessKeyWo: "string",
secretAccessKeyWoVersion: "string",
},
serviceAccountName: "string",
});
type: gcp:bigquery:DataTransferConfig
properties:
dataRefreshWindowDays: 0
dataSourceId: string
deletionPolicy: string
destinationDatasetId: string
disabled: false
displayName: string
emailPreferences:
enableFailureEmail: false
encryptionConfiguration:
kmsKeyName: string
location: string
notificationPubsubTopic: string
params:
string: string
project: string
schedule: string
scheduleOptions:
disableAutoScheduling: false
endTime: string
startTime: string
scheduleOptionsV2:
eventDrivenSchedule:
pubsubSubscription: string
sensitiveParams:
secretAccessKey: string
secretAccessKeyWo: string
secretAccessKeyWoVersion: string
serviceAccountName: string
DataTransferConfig 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 DataTransferConfig resource accepts the following input properties:
- Data
Source stringId - The data source id. Cannot be changed once the transfer config is created.
- Display
Name string - The user specified display name for the transfer config.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- Data
Refresh intWindow Days - 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.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- Destination
Dataset stringId - The BigQuery target dataset id.
- Disabled bool
- When set to true, no runs are scheduled for a given transfer.
- Email
Preferences DataTransfer Config Email Preferences - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- Encryption
Configuration DataTransfer Config Encryption Configuration - Represents the encryption configuration for a transfer. Structure is documented below.
- Location string
- The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
- Notification
Pubsub stringTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- Schedule
Options DataTransfer Config Schedule Options - Options customizing the data transfer schedule. Structure is documented below.
- Schedule
Options DataV2 Transfer Config Schedule Options V2 - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - Sensitive
Params DataTransfer Config Sensitive Params - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - Service
Account stringName - Service account email. 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 stringId - The data source id. Cannot be changed once the transfer config is created.
- Display
Name string - The user specified display name for the transfer config.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- Data
Refresh intWindow Days - 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.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- Destination
Dataset stringId - The BigQuery target dataset id.
- Disabled bool
- When set to true, no runs are scheduled for a given transfer.
- Email
Preferences DataTransfer Config Email Preferences Args - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- Encryption
Configuration DataTransfer Config Encryption Configuration Args - Represents the encryption configuration for a transfer. Structure is documented below.
- Location string
- The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
- Notification
Pubsub stringTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- Schedule
Options DataTransfer Config Schedule Options Args - Options customizing the data transfer schedule. Structure is documented below.
- Schedule
Options DataV2 Transfer Config Schedule Options V2Args - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - Sensitive
Params DataTransfer Config Sensitive Params Args - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - Service
Account stringName - Service account email. 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_ stringid - The data source id. Cannot be changed once the transfer config is created.
- display_
name string - The user specified display name for the transfer config.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- data_
refresh_ numberwindow_ days - 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.
- deletion_
policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination_
dataset_ stringid - The BigQuery target dataset id.
- disabled bool
- When set to true, no runs are scheduled for a given transfer.
- email_
preferences object - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- encryption_
configuration object - Represents the encryption configuration for a transfer. Structure is documented below.
- location string
- The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
- notification_
pubsub_ stringtopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- schedule_
options object - Options customizing the data transfer schedule. Structure is documented below.
- schedule_
options_ objectv2 - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - sensitive_
params object - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - service_
account_ stringname - Service account email. 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 StringId - The data source id. Cannot be changed once the transfer config is created.
- display
Name String - The user specified display name for the transfer config.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- data
Refresh IntegerWindow Days - 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.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset StringId - The BigQuery target dataset id.
- disabled Boolean
- When set to true, no runs are scheduled for a given transfer.
- email
Preferences DataTransfer Config Email Preferences - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- encryption
Configuration DataTransfer Config Encryption Configuration - Represents the encryption configuration for a transfer. Structure is documented below.
- location String
- The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
- notification
Pubsub StringTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- schedule
Options DataTransfer Config Schedule Options - Options customizing the data transfer schedule. Structure is documented below.
- schedule
Options DataV2 Transfer Config Schedule Options V2 - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - sensitive
Params DataTransfer Config Sensitive Params - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - service
Account StringName - Service account email. 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 stringId - The data source id. Cannot be changed once the transfer config is created.
- display
Name string - The user specified display name for the transfer config.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- data
Refresh numberWindow Days - 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.
- deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset stringId - The BigQuery target dataset id.
- disabled boolean
- When set to true, no runs are scheduled for a given transfer.
- email
Preferences DataTransfer Config Email Preferences - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- encryption
Configuration DataTransfer Config Encryption Configuration - Represents the encryption configuration for a transfer. Structure is documented below.
- location string
- The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
- notification
Pubsub stringTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- schedule
Options DataTransfer Config Schedule Options - Options customizing the data transfer schedule. Structure is documented below.
- schedule
Options DataV2 Transfer Config Schedule Options V2 - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - sensitive
Params DataTransfer Config Sensitive Params - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - service
Account stringName - Service account email. 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_ strid - The data source id. Cannot be changed once the transfer config is created.
- display_
name str - The user specified display name for the transfer config.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- data_
refresh_ intwindow_ days - 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.
- deletion_
policy str - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination_
dataset_ strid - The BigQuery target dataset id.
- disabled bool
- When set to true, no runs are scheduled for a given transfer.
- email_
preferences DataTransfer Config Email Preferences Args - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- encryption_
configuration DataTransfer Config Encryption Configuration Args - Represents the encryption configuration for a transfer. Structure is documented below.
- location str
- The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
- notification_
pubsub_ strtopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- schedule_
options DataTransfer Config Schedule Options Args - Options customizing the data transfer schedule. Structure is documented below.
- schedule_
options_ Datav2 Transfer Config Schedule Options V2Args - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - sensitive_
params DataTransfer Config Sensitive Params Args - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - service_
account_ strname - Service account email. 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 StringId - The data source id. Cannot be changed once the transfer config is created.
- display
Name String - The user specified display name for the transfer config.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- data
Refresh NumberWindow Days - 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.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset StringId - The BigQuery target dataset id.
- disabled Boolean
- When set to true, no runs are scheduled for a given transfer.
- email
Preferences Property Map - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- encryption
Configuration Property Map - Represents the encryption configuration for a transfer. Structure is documented below.
- location String
- The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
- notification
Pubsub StringTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- schedule
Options Property Map - Options customizing the data transfer schedule. Structure is documented below.
- schedule
Options Property MapV2 - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - sensitive
Params Property Map - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - service
Account StringName - Service account email. 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} or projects/{projectId}/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} or projects/{projectId}/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} or projects/{projectId}/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} or projects/{projectId}/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} or projects/{projectId}/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} or projects/{projectId}/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} or projects/{projectId}/transferConfigs/{configId}, where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
Look up 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@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
data_refresh_window_days: Optional[int] = None,
data_source_id: Optional[str] = None,
deletion_policy: Optional[str] = None,
destination_dataset_id: Optional[str] = None,
disabled: Optional[bool] = None,
display_name: Optional[str] = None,
email_preferences: Optional[DataTransferConfigEmailPreferencesArgs] = None,
encryption_configuration: Optional[DataTransferConfigEncryptionConfigurationArgs] = 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[DataTransferConfigScheduleOptionsArgs] = None,
schedule_options_v2: Optional[DataTransferConfigScheduleOptionsV2Args] = None,
sensitive_params: Optional[DataTransferConfigSensitiveParamsArgs] = None,
service_account_name: Optional[str] = None) -> DataTransferConfigfunc 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)public static DataTransferConfig get(String name, Output<String> id, DataTransferConfigState state, CustomResourceOptions options)resources: existingDataTransferConfig: type: gcp:bigquery:DataTransferConfig get: id: ${id}import {
to = gcp_bigquery_data_transfer_config.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state DataTransferConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state DataTransferConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state DataTransferConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state DataTransferConfigState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Data
Refresh intWindow Days - 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 stringId - The data source id. Cannot be changed once the transfer config is created.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- Destination
Dataset stringId - The BigQuery target dataset id.
- Disabled bool
- When set to true, no runs are scheduled for a given transfer.
- Display
Name string - The user specified display name for the transfer config.
- Email
Preferences DataTransfer Config Email Preferences - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- Encryption
Configuration DataTransfer Config Encryption Configuration - Represents the encryption configuration for a transfer. Structure is documented below.
- 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} or projects/{projectId}/transferConfigs/{configId}, where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
- Notification
Pubsub stringTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- Schedule
Options DataTransfer Config Schedule Options - Options customizing the data transfer schedule. Structure is documented below.
- Schedule
Options DataV2 Transfer Config Schedule Options V2 - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - Sensitive
Params DataTransfer Config Sensitive Params - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - Service
Account stringName - Service account email. 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 intWindow Days - 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 stringId - The data source id. Cannot be changed once the transfer config is created.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- Destination
Dataset stringId - The BigQuery target dataset id.
- Disabled bool
- When set to true, no runs are scheduled for a given transfer.
- Display
Name string - The user specified display name for the transfer config.
- Email
Preferences DataTransfer Config Email Preferences Args - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- Encryption
Configuration DataTransfer Config Encryption Configuration Args - Represents the encryption configuration for a transfer. Structure is documented below.
- 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} or projects/{projectId}/transferConfigs/{configId}, where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
- Notification
Pubsub stringTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- Schedule
Options DataTransfer Config Schedule Options Args - Options customizing the data transfer schedule. Structure is documented below.
- Schedule
Options DataV2 Transfer Config Schedule Options V2Args - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - Sensitive
Params DataTransfer Config Sensitive Params Args - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - Service
Account stringName - Service account email. 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_ numberwindow_ days - 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_ stringid - The data source id. Cannot be changed once the transfer config is created.
- deletion_
policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination_
dataset_ stringid - The BigQuery target dataset id.
- disabled bool
- When set to true, no runs are scheduled for a given transfer.
- display_
name string - The user specified display name for the transfer config.
- email_
preferences object - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- encryption_
configuration object - Represents the encryption configuration for a transfer. Structure is documented below.
- 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} or projects/{projectId}/transferConfigs/{configId}, where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
- notification_
pubsub_ stringtopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- schedule_
options object - Options customizing the data transfer schedule. Structure is documented below.
- schedule_
options_ objectv2 - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - sensitive_
params object - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - service_
account_ stringname - Service account email. 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 IntegerWindow Days - 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 StringId - The data source id. Cannot be changed once the transfer config is created.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset StringId - The BigQuery target dataset id.
- disabled Boolean
- When set to true, no runs are scheduled for a given transfer.
- display
Name String - The user specified display name for the transfer config.
- email
Preferences DataTransfer Config Email Preferences - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- encryption
Configuration DataTransfer Config Encryption Configuration - Represents the encryption configuration for a transfer. Structure is documented below.
- 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} or projects/{projectId}/transferConfigs/{configId}, where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
- notification
Pubsub StringTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- schedule
Options DataTransfer Config Schedule Options - Options customizing the data transfer schedule. Structure is documented below.
- schedule
Options DataV2 Transfer Config Schedule Options V2 - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - sensitive
Params DataTransfer Config Sensitive Params - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - service
Account StringName - Service account email. 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 numberWindow Days - 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 stringId - The data source id. Cannot be changed once the transfer config is created.
- deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset stringId - The BigQuery target dataset id.
- disabled boolean
- When set to true, no runs are scheduled for a given transfer.
- display
Name string - The user specified display name for the transfer config.
- email
Preferences DataTransfer Config Email Preferences - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- encryption
Configuration DataTransfer Config Encryption Configuration - Represents the encryption configuration for a transfer. Structure is documented below.
- 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} or projects/{projectId}/transferConfigs/{configId}, where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
- notification
Pubsub stringTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- schedule
Options DataTransfer Config Schedule Options - Options customizing the data transfer schedule. Structure is documented below.
- schedule
Options DataV2 Transfer Config Schedule Options V2 - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - sensitive
Params DataTransfer Config Sensitive Params - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - service
Account stringName - Service account email. 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_ intwindow_ days - 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_ strid - The data source id. Cannot be changed once the transfer config is created.
- deletion_
policy str - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination_
dataset_ strid - 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.
- email_
preferences DataTransfer Config Email Preferences Args - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- encryption_
configuration DataTransfer Config Encryption Configuration Args - Represents the encryption configuration for a transfer. Structure is documented below.
- 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} or projects/{projectId}/transferConfigs/{configId}, where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
- notification_
pubsub_ strtopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- schedule_
options DataTransfer Config Schedule Options Args - Options customizing the data transfer schedule. Structure is documented below.
- schedule_
options_ Datav2 Transfer Config Schedule Options V2Args - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - sensitive_
params DataTransfer Config Sensitive Params Args - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - service_
account_ strname - Service account email. 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 NumberWindow Days - 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 StringId - The data source id. Cannot be changed once the transfer config is created.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
- destination
Dataset StringId - The BigQuery target dataset id.
- disabled Boolean
- When set to true, no runs are scheduled for a given transfer.
- display
Name String - The user specified display name for the transfer config.
- email
Preferences Property Map - Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. Structure is documented below.
- encryption
Configuration Property Map - Represents the encryption configuration for a transfer. Structure is documented below.
- 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} or projects/{projectId}/transferConfigs/{configId}, where configId is usually a uuid, but this is not required. The name is ignored when creating a transfer config.
- notification
Pubsub StringTopic - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
- 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 NOTE : If you are attempting to update a parameter that cannot be updated (due to api limitations) please force recreation of the resource.
- 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- schedule
Options Property Map - Options customizing the data transfer schedule. Structure is documented below.
- schedule
Options Property MapV2 - Options customizing the type of data transfer schedule.
Only the event-driven schedule is exposed here; time-based and manual
schedules are configured through the
scheduleandscheduleOptionsfields instead. This field cannot be used together withscheduleorscheduleOptions. Structure is documented below. - sensitive
Params Property Map - Different parameters are configured primarily using the the
paramsfield on this resource. This block contains the parameters which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key in theparamsmap in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below. - service
Account StringName - Service account email. 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.
Supporting Types
DataTransferConfigEmailPreferences, DataTransferConfigEmailPreferencesArgs
- Enable
Failure boolEmail - If true, email notifications will be sent on transfer run failures.
- Enable
Failure boolEmail - If true, email notifications will be sent on transfer run failures.
- enable_
failure_ boolemail - If true, email notifications will be sent on transfer run failures.
- enable
Failure BooleanEmail - If true, email notifications will be sent on transfer run failures.
- enable
Failure booleanEmail - If true, email notifications will be sent on transfer run failures.
- enable_
failure_ boolemail - If true, email notifications will be sent on transfer run failures.
- enable
Failure BooleanEmail - If true, email notifications will be sent on transfer run failures.
DataTransferConfigEncryptionConfiguration, DataTransferConfigEncryptionConfigurationArgs
- Kms
Key stringName - The name of the KMS key used for encrypting BigQuery data.
- Kms
Key stringName - The name of the KMS key used for encrypting BigQuery data.
- kms_
key_ stringname - The name of the KMS key used for encrypting BigQuery data.
- kms
Key StringName - The name of the KMS key used for encrypting BigQuery data.
- kms
Key stringName - The name of the KMS key used for encrypting BigQuery data.
- kms_
key_ strname - The name of the KMS key used for encrypting BigQuery data.
- kms
Key StringName - The name of the KMS key used for encrypting BigQuery data.
DataTransferConfigScheduleOptions, DataTransferConfigScheduleOptionsArgs
- Disable
Auto boolScheduling - If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using transferConfigs.startManualRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
- End
Time 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 triggered manually is not limited by this option.
The
scheduleOptionsV2block supports:- Start
Time 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 triggered manually is not limited by this option.
- Disable
Auto boolScheduling - If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using transferConfigs.startManualRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
- End
Time 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 triggered manually is not limited by this option.
The
scheduleOptionsV2block supports:- Start
Time 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 triggered manually is not limited by this option.
- disable_
auto_ boolscheduling - If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using transferConfigs.startManualRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
- end_
time 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 triggered manually is not limited by this option.
The
scheduleOptionsV2block supports:- start_
time 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 triggered manually is not limited by this option.
- disable
Auto BooleanScheduling - If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using transferConfigs.startManualRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
- end
Time 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 triggered manually is not limited by this option.
The
scheduleOptionsV2block supports:- start
Time 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 triggered manually is not limited by this option.
- disable
Auto booleanScheduling - If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using transferConfigs.startManualRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
- end
Time 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 triggered manually is not limited by this option.
The
scheduleOptionsV2block supports:- start
Time 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 triggered manually is not limited by this option.
- disable_
auto_ boolscheduling - If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using transferConfigs.startManualRuns 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 triggered manually is not limited by this option.
The
scheduleOptionsV2block supports:- 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 triggered manually is not limited by this option.
- disable
Auto BooleanScheduling - If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using transferConfigs.startManualRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
- end
Time 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 triggered manually is not limited by this option.
The
scheduleOptionsV2block supports:- start
Time 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 triggered manually is not limited by this option.
DataTransferConfigScheduleOptionsV2, DataTransferConfigScheduleOptionsV2Args
- Event
Driven DataSchedule Transfer Config Schedule Options V2Event Driven Schedule - Event-driven transfer schedule options. If set, the transfer will be scheduled upon events arriving.
- Event
Driven DataSchedule Transfer Config Schedule Options V2Event Driven Schedule - Event-driven transfer schedule options. If set, the transfer will be scheduled upon events arriving.
- event_
driven_ objectschedule - Event-driven transfer schedule options. If set, the transfer will be scheduled upon events arriving.
- event
Driven DataSchedule Transfer Config Schedule Options V2Event Driven Schedule - Event-driven transfer schedule options. If set, the transfer will be scheduled upon events arriving.
- event
Driven DataSchedule Transfer Config Schedule Options V2Event Driven Schedule - Event-driven transfer schedule options. If set, the transfer will be scheduled upon events arriving.
- event_
driven_ Dataschedule Transfer Config Schedule Options V2Event Driven Schedule - Event-driven transfer schedule options. If set, the transfer will be scheduled upon events arriving.
- event
Driven Property MapSchedule - Event-driven transfer schedule options. If set, the transfer will be scheduled upon events arriving.
DataTransferConfigScheduleOptionsV2EventDrivenSchedule, DataTransferConfigScheduleOptionsV2EventDrivenScheduleArgs
- Pubsub
Subscription string - Pub/Sub subscription name used to receive events. Only the Google Cloud Storage data source supports this option. Format: projects/{project}/subscriptions/{subscription}.
- Pubsub
Subscription string - Pub/Sub subscription name used to receive events. Only the Google Cloud Storage data source supports this option. Format: projects/{project}/subscriptions/{subscription}.
- pubsub_
subscription string - Pub/Sub subscription name used to receive events. Only the Google Cloud Storage data source supports this option. Format: projects/{project}/subscriptions/{subscription}.
- pubsub
Subscription String - Pub/Sub subscription name used to receive events. Only the Google Cloud Storage data source supports this option. Format: projects/{project}/subscriptions/{subscription}.
- pubsub
Subscription string - Pub/Sub subscription name used to receive events. Only the Google Cloud Storage data source supports this option. Format: projects/{project}/subscriptions/{subscription}.
- pubsub_
subscription str - Pub/Sub subscription name used to receive events. Only the Google Cloud Storage data source supports this option. Format: projects/{project}/subscriptions/{subscription}.
- pubsub
Subscription String - Pub/Sub subscription name used to receive events. Only the Google Cloud Storage data source supports this option. Format: projects/{project}/subscriptions/{subscription}.
DataTransferConfigSensitiveParams, DataTransferConfigSensitiveParamsArgs
- Secret
Access stringKey - The Secret Access Key of the AWS account transferring data from. Note: This property is sensitive and will not be displayed in the plan.
- Secret
Access stringKey Wo NOTE: This field is write-only and its value will not be updated in state as part of read operations. (Optional, Write-Only) The Secret Access Key of the AWS account transferring data from. Note: This property is write-only and will not be read from the API.
Note: One of
secretAccessKeyorsecretAccessKeyWocan only be set.- Secret
Access stringKey Wo Version - Triggers update of
secretAccessKeyWowrite-only. Increment this value when an update tosecretAccessKeyWois needed. For more info see updating write-only arguments
- Secret
Access stringKey - The Secret Access Key of the AWS account transferring data from. Note: This property is sensitive and will not be displayed in the plan.
- Secret
Access stringKey Wo NOTE: This field is write-only and its value will not be updated in state as part of read operations. (Optional, Write-Only) The Secret Access Key of the AWS account transferring data from. Note: This property is write-only and will not be read from the API.
Note: One of
secretAccessKeyorsecretAccessKeyWocan only be set.- Secret
Access stringKey Wo Version - Triggers update of
secretAccessKeyWowrite-only. Increment this value when an update tosecretAccessKeyWois needed. For more info see updating write-only arguments
- secret_
access_ stringkey - The Secret Access Key of the AWS account transferring data from. Note: This property is sensitive and will not be displayed in the plan.
- secret_
access_ stringkey_ wo NOTE: This field is write-only and its value will not be updated in state as part of read operations. (Optional, Write-Only) The Secret Access Key of the AWS account transferring data from. Note: This property is write-only and will not be read from the API.
Note: One of
secretAccessKeyorsecretAccessKeyWocan only be set.- secret_
access_ stringkey_ wo_ version - Triggers update of
secretAccessKeyWowrite-only. Increment this value when an update tosecretAccessKeyWois needed. For more info see updating write-only arguments
- secret
Access StringKey - The Secret Access Key of the AWS account transferring data from. Note: This property is sensitive and will not be displayed in the plan.
- secret
Access StringKey Wo NOTE: This field is write-only and its value will not be updated in state as part of read operations. (Optional, Write-Only) The Secret Access Key of the AWS account transferring data from. Note: This property is write-only and will not be read from the API.
Note: One of
secretAccessKeyorsecretAccessKeyWocan only be set.- secret
Access StringKey Wo Version - Triggers update of
secretAccessKeyWowrite-only. Increment this value when an update tosecretAccessKeyWois needed. For more info see updating write-only arguments
- secret
Access stringKey - The Secret Access Key of the AWS account transferring data from. Note: This property is sensitive and will not be displayed in the plan.
- secret
Access stringKey Wo NOTE: This field is write-only and its value will not be updated in state as part of read operations. (Optional, Write-Only) The Secret Access Key of the AWS account transferring data from. Note: This property is write-only and will not be read from the API.
Note: One of
secretAccessKeyorsecretAccessKeyWocan only be set.- secret
Access stringKey Wo Version - Triggers update of
secretAccessKeyWowrite-only. Increment this value when an update tosecretAccessKeyWois needed. For more info see updating write-only arguments
- secret_
access_ strkey - The Secret Access Key of the AWS account transferring data from. Note: This property is sensitive and will not be displayed in the plan.
- secret_
access_ strkey_ wo NOTE: This field is write-only and its value will not be updated in state as part of read operations. (Optional, Write-Only) The Secret Access Key of the AWS account transferring data from. Note: This property is write-only and will not be read from the API.
Note: One of
secretAccessKeyorsecretAccessKeyWocan only be set.- secret_
access_ strkey_ wo_ version - Triggers update of
secretAccessKeyWowrite-only. Increment this value when an update tosecretAccessKeyWois needed. For more info see updating write-only arguments
- secret
Access StringKey - The Secret Access Key of the AWS account transferring data from. Note: This property is sensitive and will not be displayed in the plan.
- secret
Access StringKey Wo NOTE: This field is write-only and its value will not be updated in state as part of read operations. (Optional, Write-Only) The Secret Access Key of the AWS account transferring data from. Note: This property is write-only and will not be read from the API.
Note: One of
secretAccessKeyorsecretAccessKeyWocan only be set.- secret
Access StringKey Wo Version - Triggers update of
secretAccessKeyWowrite-only. Increment this value when an update tosecretAccessKeyWois needed. For more info see updating write-only arguments
Import
Config can be imported using any of these accepted formats:
{{project}}/{{name}}{{project}} {{name}}{{name}}
When using the pulumi import command, Config can be imported using one of the formats above. For example:
$ pulumi import gcp:bigquery/dataTransferConfig:DataTransferConfig default {{project}}/{{name}}
$ terraform import google_bigquery_data_transfer_config.default "{{project}} {{name}}"
$ pulumi import gcp:bigquery/dataTransferConfig:DataTransferConfig default {{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
published on Wednesday, Nov 18, 2026 by Pulumi