1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. dataform
  5. Folder
Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.dataform.Folder

gcp logo
Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    A resource represents a Dataform folder

    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 Folder, see:

    Example Usage

    Dataform Folder Basic

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

const dataformFolderBasic = new gcp.dataform.Folder("dataform_folder_basic", {
    region: "us-central1",
    displayName: "Basic Folder-_95154",
});

    import pulumi
import pulumi_gcp as gcp

dataform_folder_basic = gcp.dataform.Folder("dataform_folder_basic",
    region="us-central1",
    display_name="Basic Folder-_95154")

    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.NewFolder(ctx, "dataform_folder_basic", &dataform.FolderArgs{
			Region:      pulumi.String("us-central1"),
			DisplayName: pulumi.String("Basic Folder-_95154"),
		})
		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 dataformFolderBasic = new Gcp.Dataform.Folder("dataform_folder_basic", new()
    {
        Region = "us-central1",
        DisplayName = "Basic Folder-_95154",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataform.Folder;
import com.pulumi.gcp.dataform.FolderArgs;
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 dataformFolderBasic = new Folder("dataformFolderBasic", FolderArgs.builder()
            .region("us-central1")
            .displayName("Basic Folder-_95154")
            .build());

    }
}

    resources:
  dataformFolderBasic:
    type: gcp:dataform:Folder
    name: dataform_folder_basic
    properties:
      region: us-central1
      displayName: Basic Folder-_95154

    Dataform Folder Full

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

const dataformFolderRoot = new gcp.dataform.Folder("dataform_folder_root", {
    region: "us-central1",
    displayName: "Root Folder",
});
const dataformFolderFull = new gcp.dataform.Folder("dataform_folder_full", {
    region: "us-central1",
    displayName: "Nested Folder",
    containingFolder: dataformFolderRoot.id,
});

    import pulumi
import pulumi_gcp as gcp

dataform_folder_root = gcp.dataform.Folder("dataform_folder_root",
    region="us-central1",
    display_name="Root Folder")
