Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Google Cloud (GCP)
  4. API Docs
  5. bigquery
  6. DataTransferDataSourceEnrollment
Viewing docs for Google Cloud v10.2.0
published on Tuesday, Oct 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.bigquery.DataTransferDataSourceEnrollment

gcp logo
Viewing docs for Google Cloud v10.2.0
published on Tuesday, Oct 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    Enrolls a BigQuery Data Transfer Service data source in a project, making it available for use by gcp.bigquery.DataTransferConfig. Some data sources, notably Google Cloud Carbon Footprint exports, must be enrolled before a transfer config can be created against them.

    Enrollment is project-wide: a data source enrolled in a project is available in every location that offers it.

    Enrollment is eventually consistent, so a newly created or recreated enrollment may briefly read as absent before it settles.

    To get more information about DataSourceEnrollment, see:

    Example Usage

    Bigquerydatatransfer Data Source Enrollment Carbon

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const carbon = new gcp.bigquery.DataTransferDataSourceEnrollment("carbon", {
    project: "my-project-name",
    dataSourceId: "61cede5a-0000-2440-ad42-883d24f8f7b8",
    unenrollLocation: "us",
});

    import pulumi
import pulumi_gcp as gcp

carbon = gcp.bigquery.DataTransferDataSourceEnrollment("carbon",
    project="my-project-name",
    data_source_id="61cede5a-0000-2440-ad42-883d24f8f7b8",
    unenroll_location="us")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigquery.NewDataTransferDataSourceEnrollment(ctx, "carbon", &bigquery.DataTransferDataSourceEnrollmentArgs{
			Project:          pulumi.String("my-project-name"),
			DataSourceId:     pulumi.String("61cede5a-0000-2440-ad42-883d24f8f7b8"),
			UnenrollLocation: pulumi.String("us"),
		})
		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 carbon = new Gcp.BigQuery.DataTransferDataSourceEnrollment("carbon", new()
    {
        Project = "my-project-name",
        DataSourceId = "61cede5a-0000-2440-ad42-883d24f8f7b8",
        UnenrollLocation = "us",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigquery.DataTransferDataSourceEnrollment;
import com.pulumi.gcp.bigquery.DataTransferDataSourceEnrollmentArgs;
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 carbon = new DataTransferDataSourceEnrollment("carbon", DataTransferDataSourceEnrollmentArgs.builder()
            .project("my-project-name")
            .dataSourceId("61cede5a-0000-2440-ad42-883d24f8f7b8")
            .unenrollLocation("us")
            .build());

    }
}

    resources:
  carbon:
    type: gcp:bigquery:DataTransferDataSourceEnrollment
    properties:
      project: my-project-name
      dataSourceId: 61cede5a-0000-2440-ad42-883d24f8f7b8
      unenrollLocation: us

    terraform {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_bigquery_data_transfer_data_source_enrollment" "carbon" {
  lifecycle {
    create_before_destroy = true
  }
  project           = "my-project-name"
  data_source_id    = "61cede5a-0000-2440-ad42-883d24f8f7b8"
  unenroll_location = "us"
}

    Create DataTransferDataSourceEnrollment Resource

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

    Constructor syntax

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

@overload
def DataTransferDataSourceEnrollment(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     data_source_id: Optional[str] = None,
                                     deletion_policy: Optional[str] = None,
                                     project: Optional[str] = None,
                                     unenroll_location: Optional[str] = None)
    func NewDataTransferDataSourceEnrollment(ctx *Context, name string, args DataTransferDataSourceEnrollmentArgs, opts ...ResourceOption) (*DataTransferDataSourceEnrollment, error)
    public DataTransferDataSourceEnrollment(string name, DataTransferDataSourceEnrollmentArgs args, CustomResourceOptions? opts = null)
    public DataTransferDataSourceEnrollment(String name, DataTransferDataSourceEnrollmentArgs args)
