| --- |
| # ---------------------------------------------------------------------------- |
| # |
| # *** 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: "BigQuery Reservation" |
| description: |- |
| Represents a BI Reservation. |
| --- |
| |
| # google\_bigquery\_bi\_reservation |
| |
| Represents a BI Reservation. |
| |
| |
| To get more information about BiReservation, see: |
| |
| * [API documentation](https://cloud.google.com/bigquery/docs/reference/reservations/rest/v1/BiReservation) |
| * How-to Guides |
| * [Introduction to Reservations](https://cloud.google.com/bigquery/docs/reservations-intro) |
| |
| <div class = "oics-button" style="float: right; margin: 0 0 -15px"> |
| <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=bigquery_reservation_bi_reservation_basic&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank"> |
| <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;"> |
| </a> |
| </div> |
| ## Example Usage - Bigquery Reservation Bi Reservation Basic |
| |
| |
| ```hcl |
| resource "google_bigquery_bi_reservation" "reservation" { |
| location = "us-west2" |
| size = "3000000000" |
| } |
| ``` |
| |
| ## Argument Reference |
| |
| The following arguments are supported: |
| |
| |
| * `location` - |
| (Required) |
| LOCATION_DESCRIPTION |
| |
| |
| - - - |
| |
| |
| * `size` - |
| (Optional) |
| Size of a reservation, in bytes. |
| |
| * `preferred_tables` - |
| (Optional) |
| Preferred tables to use BI capacity for. |
| Structure is [documented below](#nested_preferred_tables). |
| |
| * `project` - (Optional) The ID of the project in which the resource belongs. |
| If it is not provided, the provider project is used. |
| |
| |
| <a name="nested_preferred_tables"></a>The `preferred_tables` block supports: |
| |
| * `project_id` - |
| (Optional) |
| The assigned project ID of the project. |
| |
| * `dataset_id` - |
| (Optional) |
| The ID of the dataset in the above project. |
| |
| * `table_id` - |
| (Optional) |
| The ID of the table in the above dataset. |
| |
| ## 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}}/locations/{{location}}/biReservation` |
| |
| * `name` - |
| The resource name of the singleton BI reservation. Reservation names have the form `projects/{projectId}/locations/{locationId}/biReservation`. |
| |
| * `update_time` - |
| The last update timestamp of a reservation. |
| A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". |
| |
| |
| ## 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. |
| - `update` - Default is 20 minutes. |
| - `delete` - Default is 20 minutes. |
| |
| ## Import |
| |
| |
| BiReservation can be imported using any of these accepted formats: |
| |
| * `projects/{{project}}/locations/{{location}}/biReservation` |
| * `{{project}}/{{location}}` |
| * `{{location}}` |
| |
| |
| In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import BiReservation using one of the formats above. For example: |
| |
| ```tf |
| import { |
| id = "projects/{{project}}/locations/{{location}}/biReservation" |
| to = google_bigquery_bi_reservation.default |
| } |
| ``` |
| |
| When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), BiReservation can be imported using one of the formats above. For example: |
| |
| ``` |
| $ terraform import google_bigquery_bi_reservation.default projects/{{project}}/locations/{{location}}/biReservation |
| $ terraform import google_bigquery_bi_reservation.default {{project}}/{{location}} |
| $ terraform import google_bigquery_bi_reservation.default {{location}} |
| ``` |
| |
| ## User Project Overrides |
| |
| This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override). |