dataform_folder_full = gcp.dataform.Folder("dataform_folder_full",
    region="us-central1",
    display_name="Nested Folder",
    containing_folder=dataform_folder_root.id)

    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 {
		dataformFolderRoot, err := dataform.NewFolder(ctx, "dataform_folder_root", &dataform.FolderArgs{
			Region:      pulumi.String("us-central1"),
			DisplayName: pulumi.String("Root Folder"),
		})
		if err != nil {
			return err
		}
		_, err = dataform.NewFolder(ctx, "dataform_folder_full", &dataform.FolderArgs{
			Region:           pulumi.String("us-central1"),
			DisplayName:      pulumi.String("Nested Folder"),
			ContainingFolder: dataformFolderRoot.ID(),
		})
		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 dataformFolderRoot = new Gcp.Dataform.Folder("dataform_folder_root", new()
    {
        Region = "us-central1",
        DisplayName = "Root Folder",
    });

    var dataformFolderFull = new Gcp.Dataform.Folder("dataform_folder_full", new()
    {
        Region = "us-central1",
        DisplayName = "Nested Folder",
        ContainingFolder = dataformFolderRoot.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataform.Folder;
import com.pulumi.gcp.dataform.FolderArgs;
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 dataformFolderRoot = new Folder("dataformFolderRoot", FolderArgs.builder()
            .region("us-central1")
            .displayName("Root Folder")
            .build());

        var dataformFolderFull = new Folder("dataformFolderFull", FolderArgs.builder()
            .region("us-central1")
            .displayName("Nested Folder")
            .containingFolder(dataformFolderRoot.id())
            .build());

    }
}

    resources:
  dataformFolderRoot:
    type: gcp:dataform:Folder
    name: dataform_folder_root
    properties:
      region: us-central1
      displayName: Root Folder
  dataformFolderFull:
    type: gcp:dataform:Folder
    name: dataform_folder_full
    properties:
      region: us-central1
      displayName: Nested Folder
      containingFolder: ${dataformFolderRoot.id}

    Create Folder Resource

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

    Constructor syntax

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

@overload
def Folder(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           display_name: Optional[str] = None,
           region: Optional[str] = None,
           containing_folder: Optional[str] = None,
           project: Optional[str] = None)
    func NewFolder(ctx *Context, name string, args FolderArgs, opts ...ResourceOption) (*Folder, error)
    public Folder(string name, FolderArgs args, CustomResourceOptions? opts = null)
    public Folder(String name, FolderArgs args)
public Folder(String name, FolderArgs args, CustomResourceOptions options)

    type: gcp:dataform:Folder
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 FolderArgs
    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 FolderArgs
    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 FolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FolderArgs
    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 folderResource = new Gcp.Dataform.Folder("folderResource", new()
{
    DisplayName = "string",
    Region = "string",
    ContainingFolder = "string",
    Project = "string",
});

    example, err := dataform.NewFolder(ctx, "folderResource", &dataform.FolderArgs{
	DisplayName:      pulumi.String("string"),
	Region:           pulumi.String("string"),
	ContainingFolder: pulumi.String("string"),
	Project:          pulumi.String("string"),
})

    var folderResource = new com.pulumi.gcp.dataform.Folder("folderResource", com.pulumi.gcp.dataform.FolderArgs.builder()
    .displayName("string")
    .region("string")
    .containingFolder("string")
    .project("string")
    .build());

    folder_resource = gcp.dataform.Folder("folderResource",
    display_name="string",
    region="string",
    containing_folder="string",
    project="string")

    const folderResource = new gcp.dataform.Folder("folderResource", {
    displayName: "string",
    region: "string",
    containingFolder: "string",
    project: "string",
});

    type: gcp:dataform:Folder
properties:
    containingFolder: string
    displayName: string
    project: string
    region: string

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

    DisplayName string
    Required. The Folder's user-friendly name.
    Region string
    A reference to the region
    ContainingFolder string
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    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 Folder's user-friendly name.
    Region string
    A reference to the region
    ContainingFolder string
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    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 Folder's user-friendly name.
    region String
    A reference to the region
    containingFolder String
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    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 Folder's user-friendly name.
    region string
    A reference to the region
    containingFolder string
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    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 Folder's user-friendly name.
    region str
    A reference to the region
    containing_folder str
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    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 Folder's user-friendly name.
    region String
    A reference to the region
    containingFolder String
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    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 Folder resource produces the following output properties:

    FolderId string
    The unique identifier for the Folder.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The Folder's name.
    FolderId string
    The unique identifier for the Folder.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The Folder's name.
    folderId String
    The unique identifier for the Folder.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The Folder's name.
    folderId string
    The unique identifier for the Folder.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The Folder's name.
    folder_id str
    The unique identifier for the Folder.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The Folder's name.
    folderId String
    The unique identifier for the Folder.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The Folder's name.

    Look up Existing Folder Resource

    Get an existing Folder 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?: FolderState, opts?: CustomResourceOptions): Folder
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        containing_folder: Optional[str] = None,
        display_name: Optional[str] = None,
        folder_id: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        region: Optional[str] = None) -> Folder
    func GetFolder(ctx *Context, name string, id IDInput, state *FolderState, opts ...ResourceOption) (*Folder, error)
    public static Folder Get(string name, Input<string> id, FolderState? state, CustomResourceOptions? opts = null)
    public static Folder get(String name, Output<String> id, FolderState state, CustomResourceOptions options)
    resources:  _:    type: gcp:dataform:Folder    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:
    ContainingFolder string
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    DisplayName string
    Required. The Folder's user-friendly name.
    FolderId string
    The unique identifier for the Folder.
    Name string
    The Folder'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
    ContainingFolder string
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    DisplayName string
    Required. The Folder's user-friendly name.
    FolderId string
    The unique identifier for the Folder.
    Name string
    The Folder'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
    containingFolder String
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    displayName String
    Required. The Folder's user-friendly name.
    folderId String
    The unique identifier for the Folder.
    name String
    The Folder'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
    containingFolder string
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    displayName string
    Required. The Folder's user-friendly name.
    folderId string
    The unique identifier for the Folder.
    name string
    The Folder'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
    containing_folder str
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    display_name str
    Required. The Folder's user-friendly name.
    folder_id str
    The unique identifier for the Folder.
    name str
    The Folder'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
    containingFolder String
    Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.
    displayName String
    Required. The Folder's user-friendly name.
    folderId String
    The unique identifier for the Folder.
    name String
    The Folder'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

    Import

    Folder can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{region}}/folders/{{folder_id}}
    • {{project}}/{{region}}/{{folder_id}}
    • {{region}}/{{folder_id}}
    • {{folder_id}}
    • {{name}}

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

    $ pulumi import gcp:dataform/folder:Folder default projects/{{project}}/locations/{{region}}/folders/{{folder_id}}
$ pulumi import gcp:dataform/folder:Folder default {{project}}/{{region}}/{{folder_id}}
$ pulumi import gcp:dataform/folder:Folder default {{region}}/{{folder_id}}
$ pulumi import gcp:dataform/folder:Folder default {{folder_id}}
$ pulumi import gcp:dataform/folder:Folder 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
    Schema (JSON)
    pulumi/pulumi-gcp
      Try Pulumi Cloud free. Your team will thank you.