Folder class

A resource represents a Dataform folder

To get more information about Folder, see:

• API documentation
• How-to Guides
• Official Documentation

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-_89313",
});

import pulumi
import pulumi_gcp as gcp

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

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-_89313",
    });

});

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-_89313"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_dataform_folder" "dataform_folder_basic" {
  region       = "us-central1"
  display_name = "Basic Folder-_89313"
}

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.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 dataformFolderBasic = new Folder("dataformFolderBasic", FolderArgs.builder()
            .region("us-central1")
            .displayName("Basic Folder-_89313")
            .build());

    }
}

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

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-_60646",
});
const dataformFolderFull = new gcp.dataform.Folder("dataform_folder_full", {
    region: "us-central1",
    displayName: "Nested Folder-_9394",
    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-_60646")
dataform_folder_full = gcp.dataform.Folder("dataform_folder_full",
    region="us-central1",
    display_name="Nested Folder-_9394",
    containing_folder=dataform_folder_root.id)

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-_60646",
    });

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

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

resource "gcp_dataform_folder" "dataform_folder_root" {
  region       = "us-central1"
  display_name = "Root Folder-_60646"
}
resource "gcp_dataform_folder" "dataform_folder_full" {
  region            = "us-central1"
  display_name      = "Nested Folder-_9394"
  containing_folder = gcp_dataform_folder.dataform_folder_root.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.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 dataformFolderRoot = new Folder("dataformFolderRoot", FolderArgs.builder()
            .region("us-central1")
            .displayName("Root Folder-_60646")
            .build());

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

    }
}

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

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}}

Constructors

Folder(String name, {FolderArgs? args, CustomResourceOptions? options})

Creates a new Folder. name The Pulumi resource name. args Arguments used to configure this Folder. The set of arguments for Folder. options Resource options controlling this resource's behavior.

Folder.reference(String urn)

Creates a typed reference to an existing Folder resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

containingFolder ↔ Output<String?>

Optional. The containing Folder resource name. Format: projects/*/locations/*/folders/* or projects/*/locations/*/teamFolders/*.

late, final

deletionPolicy ↔ Output<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.

late, final

displayName ↔ Output<String>

Required. The Folder's user-friendly name.

late, final

folderId ↔ Output<String>

The unique identifier for the Folder.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

The Folder's name.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

region ↔ Output<String>

A reference to the region

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {FolderState? state, CustomResourceOptions? options}) → Folder

Gets an existing Folder resource's state with the given name and id.