public DataTransferDataSourceEnrollment(String name, DataTransferDataSourceEnrollmentArgs args, CustomResourceOptions options)

    type: gcp:bigquery:DataTransferDataSourceEnrollment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "gcp_bigquery_data_transfer_data_source_enrollment" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args DataTransferDataSourceEnrollmentArgs
    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 DataTransferDataSourceEnrollmentArgs
    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 DataTransferDataSourceEnrollmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataTransferDataSourceEnrollmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataTransferDataSourceEnrollmentArgs
    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 dataTransferDataSourceEnrollmentResource = new Gcp.BigQuery.DataTransferDataSourceEnrollment("dataTransferDataSourceEnrollmentResource", new()
{
    DataSourceId = "string",
    DeletionPolicy = "string",
    Project = "string",
    UnenrollLocation = "string",
});

    example, err := bigquery.NewDataTransferDataSourceEnrollment(ctx, "dataTransferDataSourceEnrollmentResource", &bigquery.DataTransferDataSourceEnrollmentArgs{
	DataSourceId:     pulumi.String("string"),
	DeletionPolicy:   pulumi.String("string"),
	Project:          pulumi.String("string"),
	UnenrollLocation: pulumi.String("string"),
})

    resource "gcp_bigquery_data_transfer_data_source_enrollment" "dataTransferDataSourceEnrollmentResource" {
  lifecycle {
    create_before_destroy = true
  }
  data_source_id    = "string"
  deletion_policy   = "string"
  project           = "string"
  unenroll_location = "string"
}

    var dataTransferDataSourceEnrollmentResource = new DataTransferDataSourceEnrollment("dataTransferDataSourceEnrollmentResource", DataTransferDataSourceEnrollmentArgs.builder()
    .dataSourceId("string")
    .deletionPolicy("string")
    .project("string")
    .unenrollLocation("string")
    .build());

    data_transfer_data_source_enrollment_resource = gcp.bigquery.DataTransferDataSourceEnrollment("dataTransferDataSourceEnrollmentResource",
    data_source_id="string",
    deletion_policy="string",
    project="string",
    unenroll_location="string")

    const dataTransferDataSourceEnrollmentResource = new gcp.bigquery.DataTransferDataSourceEnrollment("dataTransferDataSourceEnrollmentResource", {
    dataSourceId: "string",
    deletionPolicy: "string",
    project: "string",
    unenrollLocation: "string",
});

    type: gcp:bigquery:DataTransferDataSourceEnrollment
