StorageBucket class

An association between a Firebase project and a Google Cloud Storage bucket. This association enables integration of Cloud Storage buckets with Firebase such as Firebase SDKS, Authentication, and Security Rules.

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

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Firebasestorage Bucket Basic

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

const _default = new gcp.storage.Bucket("default", {
    name: "test_bucket",
    location: "US",
    uniformBucketLevelAccess: true,
});
const defaultStorageBucket = new gcp.firebase.StorageBucket("default", {
    project: "my-project-name",
    bucketId: _default.name,
});

import pulumi
import pulumi_gcp as gcp

default = gcp.storage.Bucket("default",
    name="test_bucket",
    location="US",
    uniform_bucket_level_access=True)
default_storage_bucket = gcp.firebase.StorageBucket("default",
    project="my-project-name",
    bucket_id=default.name)

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

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.Storage.Bucket("default", new()
    {
        Name = "test_bucket",
        Location = "US",
        UniformBucketLevelAccess = true,
    });

    var defaultStorageBucket = new Gcp.Firebase.StorageBucket("default", new()
    {
        Project = "my-project-name",
        BucketId = @default.Name,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/firebase"
	"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 {
		_default, err := storage.NewBucket(ctx, "default", &storage.BucketArgs{
			Name:                     pulumi.String("test_bucket"),
			Location:                 pulumi.String("US"),
			UniformBucketLevelAccess: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = firebase.NewStorageBucket(ctx, "default", &firebase.StorageBucketArgs{
			Project:  pulumi.String("my-project-name"),
			BucketId: _default.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_storage_bucket" "default" {
  name                        = "test_bucket"
  location                    = "US"
  uniform_bucket_level_access = true
}
resource "gcp_firebase_storagebucket" "default" {
  project   = "my-project-name"
  bucket_id = gcp_storage_bucket.default.name
}

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.firebase.StorageBucket;
import com.pulumi.gcp.firebase.StorageBucketArgs;
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 default_ = new Bucket("default", BucketArgs.builder()
            .name("test_bucket")
            .location("US")
            .uniformBucketLevelAccess(true)
            .build());

        var defaultStorageBucket = new StorageBucket("defaultStorageBucket", StorageBucketArgs.builder()
            .project("my-project-name")
            .bucketId(default_.name())
            .build());

    }
}

resources:
  default:
    type: gcp:storage:Bucket
    properties:
      name: test_bucket
      location: US
      uniformBucketLevelAccess: true
  defaultStorageBucket:
    type: gcp:firebase:StorageBucket
    name: default
    properties:
      project: my-project-name
      bucketId: ${default.name}

Import

Bucket can be imported using any of these accepted formats:

• projects/{{project}}/buckets/{{bucket_id}}
• {{project}}/{{bucket_id}}
• {{bucket_id}}

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

$ pulumi import gcp:firebase/storageBucket:StorageBucket default projects/{{project}}/buckets/{{bucket_id}}
$ pulumi import gcp:firebase/storageBucket:StorageBucket default {{project}}/{{bucket_id}}
$ pulumi import gcp:firebase/storageBucket:StorageBucket default {{bucket_id}}

Constructors

StorageBucket(String name, {StorageBucketArgs? args, CustomResourceOptions? options})

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

StorageBucket.reference(String urn)

Creates a typed reference to an existing StorageBucket resource.

Properties

bucketId ↔ Output<String?>

Required. Immutable. The ID of the underlying Google Cloud Storage bucket

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

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

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>

Resource name of the bucket in the format projects/PROJECT_IDENTIFIER/buckets/BUCKET_ID

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

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, {StorageBucketState? state, CustomResourceOptions? options}) → StorageBucket

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