blob: b360a36f91857578563801af386873d0b6c3ec1f [file] [log] [blame]
---
subcategory: "Compute Engine"
description: |-
Manages a project's usage export bucket.
---
# google_project_usage_export_bucket
Sets up a usage export bucket for a particular project. A usage export bucket
is a pre-configured GCS bucket which is set up to receive daily and monthly
reports of the GCE resources used.
For more information see the [Docs](https://cloud.google.com/compute/docs/usage-export)
and for further details, the
[API Documentation](https://cloud.google.com/compute/docs/reference/rest/beta/projects/setUsageExportBucket).
~> **Note:** You should specify only one of these per project. If there are two or more
they will fight over which bucket the reports should be stored in. It is
safe to have multiple resources with the same backing bucket.
## Example Usage
```hcl
resource "google_project_usage_export_bucket" "usage_export" {
project = "development-project"
bucket_name = "usage-tracking-bucket"
}
```
## Argument Reference
* `bucket_name`: (Required) The bucket to store reports in.
- - -
* `prefix`: (Optional) A prefix for the reports, for instance, the project name.
* `project`: (Optional) The project to set the export bucket on. If it is not provided, the provider project is used.
## Timeouts
This resource provides the following
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options: configuration options:
- `create` - Default is 4 minutes.
- `delete` - Default is 4 minutes.
## Import
A project's Usage Export Bucket can be imported using this format:
* `{{project_id}}`
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import NAME_HERE using one of the formats above. For example:
```tf
import {
id = "{{project_id}}"
to = google_project_usage_export_bucket.default
}
```
When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), NAME_HERE can be imported using one of the formats above. For example:
```
$ terraform import google_project_usage_export_bucket.default {{project_id}}
```