blob: f773237cb8c51f22f9323820e28e8b152bb1acb5 [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 Pub/Sub"
description: |-
A named resource representing a shared pool of capacity.
---
# google\_pubsub\_lite\_reservation
A named resource representing a shared pool of capacity.
To get more information about Reservation, see:
* [API documentation](https://cloud.google.com/pubsub/lite/docs/reference/rest/v1/admin.projects.locations.reservations)
* How-to Guides
* [Managing Reservations](https://cloud.google.com/pubsub/lite/docs/reservations)
<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=pubsub_lite_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 - Pubsub Lite Reservation Basic
```hcl
resource "google_pubsub_lite_reservation" "example" {
name = "example-reservation"
project = data.google_project.project.number
throughput_capacity = 2
}
data "google_project" "project" {
}
```
## Argument Reference
The following arguments are supported:
* `throughput_capacity` -
(Required)
The reserved throughput capacity. Every unit of throughput capacity is
equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed
messages.
* `name` -
(Required)
Name of the reservation.
- - -
* `region` -
(Optional)
The region of the pubsub lite reservation.
* `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}}/locations/{{region}}/reservations/{{name}}`
## 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
Reservation can be imported using any of these accepted formats:
* `projects/{{project}}/locations/{{region}}/reservations/{{name}}`
* `{{project}}/{{region}}/{{name}}`
* `{{region}}/{{name}}`
* `{{name}}`
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Reservation using one of the formats above. For example:
```tf
import {
id = "projects/{{project}}/locations/{{region}}/reservations/{{name}}"
to = google_pubsub_lite_reservation.default
}
```
When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Reservation can be imported using one of the formats above. For example:
```
$ terraform import google_pubsub_lite_reservation.default projects/{{project}}/locations/{{region}}/reservations/{{name}}
$ terraform import google_pubsub_lite_reservation.default {{project}}/{{region}}/{{name}}
$ terraform import google_pubsub_lite_reservation.default {{region}}/{{name}}
$ terraform import google_pubsub_lite_reservation.default {{name}}
```
## User Project Overrides
This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override).