properties:
    dataSourceId: string
    deletionPolicy: string
    project: string
    unenrollLocation: string

    DataTransferDataSourceEnrollment 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 DataTransferDataSourceEnrollment resource accepts the following input properties:

    DataSourceId string
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    DeletionPolicy 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UnenrollLocation string
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    DataSourceId string
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    DeletionPolicy 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UnenrollLocation string
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    data_source_id string
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    unenroll_location string
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    dataSourceId String
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    deletionPolicy 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    unenrollLocation String
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    dataSourceId string
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    deletionPolicy 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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    unenrollLocation string
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    data_source_id str
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    unenroll_location str
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    dataSourceId String
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    deletionPolicy 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    unenrollLocation String
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.

    Outputs

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

    AuthorizationType string
    Indicates the type of authorization.
    ClientId string
    Data source client id which should be used to receive refresh token.
    DataRefreshType string
    Data refresh type.
    DefaultDataRefreshWindowDays int
    Default data refresh window on days.
    DefaultSchedule string
    Default data transfer schedule.
    Description string
    (Output) Parameter description.
    DisplayName string
    (Output) User friendly parameter name.
    HelpUrl string
    Url to the documentation about the data source.
    Id string
    The provider-assigned unique ID for this managed resource.
    ManualRunsDisabled bool
    Disables support for manual transfer runs.
    MinimumScheduleInterval string
    The minimum interval between two scheduled runs.
    Name string
    The resource name of the data source.
    Parameters List<DataTransferDataSourceEnrollmentParameter>
    Data source parameters. Structure is documented below.
    Scopes List<string>
    Api auth scopes for which refresh token needs to be obtained.
    SupportsCustomSchedule bool
    Specifies whether the data source supports a user defined schedule.
    UpdateDeadlineSeconds int
    The number of seconds to wait for a transfer to start before declaring the failure.
    AuthorizationType string
    Indicates the type of authorization.
    ClientId string
    Data source client id which should be used to receive refresh token.
    DataRefreshType string
    Data refresh type.
    DefaultDataRefreshWindowDays int
    Default data refresh window on days.
    DefaultSchedule string
    Default data transfer schedule.
    Description string
    (Output) Parameter description.
    DisplayName string
    (Output) User friendly parameter name.
    HelpUrl string
    Url to the documentation about the data source.
    Id string
    The provider-assigned unique ID for this managed resource.
    ManualRunsDisabled bool
    Disables support for manual transfer runs.
    MinimumScheduleInterval string
    The minimum interval between two scheduled runs.
    Name string
    The resource name of the data source.
    Parameters []DataTransferDataSourceEnrollmentParameter
    Data source parameters. Structure is documented below.
    Scopes []string
    Api auth scopes for which refresh token needs to be obtained.
    SupportsCustomSchedule bool
    Specifies whether the data source supports a user defined schedule.
    UpdateDeadlineSeconds int
    The number of seconds to wait for a transfer to start before declaring the failure.
    authorization_type string
    Indicates the type of authorization.
    client_id string
    Data source client id which should be used to receive refresh token.
    data_refresh_type string
    Data refresh type.
    default_data_refresh_window_days number
    Default data refresh window on days.
    default_schedule string
    Default data transfer schedule.
    description string
    (Output) Parameter description.
    display_name string
    (Output) User friendly parameter name.
    help_url string
    Url to the documentation about the data source.
    id string
    The provider-assigned unique ID for this managed resource.
    manual_runs_disabled bool
    Disables support for manual transfer runs.
    minimum_schedule_interval string
    The minimum interval between two scheduled runs.
    name string
    The resource name of the data source.
    parameters list(object)
    Data source parameters. Structure is documented below.
    scopes list(string)
    Api auth scopes for which refresh token needs to be obtained.
    supports_custom_schedule bool
    Specifies whether the data source supports a user defined schedule.
    update_deadline_seconds number
    The number of seconds to wait for a transfer to start before declaring the failure.
    authorizationType String
    Indicates the type of authorization.
    clientId String
    Data source client id which should be used to receive refresh token.
    dataRefreshType String
    Data refresh type.
    defaultDataRefreshWindowDays Integer
    Default data refresh window on days.
    defaultSchedule String
    Default data transfer schedule.
    description String
    (Output) Parameter description.
    displayName String
    (Output) User friendly parameter name.
    helpUrl String
    Url to the documentation about the data source.
    id String
    The provider-assigned unique ID for this managed resource.
    manualRunsDisabled Boolean
    Disables support for manual transfer runs.
    minimumScheduleInterval String
    The minimum interval between two scheduled runs.
    name String
    The resource name of the data source.
    parameters List<DataTransferDataSourceEnrollmentParameter>
    Data source parameters. Structure is documented below.
    scopes List<String>
    Api auth scopes for which refresh token needs to be obtained.
    supportsCustomSchedule Boolean
    Specifies whether the data source supports a user defined schedule.
    updateDeadlineSeconds Integer
    The number of seconds to wait for a transfer to start before declaring the failure.
    authorizationType string
    Indicates the type of authorization.
    clientId string
    Data source client id which should be used to receive refresh token.
    dataRefreshType string
    Data refresh type.
    defaultDataRefreshWindowDays number
    Default data refresh window on days.
    defaultSchedule string
    Default data transfer schedule.
    description string
    (Output) Parameter description.
    displayName string
    (Output) User friendly parameter name.
    helpUrl string
    Url to the documentation about the data source.
    id string
    The provider-assigned unique ID for this managed resource.
    manualRunsDisabled boolean
    Disables support for manual transfer runs.
    minimumScheduleInterval string
    The minimum interval between two scheduled runs.
    name string
    The resource name of the data source.
    parameters DataTransferDataSourceEnrollmentParameter[]
    Data source parameters. Structure is documented below.
    scopes string[]
    Api auth scopes for which refresh token needs to be obtained.
    supportsCustomSchedule boolean
    Specifies whether the data source supports a user defined schedule.
    updateDeadlineSeconds number
    The number of seconds to wait for a transfer to start before declaring the failure.
    authorization_type str
    Indicates the type of authorization.
    client_id str
    Data source client id which should be used to receive refresh token.
    data_refresh_type str
    Data refresh type.
    default_data_refresh_window_days int
    Default data refresh window on days.
    default_schedule str
    Default data transfer schedule.
    description str
    (Output) Parameter description.
    display_name str
    (Output) User friendly parameter name.
    help_url str
    Url to the documentation about the data source.
    id str
    The provider-assigned unique ID for this managed resource.
    manual_runs_disabled bool
    Disables support for manual transfer runs.
    minimum_schedule_interval str
    The minimum interval between two scheduled runs.
    name str
    The resource name of the data source.
    parameters Sequence[DataTransferDataSourceEnrollmentParameter]
    Data source parameters. Structure is documented below.
    scopes Sequence[str]
    Api auth scopes for which refresh token needs to be obtained.
    supports_custom_schedule bool
    Specifies whether the data source supports a user defined schedule.
    update_deadline_seconds int
    The number of seconds to wait for a transfer to start before declaring the failure.
    authorizationType String
    Indicates the type of authorization.
    clientId String
    Data source client id which should be used to receive refresh token.
    dataRefreshType String
    Data refresh type.
    defaultDataRefreshWindowDays Number
    Default data refresh window on days.
    defaultSchedule String
    Default data transfer schedule.
    description String
    (Output) Parameter description.
    displayName String
    (Output) User friendly parameter name.
    helpUrl String
    Url to the documentation about the data source.
    id String
    The provider-assigned unique ID for this managed resource.
    manualRunsDisabled Boolean
    Disables support for manual transfer runs.
    minimumScheduleInterval String
    The minimum interval between two scheduled runs.
    name String
    The resource name of the data source.
    parameters List<Property Map>
    Data source parameters. Structure is documented below.
    scopes List<String>
    Api auth scopes for which refresh token needs to be obtained.
    supportsCustomSchedule Boolean
    Specifies whether the data source supports a user defined schedule.
    updateDeadlineSeconds Number
    The number of seconds to wait for a transfer to start before declaring the failure.

    Look up Existing DataTransferDataSourceEnrollment Resource

    Get an existing DataTransferDataSourceEnrollment 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?: DataTransferDataSourceEnrollmentState, opts?: CustomResourceOptions): DataTransferDataSourceEnrollment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization_type: Optional[str] = None,
        client_id: Optional[str] = None,
        data_refresh_type: Optional[str] = None,
        data_source_id: Optional[str] = None,
        default_data_refresh_window_days: Optional[int] = None,
        default_schedule: Optional[str] = None,
        deletion_policy: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        help_url: Optional[str] = None,
        manual_runs_disabled: Optional[bool] = None,
        minimum_schedule_interval: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Sequence[DataTransferDataSourceEnrollmentParameterArgs]] = None,
        project: Optional[str] = None,
        scopes: Optional[Sequence[str]] = None,
        supports_custom_schedule: Optional[bool] = None,
        unenroll_location: Optional[str] = None,
        update_deadline_seconds: Optional[int] = None) -> DataTransferDataSourceEnrollment
    func GetDataTransferDataSourceEnrollment(ctx *Context, name string, id IDInput, state *DataTransferDataSourceEnrollmentState, opts ...ResourceOption) (*DataTransferDataSourceEnrollment, error)
    public static DataTransferDataSourceEnrollment Get(string name, Input<string> id, DataTransferDataSourceEnrollmentState? state, CustomResourceOptions? opts = null)
    public static DataTransferDataSourceEnrollment get(String name, Output<String> id, DataTransferDataSourceEnrollmentState state, CustomResourceOptions options)
    resources:  _:    type: gcp:bigquery:DataTransferDataSourceEnrollment    get:      id: ${id}
    import {
  to = gcp_bigquery_data_transfer_data_source_enrollment.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AuthorizationType string
    Indicates the type of authorization.
    ClientId string
    Data source client id which should be used to receive refresh token.
    DataRefreshType string
    Data refresh type.
    DataSourceId string
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    DefaultDataRefreshWindowDays int
    Default data refresh window on days.
    DefaultSchedule string
    Default data transfer schedule.
    DeletionPolicy 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.
    Description string
    (Output) Parameter description.
    DisplayName string
    (Output) User friendly parameter name.
    HelpUrl string
    Url to the documentation about the data source.
    ManualRunsDisabled bool
    Disables support for manual transfer runs.
    MinimumScheduleInterval string
    The minimum interval between two scheduled runs.
    Name string
    The resource name of the data source.
    Parameters List<DataTransferDataSourceEnrollmentParameter>
    Data source parameters. Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Scopes List<string>
    Api auth scopes for which refresh token needs to be obtained.
    SupportsCustomSchedule bool
    Specifies whether the data source supports a user defined schedule.
    UnenrollLocation string
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    UpdateDeadlineSeconds int
    The number of seconds to wait for a transfer to start before declaring the failure.
    AuthorizationType string
    Indicates the type of authorization.
    ClientId string
    Data source client id which should be used to receive refresh token.
    DataRefreshType string
    Data refresh type.
    DataSourceId string
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    DefaultDataRefreshWindowDays int
    Default data refresh window on days.
    DefaultSchedule string
    Default data transfer schedule.
    DeletionPolicy 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.
    Description string
    (Output) Parameter description.
    DisplayName string
    (Output) User friendly parameter name.
    HelpUrl string
    Url to the documentation about the data source.
    ManualRunsDisabled bool
    Disables support for manual transfer runs.
    MinimumScheduleInterval string
    The minimum interval between two scheduled runs.
    Name string
    The resource name of the data source.
    Parameters []DataTransferDataSourceEnrollmentParameterArgs
    Data source parameters. Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Scopes []string
    Api auth scopes for which refresh token needs to be obtained.
    SupportsCustomSchedule bool
    Specifies whether the data source supports a user defined schedule.
    UnenrollLocation string
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    UpdateDeadlineSeconds int
    The number of seconds to wait for a transfer to start before declaring the failure.
    authorization_type string
    Indicates the type of authorization.
    client_id string
    Data source client id which should be used to receive refresh token.
    data_refresh_type string
    Data refresh type.
    data_source_id string
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    default_data_refresh_window_days number
    Default data refresh window on days.
    default_schedule string
    Default data transfer schedule.
    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.
    description string
    (Output) Parameter description.
    display_name string
    (Output) User friendly parameter name.
    help_url string
    Url to the documentation about the data source.
    manual_runs_disabled bool
    Disables support for manual transfer runs.
    minimum_schedule_interval string
    The minimum interval between two scheduled runs.
    name string
    The resource name of the data source.
    parameters list(object)
    Data source parameters. Structure is documented below.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    scopes list(string)
    Api auth scopes for which refresh token needs to be obtained.
    supports_custom_schedule bool
    Specifies whether the data source supports a user defined schedule.
    unenroll_location string
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    update_deadline_seconds number
    The number of seconds to wait for a transfer to start before declaring the failure.
    authorizationType String
    Indicates the type of authorization.
    clientId String
    Data source client id which should be used to receive refresh token.
    dataRefreshType String
    Data refresh type.
    dataSourceId String
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    defaultDataRefreshWindowDays Integer
    Default data refresh window on days.
    defaultSchedule String
    Default data transfer schedule.
    deletionPolicy 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.
    description String
    (Output) Parameter description.
    displayName String
    (Output) User friendly parameter name.
    helpUrl String
    Url to the documentation about the data source.
    manualRunsDisabled Boolean
    Disables support for manual transfer runs.
    minimumScheduleInterval String
    The minimum interval between two scheduled runs.
    name String
    The resource name of the data source.
    parameters List<DataTransferDataSourceEnrollmentParameter>
    Data source parameters. Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    scopes List<String>
    Api auth scopes for which refresh token needs to be obtained.
    supportsCustomSchedule Boolean
    Specifies whether the data source supports a user defined schedule.
    unenrollLocation String
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    updateDeadlineSeconds Integer
    The number of seconds to wait for a transfer to start before declaring the failure.
    authorizationType string
    Indicates the type of authorization.
    clientId string
    Data source client id which should be used to receive refresh token.
    dataRefreshType string
    Data refresh type.
    dataSourceId string
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    defaultDataRefreshWindowDays number
    Default data refresh window on days.
    defaultSchedule string
    Default data transfer schedule.
    deletionPolicy 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.
    description string
    (Output) Parameter description.
    displayName string
    (Output) User friendly parameter name.
    helpUrl string
    Url to the documentation about the data source.
    manualRunsDisabled boolean
    Disables support for manual transfer runs.
    minimumScheduleInterval string
    The minimum interval between two scheduled runs.
    name string
    The resource name of the data source.
    parameters DataTransferDataSourceEnrollmentParameter[]
    Data source parameters. Structure is documented below.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    scopes string[]
    Api auth scopes for which refresh token needs to be obtained.
    supportsCustomSchedule boolean
    Specifies whether the data source supports a user defined schedule.
    unenrollLocation string
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    updateDeadlineSeconds number
    The number of seconds to wait for a transfer to start before declaring the failure.
    authorization_type str
    Indicates the type of authorization.
    client_id str
    Data source client id which should be used to receive refresh token.
    data_refresh_type str
    Data refresh type.
    data_source_id str
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    default_data_refresh_window_days int
    Default data refresh window on days.
    default_schedule str
    Default data transfer schedule.
    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.
    description str
    (Output) Parameter description.
    display_name str
    (Output) User friendly parameter name.
    help_url str
    Url to the documentation about the data source.
    manual_runs_disabled bool
    Disables support for manual transfer runs.
    minimum_schedule_interval str
    The minimum interval between two scheduled runs.
    name str
    The resource name of the data source.
    parameters Sequence[DataTransferDataSourceEnrollmentParameterArgs]
    Data source parameters. Structure is documented below.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    scopes Sequence[str]
    Api auth scopes for which refresh token needs to be obtained.
    supports_custom_schedule bool
    Specifies whether the data source supports a user defined schedule.
    unenroll_location str
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    update_deadline_seconds int
    The number of seconds to wait for a transfer to start before declaring the failure.
    authorizationType String
    Indicates the type of authorization.
    clientId String
    Data source client id which should be used to receive refresh token.
    dataRefreshType String
    Data refresh type.
    dataSourceId String
    The ID of the data source to enroll. For Google Cloud Carbon Footprint exports this is 61cede5a-0000-2440-ad42-883d24f8f7b8. Call projects.dataSources.list to see the data sources currently enrolled in a project.
    defaultDataRefreshWindowDays Number
    Default data refresh window on days.
    defaultSchedule String
    Default data transfer schedule.
    deletionPolicy 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.
    description String
    (Output) Parameter description.
    displayName String
    (Output) User friendly parameter name.
    helpUrl String
    Url to the documentation about the data source.
    manualRunsDisabled Boolean
    Disables support for manual transfer runs.
    minimumScheduleInterval String
    The minimum interval between two scheduled runs.
    name String
    The resource name of the data source.
    parameters List<Property Map>
    Data source parameters. Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    scopes List<String>
    Api auth scopes for which refresh token needs to be obtained.
    supportsCustomSchedule Boolean
    Specifies whether the data source supports a user defined schedule.
    unenrollLocation String
    The location whose unenrollDataSources endpoint is called when this resource is destroyed. Enrollment itself is project-wide and unenrolling through any location removes it everywhere; this only exists because the API offers no project-level unenroll method. Override it only if us is not routable for the project, for example under a data-residency organization policy.
    updateDeadlineSeconds Number
    The number of seconds to wait for a transfer to start before declaring the failure.

    Supporting Types

    DataTransferDataSourceEnrollmentParameter, DataTransferDataSourceEnrollmentParameterArgs

    AllowedValues List<string>
    (Output) All possible values for parameters with fixed list of options.
    Deprecated bool
    (Output) If true, it should not be used in new transfers, and it should not be visible to users.
    Description string
    (Output) Parameter description.
    DisplayName string
    (Output) User friendly parameter name.
    Immutable bool
    (Output) Cannot be changed after initial transfer config creation. Applies only to custom data sources.
    MaxListSize int
    (Output) For list parameters, the max size of the list.
    MaxValue double
    (Output) For integer and double values specifies maximum allowed value.
    MinValue double
    (Output) For integer and double values specifies minimum allowed value.
    ParamId string
    (Output) Parameter identifier.
    Required bool
    (Output) Is parameter required.
    Type string
    (Output) Parameter type.
    ValidationDescription string
    (Output) Description of the requirements for this field, in case the user input does not fulfill the regex.
    ValidationHelpUrl string
    (Output) URL to a help document to further explain the naming requirements.
    ValidationRegex string
    (Output) Regular expression which can be used for parameter validation.
    AllowedValues []string
    (Output) All possible values for parameters with fixed list of options.
    Deprecated bool
    (Output) If true, it should not be used in new transfers, and it should not be visible to users.
    Description string
    (Output) Parameter description.
    DisplayName string
    (Output) User friendly parameter name.
    Immutable bool
    (Output) Cannot be changed after initial transfer config creation. Applies only to custom data sources.
    MaxListSize int
    (Output) For list parameters, the max size of the list.
    MaxValue float64
    (Output) For integer and double values specifies maximum allowed value.
    MinValue float64
    (Output) For integer and double values specifies minimum allowed value.
    ParamId string
    (Output) Parameter identifier.
    Required bool
    (Output) Is parameter required.
    Type string
    (Output) Parameter type.
    ValidationDescription string
    (Output) Description of the requirements for this field, in case the user input does not fulfill the regex.
    ValidationHelpUrl string
    (Output) URL to a help document to further explain the naming requirements.
    ValidationRegex string
    (Output) Regular expression which can be used for parameter validation.
    allowed_values list(string)
    (Output) All possible values for parameters with fixed list of options.
    deprecated bool
    (Output) If true, it should not be used in new transfers, and it should not be visible to users.
    description string
    (Output) Parameter description.
    display_name string
    (Output) User friendly parameter name.
    immutable bool
    (Output) Cannot be changed after initial transfer config creation. Applies only to custom data sources.
    max_list_size number
    (Output) For list parameters, the max size of the list.
    max_value number
    (Output) For integer and double values specifies maximum allowed value.
    min_value number
    (Output) For integer and double values specifies minimum allowed value.
    param_id string
    (Output) Parameter identifier.
    required bool
    (Output) Is parameter required.
    type string
    (Output) Parameter type.
    validation_description string
    (Output) Description of the requirements for this field, in case the user input does not fulfill the regex.
    validation_help_url string
    (Output) URL to a help document to further explain the naming requirements.
    validation_regex string
    (Output) Regular expression which can be used for parameter validation.
    allowedValues List<String>
    (Output) All possible values for parameters with fixed list of options.
    deprecated Boolean
    (Output) If true, it should not be used in new transfers, and it should not be visible to users.
    description String
    (Output) Parameter description.
    displayName String
    (Output) User friendly parameter name.
    immutable Boolean
    (Output) Cannot be changed after initial transfer config creation. Applies only to custom data sources.
    maxListSize Integer
    (Output) For list parameters, the max size of the list.
    maxValue Double
    (Output) For integer and double values specifies maximum allowed value.
    minValue Double
    (Output) For integer and double values specifies minimum allowed value.
    paramId String
    (Output) Parameter identifier.
    required Boolean
    (Output) Is parameter required.
    type String
    (Output) Parameter type.
    validationDescription String
    (Output) Description of the requirements for this field, in case the user input does not fulfill the regex.
    validationHelpUrl String
    (Output) URL to a help document to further explain the naming requirements.
    validationRegex String
    (Output) Regular expression which can be used for parameter validation.
    allowedValues string[]
    (Output) All possible values for parameters with fixed list of options.
    deprecated boolean
    (Output) If true, it should not be used in new transfers, and it should not be visible to users.
    description string
    (Output) Parameter description.
    displayName string
    (Output) User friendly parameter name.
    immutable boolean
    (Output) Cannot be changed after initial transfer config creation. Applies only to custom data sources.
    maxListSize number
    (Output) For list parameters, the max size of the list.
    maxValue number
    (Output) For integer and double values specifies maximum allowed value.
    minValue number
    (Output) For integer and double values specifies minimum allowed value.
    paramId string
    (Output) Parameter identifier.
    required boolean
    (Output) Is parameter required.
    type string
    (Output) Parameter type.
    validationDescription string
    (Output) Description of the requirements for this field, in case the user input does not fulfill the regex.
    validationHelpUrl string
    (Output) URL to a help document to further explain the naming requirements.
    validationRegex string
    (Output) Regular expression which can be used for parameter validation.
    allowed_values Sequence[str]
    (Output) All possible values for parameters with fixed list of options.
    deprecated bool
    (Output) If true, it should not be used in new transfers, and it should not be visible to users.
    description str
    (Output) Parameter description.
    display_name str
    (Output) User friendly parameter name.
    immutable bool
    (Output) Cannot be changed after initial transfer config creation. Applies only to custom data sources.
    max_list_size int
    (Output) For list parameters, the max size of the list.
    max_value float
    (Output) For integer and double values specifies maximum allowed value.
    min_value float
    (Output) For integer and double values specifies minimum allowed value.
    param_id str
    (Output) Parameter identifier.
    required bool
    (Output) Is parameter required.
    type str
    (Output) Parameter type.
    validation_description str
    (Output) Description of the requirements for this field, in case the user input does not fulfill the regex.
    validation_help_url str
    (Output) URL to a help document to further explain the naming requirements.
    validation_regex str
    (Output) Regular expression which can be used for parameter validation.
    allowedValues List<String>
    (Output) All possible values for parameters with fixed list of options.
    deprecated Boolean
    (Output) If true, it should not be used in new transfers, and it should not be visible to users.
    description String
    (Output) Parameter description.
    displayName String
    (Output) User friendly parameter name.
    immutable Boolean
    (Output) Cannot be changed after initial transfer config creation. Applies only to custom data sources.
    maxListSize Number
    (Output) For list parameters, the max size of the list.
    maxValue Number
    (Output) For integer and double values specifies maximum allowed value.
    minValue Number
    (Output) For integer and double values specifies minimum allowed value.
    paramId String
    (Output) Parameter identifier.
    required Boolean
    (Output) Is parameter required.
    type String
    (Output) Parameter type.
    validationDescription String
    (Output) Description of the requirements for this field, in case the user input does not fulfill the regex.
    validationHelpUrl String
    (Output) URL to a help document to further explain the naming requirements.
    validationRegex String
    (Output) Regular expression which can be used for parameter validation.

    Import

    DataSourceEnrollment can be imported using any of these accepted formats:

    • projects/{{project}}/dataSources/{{data_source_id}}
    • {{project}}/{{data_source_id}}
    • {{data_source_id}}

    When using the pulumi import command, DataSourceEnrollment can be imported using one of the formats above. For example:

    $ pulumi import gcp:bigquery/dataTransferDataSourceEnrollment:DataTransferDataSourceEnrollment default projects/{{project}}/dataSources/{{data_source_id}}
$ pulumi import gcp:bigquery/dataTransferDataSourceEnrollment:DataTransferDataSourceEnrollment default {{project}}/{{data_source_id}}
$ pulumi import gcp:bigquery/dataTransferDataSourceEnrollment:DataTransferDataSourceEnrollment default {{data_source_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v10.2.0
    published on Tuesday, Oct 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial