|
| 1 | +--- |
| 2 | +# ---------------------------------------------------------------------------- |
| 3 | +# |
| 4 | +# *** AUTO GENERATED CODE *** Type: MMv1 *** |
| 5 | +# |
| 6 | +# ---------------------------------------------------------------------------- |
| 7 | +# |
| 8 | +# This file is automatically generated by Magic Modules and manual |
| 9 | +# changes will be clobbered when the file is regenerated. |
| 10 | +# |
| 11 | +# Please read more about how to change this file in |
| 12 | +# .github/CONTRIBUTING.md. |
| 13 | +# |
| 14 | +# ---------------------------------------------------------------------------- |
| 15 | +subcategory: "Cloud Storage for Firebase" |
| 16 | +page_title: "Google: google_firebase_storage_bucket" |
| 17 | +description: |- |
| 18 | + An association between a Firebase project and a Google Cloud Storage bucket. |
| 19 | +--- |
| 20 | + |
| 21 | +# google\_firebase\_storage\_bucket |
| 22 | + |
| 23 | +An association between a Firebase project and a Google Cloud Storage bucket. |
| 24 | +This association enables integration of Cloud Storage buckets with Firebase such as Firebase SDKS, Authentication, and Security Rules. |
| 25 | + |
| 26 | +~> **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. |
| 27 | +See [Provider Versions](https://terraform.io/docs/providers/google/guides/provider_versions.html) for more details on beta resources. |
| 28 | + |
| 29 | +To get more information about Bucket, see: |
| 30 | + |
| 31 | +* [API documentation](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets) |
| 32 | +* How-to Guides |
| 33 | + * [Official Documentation](https://firebase.google.com/docs/storage/) |
| 34 | + |
| 35 | +## Example Usage - Firebasestorage Bucket Basic |
| 36 | + |
| 37 | + |
| 38 | +```hcl |
| 39 | +resource "google_storage_bucket" "default" { |
| 40 | + provider = google-beta |
| 41 | + name = "test_bucket" |
| 42 | + location = "US" |
| 43 | + uniform_bucket_level_access = true |
| 44 | +} |
| 45 | +
|
| 46 | +resource "google_firebase_storage_bucket" "default" { |
| 47 | + provider = google-beta |
| 48 | + project = "my-project-name" |
| 49 | + bucket_id = google_storage_bucket.default.id |
| 50 | +} |
| 51 | +``` |
| 52 | + |
| 53 | +## Argument Reference |
| 54 | + |
| 55 | +The following arguments are supported: |
| 56 | + |
| 57 | + |
| 58 | + |
| 59 | +- - - |
| 60 | + |
| 61 | + |
| 62 | +* `bucket_id` - |
| 63 | + (Optional) |
| 64 | + Required. Immutable. The ID of the underlying Google Cloud Storage bucket |
| 65 | + |
| 66 | +* `project` - (Optional) The ID of the project in which the resource belongs. |
| 67 | + If it is not provided, the provider project is used. |
| 68 | + |
| 69 | + |
| 70 | +## Attributes Reference |
| 71 | + |
| 72 | +In addition to the arguments listed above, the following computed attributes are exported: |
| 73 | + |
| 74 | +* `id` - an identifier for the resource with format `projects/{{project}}/buckets/{{bucket_id}}` |
| 75 | + |
| 76 | +* `name` - |
| 77 | + Resource name of the bucket in the format projects/PROJECT_IDENTIFIER/buckets/BUCKET_ID |
| 78 | + |
| 79 | + |
| 80 | +## Timeouts |
| 81 | + |
| 82 | +This resource provides the following |
| 83 | +[Timeouts](/docs/configuration/resources.html#timeouts) configuration options: |
| 84 | + |
| 85 | +- `create` - Default is 20 minutes. |
| 86 | +- `delete` - Default is 20 minutes. |
| 87 | + |
| 88 | +## Import |
| 89 | + |
| 90 | + |
| 91 | +Bucket can be imported using any of these accepted formats: |
| 92 | + |
| 93 | +``` |
| 94 | +$ terraform import google_firebase_storage_bucket.default projects/{{project}}/buckets/{{bucket_id}} |
| 95 | +$ terraform import google_firebase_storage_bucket.default {{project}}/{{bucket_id}} |
| 96 | +$ terraform import google_firebase_storage_bucket.default {{bucket_id}} |
| 97 | +``` |
| 98 | + |
| 99 | +## User Project Overrides |
| 100 | + |
| 101 | +This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override). |
0 commit comments