terraform-provider-garage/docs/resources/bucket.md

61 lines
1.4 KiB
Markdown
Raw Normal View History

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "garage_bucket Resource - terraform-provider-garage"
subcategory: ""
description: |-
This resource can be used to manage Garage buckets.
---
# garage_bucket (Resource)
This resource can be used to manage Garage buckets.
## Example Usage
```terraform
resource "garage_bucket" "bucket" {}
resource "garage_bucket" "bucket-with-website" {
website_access_enabled = true
website_config_index_document = "index.html"
website_config_error_document = "error.html"
}
resource "garage_bucket" "bucket-with-quota" {
quota_max_size = 1024
quota_max_objects = 100
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Optional
- `quota_max_objects` (Number)
- `quota_max_size` (Number)
- `website_access_enabled` (Boolean)
- `website_config_error_document` (String)
- `website_config_index_document` (String)
### Read-Only
- `bytes` (Number)
- `global_aliases` (List of String)
- `id` (String) The ID of this resource.
- `keys` (Set of Object) (see [below for nested schema](#nestedatt--keys))
- `objects` (Number)
- `unfinished_uploads` (Number)
<a id="nestedatt--keys"></a>
### Nested Schema for `keys`
Read-Only:
- `access_key_id` (String)
- `local_aliases` (List of String)
- `name` (String)
- `permissions_owner` (Boolean)
- `permissions_read` (Boolean)
- `permissions_write` (Boolean)