Folder class

A Google Cloud Storage Folder.

The Folder resource represents a folder in a Cloud Storage bucket with hierarchical namespace enabled

To get more information about Folder, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Storage Folder Basic

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

const bucket = new gcp.storage.Bucket("bucket", {
    name: "my-bucket",
    location: "EU",
    uniformBucketLevelAccess: true,
    hierarchicalNamespace: {
        enabled: true,
    },
});
const folder = new gcp.storage.Folder("folder", {
    bucket: bucket.name,
    name: "parent-folder/",
});
const subfolder = new gcp.storage.Folder("subfolder", {
    bucket: bucket.name,
    name: pulumi.interpolate`${folder.name}subfolder/`,
});

import pulumi
import pulumi_gcp as gcp

bucket = gcp.storage.Bucket("bucket",
    name="my-bucket",
    location="EU",
    uniform_bucket_level_access=True,
    hierarchical_namespace={
        "enabled": True,
    })
folder = gcp.storage.Folder("folder",
    bucket=bucket.name,
    name="parent-folder/")
subfolder = gcp.storage.Folder("subfolder",
    bucket=bucket.name,
    name=folder.name.apply(lambda name: f"{name}subfolder/"))

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var bucket = new Gcp.Storage.Bucket("bucket", new()
    {
        Name = "my-bucket",
        Location = "EU",
        UniformBucketLevelAccess = true,
        HierarchicalNamespace = new Gcp.Storage.Inputs.BucketHierarchicalNamespaceArgs
        {
            Enabled = true,
        },
    });

    var folder = new Gcp.Storage.Folder("folder", new()
    {
        Bucket = bucket.Name,
        Name = "parent-folder/",
    });

    var subfolder = new Gcp.Storage.Folder("subfolder", new()
    {
        Bucket = bucket.Name,
        Name = folder.Name.Apply(name => $"{name}subfolder/"),
    });

});

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
			Name:                     pulumi.String("my-bucket"),
			Location:                 pulumi.String("EU"),
			UniformBucketLevelAccess: pulumi.Bool(true),
			HierarchicalNamespace: &storage.BucketHierarchicalNamespaceArgs{
				Enabled: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		folder, err := storage.NewFolder(ctx, "folder", &storage.FolderArgs{
			Bucket: bucket.Name,
			Name:   pulumi.String("parent-folder/"),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewFolder(ctx, "subfolder", &storage.FolderArgs{
			Bucket: bucket.Name,
			Name: folder.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("%vsubfolder/", name), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_storage_bucket" "bucket" {
  name                        = "my-bucket"
  location                    = "EU"
  uniform_bucket_level_access = true
  hierarchical_namespace = {
    enabled = true
  }
}
resource "gcp_storage_folder" "folder" {
  bucket = gcp_storage_bucket.bucket.name
  name   = "parent-folder/"
}
resource "gcp_storage_folder" "subfolder" {
  bucket = gcp_storage_bucket.bucket.name
  name   ="${gcp_storage_folder.folder.name}subfolder/"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.storage.inputs.BucketHierarchicalNamespaceArgs;
import com.pulumi.gcp.storage.Folder;
import com.pulumi.gcp.storage.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 bucket = new Bucket("bucket", BucketArgs.builder()
            .name("my-bucket")
            .location("EU")
            .uniformBucketLevelAccess(true)
            .hierarchicalNamespace(BucketHierarchicalNamespaceArgs.builder()
                .enabled(true)
                .build())
            .build());

        var folder = new Folder("folder", FolderArgs.builder()
            .bucket(bucket.name())
            .name("parent-folder/")
            .build());

        var subfolder = new Folder("subfolder", FolderArgs.builder()
            .bucket(bucket.name())
            .name(folder.name().applyValue(_name -> String.format("%ssubfolder/", _name)))
            .build());

    }
}

resources:
  bucket:
    type: gcp:storage:Bucket
    properties:
      name: my-bucket
      location: EU
      uniformBucketLevelAccess: true
      hierarchicalNamespace:
        enabled: true
  folder:
    type: gcp:storage:Folder
    properties:
      bucket: ${bucket.name}
      name: parent-folder/
  subfolder:
    type: gcp:storage:Folder
    properties:
      bucket: ${bucket.name}
      name: ${folder.name}subfolder/

Import

Folder can be imported using any of these accepted formats:

• {{bucket}}/folders/{{name}}
• {{bucket}}/{{name}}

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

$ pulumi import gcp:storage/folder:Folder default {{bucket}}/folders/{{name}}
$ pulumi import gcp:storage/folder:Folder default {{bucket}}/{{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

bucket ↔ Output<String>

The name of the bucket that contains the folder.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The timestamp at which this folder was created.

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

forceDestroy ↔ Output<bool?>

If set to true, items within folder if any will be force destroyed.

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

metageneration ↔ Output<String>

The metadata generation of the folder.

late, final

name ↔ Output<String>

The name of the folder expressed as a path. Must include trailing '/'. For example, example_dir/example_dir2/, example@#/, a-b/d-f/.

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

selfLink ↔ Output<String>

The URI of the created resource.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

The timestamp at which this folder was most recently updated.

late, final

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.