blob: c425eccca3f04cb8b3a17b19eb8f8cd152c85a68 [file] [log] [blame]
---
# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** Type: MMv1 ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file in
# .github/CONTRIBUTING.md.
#
# ----------------------------------------------------------------------------
subcategory: "Cloud Storage for Firebase"
description: |-
An association between a Firebase project and a Google Cloud Storage bucket.
---
# google_firebase_storage_bucket
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](https://terraform.io/docs/providers/google/guides/provider_versions.html) for more details on beta resources.
To get more information about Bucket, see:
* [API documentation](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets)
* How-to Guides
* [Official Documentation](https://firebase.google.com/docs/storage/)
## Example Usage - Firebasestorage Bucket Basic
```hcl
resource "google_storage_bucket" "default" {
provider = google-beta
name = "test_bucket"
location = "US"
uniform_bucket_level_access = true
}
resource "google_firebase_storage_bucket" "default" {
provider = google-beta
project = "my-project-name"
bucket_id = google_storage_bucket.default.id
}
```
## Argument Reference
The following arguments are supported:
- - -
* `bucket_id` -
(Optional)
Required. Immutable. The ID of the underlying Google Cloud Storage bucket
* `project` - (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
## Attributes Reference
In addition to the arguments listed above, the following computed attributes are exported:
* `id` - an identifier for the resource with format `projects/{{project}}/buckets/{{bucket_id}}`
* `name` -
Resource name of the bucket in the format projects/PROJECT_IDENTIFIER/buckets/BUCKET_ID
## Timeouts
This resource provides the following
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:
- `create` - Default is 20 minutes.
- `delete` - Default is 20 minutes.
## Import
Bucket can be imported using any of these accepted formats:
* `projects/{{project}}/buckets/{{bucket_id}}`
* `{{project}}/{{bucket_id}}`
* `{{bucket_id}}`
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Bucket using one of the formats above. For example:
```tf
import {
id = "projects/{{project}}/buckets/{{bucket_id}}"
to = google_firebase_storage_bucket.default
}
```
When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Bucket can be imported using one of the formats above. For example:
```
$ terraform import google_firebase_storage_bucket.default projects/{{project}}/buckets/{{bucket_id}}
$ terraform import google_firebase_storage_bucket.default {{project}}/{{bucket_id}}
$ terraform import google_firebase_storage_bucket.default {{bucket_id}}
```
## User Project Overrides
This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override).