1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. dataform
  5. TeamFolder
Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi
gcp logo
Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi

    A resource represents a Dataform TeamFolder

    Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

    To get more information about TeamFolder, see:

    Example Usage

    Dataform Team Folder Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const dataformTeamFolderBasic = new gcp.dataform.TeamFolder("dataform_team_folder_basic", {
        region: "us-central1",
        displayName: "Basic TeamFolder-_64336",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    dataform_team_folder_basic = gcp.dataform.TeamFolder("dataform_team_folder_basic",
        region="us-central1",
        display_name="Basic TeamFolder-_64336")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/dataform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dataform.NewTeamFolder(ctx, "dataform_team_folder_basic", &dataform.TeamFolderArgs{
    			Region:      pulumi.String("us-central1"),
    			DisplayName: pulumi.String("Basic TeamFolder-_64336"),
    		})
    		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 dataformTeamFolderBasic = new Gcp.Dataform.TeamFolder("dataform_team_folder_basic", new()
        {
            Region = "us-central1",
            DisplayName = "Basic TeamFolder-_64336",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.dataform.TeamFolder;
    import com.pulumi.gcp.dataform.TeamFolderArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 dataformTeamFolderBasic = new TeamFolder("dataformTeamFolderBasic", TeamFolderArgs.builder()
                .region("us-central1")
                .displayName("Basic TeamFolder-_64336")
                .build());
    
        }
    }
    
    resources:
      dataformTeamFolderBasic:
        type: gcp:dataform:TeamFolder
        name: dataform_team_folder_basic
        properties:
          region: us-central1
          displayName: Basic TeamFolder-_64336
    

    Create TeamFolder Resource

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

    Constructor syntax

    new TeamFolder(name: string, args: TeamFolderArgs, opts?: CustomResourceOptions);
    @overload
    def TeamFolder(resource_name: str,
                   args: TeamFolderArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def TeamFolder(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   display_name: Optional[str] = None,
                   region: Optional[str] = None,
                   project: Optional[str] = None)
    func NewTeamFolder(ctx *Context, name string, args TeamFolderArgs, opts ...ResourceOption) (*TeamFolder, error)
    public TeamFolder(string name, TeamFolderArgs args, CustomResourceOptions? opts = null)
    public TeamFolder(String name, TeamFolderArgs args)
    public TeamFolder(String name, TeamFolderArgs args, CustomResourceOptions options)
    
    type: gcp:dataform:TeamFolder
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args TeamFolderArgs
    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 TeamFolderArgs
    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 TeamFolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TeamFolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TeamFolderArgs
    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 teamFolderResource = new Gcp.Dataform.TeamFolder("teamFolderResource", new()
    {
        DisplayName = "string",
        Region = "string",
        Project = "string",
    });
    
    example, err := dataform.NewTeamFolder(ctx, "teamFolderResource", &dataform.TeamFolderArgs{
    	DisplayName: pulumi.String("string"),
    	Region:      pulumi.String("string"),
    	Project:     pulumi.String("string"),
    })
    
    var teamFolderResource = new TeamFolder("teamFolderResource", TeamFolderArgs.builder()
        .displayName("string")
        .region("string")
        .project("string")
        .build());
    
    team_folder_resource = gcp.dataform.TeamFolder("teamFolderResource",
        display_name="string",
        region="string",
        project="string")
    
    const teamFolderResource = new gcp.dataform.TeamFolder("teamFolderResource", {
        displayName: "string",
        region: "string",
        project: "string",
    });
    
    type: gcp:dataform:TeamFolder
    properties:
        displayName: string
        project: string
        region: string
    

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

    DisplayName string
    Required. The TeamFolder's user-friendly name.
    Region string
    A reference to the region
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    DisplayName string
    Required. The TeamFolder's user-friendly name.
    Region string
    A reference to the region
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName String
    Required. The TeamFolder's user-friendly name.
    region String
    A reference to the region
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName string
    Required. The TeamFolder's user-friendly name.
    region string
    A reference to the region
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    display_name str
    Required. The TeamFolder's user-friendly name.
    region str
    A reference to the region
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName String
    Required. The TeamFolder's user-friendly name.
    region String
    A reference to the region
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The TeamFolder's name.
    TeamfolderId string
    The unique identifier for the TeamFolder.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The TeamFolder's name.
    TeamfolderId string
    The unique identifier for the TeamFolder.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The TeamFolder's name.
    teamfolderId String
    The unique identifier for the TeamFolder.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The TeamFolder's name.
    teamfolderId string
    The unique identifier for the TeamFolder.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The TeamFolder's name.
    teamfolder_id str
    The unique identifier for the TeamFolder.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The TeamFolder's name.
    teamfolderId String
    The unique identifier for the TeamFolder.

    Look up Existing TeamFolder Resource

    Get an existing TeamFolder 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?: TeamFolderState, opts?: CustomResourceOptions): TeamFolder
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            display_name: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            region: Optional[str] = None,
            teamfolder_id: Optional[str] = None) -> TeamFolder
    func GetTeamFolder(ctx *Context, name string, id IDInput, state *TeamFolderState, opts ...ResourceOption) (*TeamFolder, error)
    public static TeamFolder Get(string name, Input<string> id, TeamFolderState? state, CustomResourceOptions? opts = null)
    public static TeamFolder get(String name, Output<String> id, TeamFolderState state, CustomResourceOptions options)
    resources:  _:    type: gcp:dataform:TeamFolder    get:      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:
    DisplayName string
    Required. The TeamFolder's user-friendly name.
    Name string
    The TeamFolder's name.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    A reference to the region
    TeamfolderId string
    The unique identifier for the TeamFolder.
    DisplayName string
    Required. The TeamFolder's user-friendly name.
    Name string
    The TeamFolder's name.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    A reference to the region
    TeamfolderId string
    The unique identifier for the TeamFolder.
    displayName String
    Required. The TeamFolder's user-friendly name.
    name String
    The TeamFolder's name.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    A reference to the region
    teamfolderId String
    The unique identifier for the TeamFolder.
    displayName string
    Required. The TeamFolder's user-friendly name.
    name string
    The TeamFolder's name.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region string
    A reference to the region
    teamfolderId string
    The unique identifier for the TeamFolder.
    display_name str
    Required. The TeamFolder's user-friendly name.
    name str
    The TeamFolder's name.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region str
    A reference to the region
    teamfolder_id str
    The unique identifier for the TeamFolder.
    displayName String
    Required. The TeamFolder's user-friendly name.
    name String
    The TeamFolder's name.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    A reference to the region
    teamfolderId String
    The unique identifier for the TeamFolder.

    Import

    TeamFolder can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{region}}/teamFolders/{{teamfolder_id}}
    • {{project}}/{{region}}/{{teamfolder_id}}
    • {{region}}/{{teamfolder_id}}
    • {{teamfolder_id}}
    • {{name}}

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

    $ pulumi import gcp:dataform/teamFolder:TeamFolder default projects/{{project}}/locations/{{region}}/teamFolders/{{teamfolder_id}}
    $ pulumi import gcp:dataform/teamFolder:TeamFolder default {{project}}/{{region}}/{{teamfolder_id}}
    $ pulumi import gcp:dataform/teamFolder:TeamFolder default {{region}}/{{teamfolder_id}}
    $ pulumi import gcp:dataform/teamFolder:TeamFolder default {{teamfolder_id}}
    $ pulumi import gcp:dataform/teamFolder:TeamFolder default {{name}}
    

    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 v9.15.0
    published on Thursday, Mar 12, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.