|
|
|
|
@@ -9,6 +9,7 @@
|
|
|
|
|
- [Object upload](#object-upload)
|
|
|
|
|
- [IAM](#iam)
|
|
|
|
|
- [Tag Bindings](#tag-bindings)
|
|
|
|
|
- [Managed Folders](#managed-folders)
|
|
|
|
|
- [Variables](#variables)
|
|
|
|
|
- [Outputs](#outputs)
|
|
|
|
|
<!-- END TOC -->
|
|
|
|
|
@@ -281,15 +282,37 @@ module "bucket" {
|
|
|
|
|
}
|
|
|
|
|
# tftest modules=2 resources=6
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Managed Folders
|
|
|
|
|
```hcl
|
|
|
|
|
module "bucket" {
|
|
|
|
|
source = "./fabric/modules/gcs"
|
|
|
|
|
project_id = var.project_id
|
|
|
|
|
prefix = var.prefix
|
|
|
|
|
name = "my-bucket"
|
|
|
|
|
location = "EU"
|
|
|
|
|
managed_folders = {
|
|
|
|
|
folder1 = {
|
|
|
|
|
iam = {
|
|
|
|
|
"roles/storage.admin" = ["user:user1@example.com"]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
"folder1/subfolder" = {
|
|
|
|
|
force_destroy = true
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
# tftest inventory=managed-folders.yaml
|
|
|
|
|
```
|
|
|
|
|
<!-- BEGIN TFDOC -->
|
|
|
|
|
## Variables
|
|
|
|
|
|
|
|
|
|
| name | description | type | required | default |
|
|
|
|
|
|---|---|:---:|:---:|:---:|
|
|
|
|
|
| [location](variables.tf#L149) | Bucket location. | <code>string</code> | ✓ | |
|
|
|
|
|
| [name](variables.tf#L164) | Bucket name suffix. | <code>string</code> | ✓ | |
|
|
|
|
|
| [project_id](variables.tf#L220) | Bucket project id. | <code>string</code> | ✓ | |
|
|
|
|
|
| [autoclass](variables.tf#L17) | Enable autoclass to automatically transition objects to appropriate storage classes based on their access pattern. If set to true, storage_class must be set to STANDARD. Defaults to false. | <code>bool</code> | | <code>false</code> |
|
|
|
|
|
| [location](variables.tf#L156) | Bucket location. | <code>string</code> | ✓ | |
|
|
|
|
|
| [name](variables.tf#L199) | Bucket name suffix. | <code>string</code> | ✓ | |
|
|
|
|
|
| [project_id](variables.tf#L255) | Bucket project id. | <code>string</code> | ✓ | |
|
|
|
|
|
| [autoclass](variables.tf#L17) | Enable autoclass to automatically transition objects to appropriate storage classes based on their access pattern. If set to true, storage_class must be set to STANDARD. Defaults to false. | <code>bool</code> | | <code>null</code> |
|
|
|
|
|
| [cors](variables.tf#L23) | CORS configuration for the bucket. Defaults to null. | <code title="object({ origin = optional(list(string)) method = optional(list(string)) response_header = optional(list(string)) max_age_seconds = optional(number) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
| [custom_placement_config](variables.tf#L34) | The bucket's custom location configuration, which specifies the individual regions that comprise a dual-region bucket. If the bucket is designated as REGIONAL or MULTI_REGIONAL, the parameters are empty. | <code>list(string)</code> | | <code>null</code> |
|
|
|
|
|
| [default_event_based_hold](variables.tf#L40) | Enable event based hold to new objects added to specific bucket, defaults to false. | <code>bool</code> | | <code>null</code> |
|
|
|
|
|
@@ -298,21 +321,24 @@ module "bucket" {
|
|
|
|
|
| [iam](variables.tf#L58) | IAM bindings in {ROLE => [MEMBERS]} format. | <code>map(list(string))</code> | | <code>{}</code> |
|
|
|
|
|
| [iam_bindings](variables.tf#L64) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | <code title="map(object({ members = list(string) role = string condition = optional(object({ expression = string title = string description = optional(string) })) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [iam_bindings_additive](variables.tf#L79) | Individual additive IAM bindings. Keys are arbitrary. | <code title="map(object({ member = string role = string condition = optional(object({ expression = string title = string description = optional(string) })) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [labels](variables.tf#L94) | Labels to be attached to all buckets. | <code>map(string)</code> | | <code>{}</code> |
|
|
|
|
|
| [lifecycle_rules](variables.tf#L100) | Bucket lifecycle rule. | <code title="map(object({ action = object({ type = string storage_class = optional(string) }) condition = object({ age = optional(number) created_before = optional(string) custom_time_before = optional(string) days_since_custom_time = optional(number) days_since_noncurrent_time = optional(number) matches_prefix = optional(list(string)) matches_storage_class = optional(list(string)) # STANDARD, MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, DURABLE_REDUCED_AVAILABILITY matches_suffix = optional(list(string)) noncurrent_time_before = optional(string) num_newer_versions = optional(number) with_state = optional(string) # "LIVE", "ARCHIVED", "ANY" }) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [logging_config](variables.tf#L155) | Bucket logging configuration. | <code title="object({ log_bucket = string log_object_prefix = optional(string) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
| [notification_config](variables.tf#L169) | GCS Notification configuration. | <code title="object({ enabled = bool payload_format = string topic_name = string sa_email = string create_topic = optional(bool, true) event_types = optional(list(string)) custom_attributes = optional(map(string)) object_name_prefix = optional(string) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
| [objects_to_upload](variables.tf#L184) | Objects to be uploaded to bucket. | <code title="map(object({ name = string metadata = optional(map(string)) content = optional(string) source = optional(string) cache_control = optional(string) content_disposition = optional(string) content_encoding = optional(string) content_language = optional(string) content_type = optional(string) event_based_hold = optional(bool) temporary_hold = optional(bool) detect_md5hash = optional(string) storage_class = optional(string) kms_key_name = optional(string) customer_encryption = optional(object({ encryption_algorithm = optional(string) encryption_key = string })) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [prefix](variables.tf#L210) | Optional prefix used to generate the bucket name. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [public_access_prevention](variables.tf#L225) | Prevents public access to a bucket. Acceptable values are inherited or enforced. If inherited, the bucket uses public access prevention, only if the bucket is subject to the public access prevention organization policy constraint. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [requester_pays](variables.tf#L231) | Enables Requester Pays on a storage bucket. | <code>bool</code> | | <code>null</code> |
|
|
|
|
|
| [retention_policy](variables.tf#L237) | Bucket retention policy. | <code title="object({ retention_period = number is_locked = optional(bool) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
| [soft_delete_retention](variables.tf#L246) | The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. Set to 0 to override the default and disable. | <code>number</code> | | <code>null</code> |
|
|
|
|
|
| [storage_class](variables.tf#L252) | Bucket storage class. | <code>string</code> | | <code>"MULTI_REGIONAL"</code> |
|
|
|
|
|
| [tag_bindings](variables.tf#L262) | Tag bindings for this folder, in key => tag value id format. | <code>map(string)</code> | | <code>{}</code> |
|
|
|
|
|
| [uniform_bucket_level_access](variables.tf#L269) | Allow using object ACLs (false) or not (true, this is the recommended behavior) , defaults to true (which is the recommended practice, but not the behavior of storage API). | <code>bool</code> | | <code>true</code> |
|
|
|
|
|
| [versioning](variables.tf#L275) | Enable versioning, defaults to false. | <code>bool</code> | | <code>false</code> |
|
|
|
|
|
| [website](variables.tf#L281) | Bucket website. | <code title="object({ main_page_suffix = optional(string) not_found_page = optional(string) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
| [iam_by_principals](variables.tf#L94) | Authoritative IAM binding in {PRINCIPAL => [ROLES]} format. Principals need to be statically defined to avoid cycle errors. Merged internally with the `iam` variable. | <code>map(list(string))</code> | | <code>{}</code> |
|
|
|
|
|
| [labels](variables.tf#L101) | Labels to be attached to all buckets. | <code>map(string)</code> | | <code>{}</code> |
|
|
|
|
|
| [lifecycle_rules](variables.tf#L107) | Bucket lifecycle rule. | <code title="map(object({ action = object({ type = string storage_class = optional(string) }) condition = object({ age = optional(number) created_before = optional(string) custom_time_before = optional(string) days_since_custom_time = optional(number) days_since_noncurrent_time = optional(number) matches_prefix = optional(list(string)) matches_storage_class = optional(list(string)) # STANDARD, MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, DURABLE_REDUCED_AVAILABILITY matches_suffix = optional(list(string)) noncurrent_time_before = optional(string) num_newer_versions = optional(number) with_state = optional(string) # "LIVE", "ARCHIVED", "ANY" }) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [logging_config](variables.tf#L162) | Bucket logging configuration. | <code title="object({ log_bucket = string log_object_prefix = optional(string) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
| [managed_folders](variables.tf#L171) | Managed folders to create within the bucket in {PATH => CONFIG} format. | <code title="map(object({ force_destroy = optional(bool, false) iam = optional(map(list(string)), {}) iam_bindings = optional(map(object({ members = list(string) role = string condition = optional(object({ expression = string title = string description = optional(string) })) })), {}) iam_bindings_additive = optional(map(object({ member = string role = string condition = optional(object({ expression = string title = string description = optional(string) })) })), {}) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [notification_config](variables.tf#L204) | GCS Notification configuration. | <code title="object({ enabled = bool payload_format = string topic_name = string sa_email = string create_topic = optional(bool, true) event_types = optional(list(string)) custom_attributes = optional(map(string)) object_name_prefix = optional(string) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
| [objects_to_upload](variables.tf#L219) | Objects to be uploaded to bucket. | <code title="map(object({ name = string metadata = optional(map(string)) content = optional(string) source = optional(string) cache_control = optional(string) content_disposition = optional(string) content_encoding = optional(string) content_language = optional(string) content_type = optional(string) event_based_hold = optional(bool) temporary_hold = optional(bool) detect_md5hash = optional(string) storage_class = optional(string) kms_key_name = optional(string) customer_encryption = optional(object({ encryption_algorithm = optional(string) encryption_key = string })) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [prefix](variables.tf#L245) | Optional prefix used to generate the bucket name. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [public_access_prevention](variables.tf#L260) | Prevents public access to the bucket. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [requester_pays](variables.tf#L270) | Enables Requester Pays on a storage bucket. | <code>bool</code> | | <code>null</code> |
|
|
|
|
|
| [retention_policy](variables.tf#L276) | Bucket retention policy. | <code title="object({ retention_period = number is_locked = optional(bool) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
| [rpo](variables.tf#L285) | Bucket recovery point objective. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [soft_delete_retention](variables.tf#L295) | The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. Set to 0 to override the default and disable. | <code>number</code> | | <code>null</code> |
|
|
|
|
|
| [storage_class](variables.tf#L301) | Bucket storage class. | <code>string</code> | | <code>"STANDARD"</code> |
|
|
|
|
|
| [tag_bindings](variables.tf#L311) | Tag bindings for this folder, in key => tag value id format. | <code>map(string)</code> | | <code>{}</code> |
|
|
|
|
|
| [uniform_bucket_level_access](variables.tf#L318) | Allow using object ACLs (false) or not (true, this is the recommended behavior) , defaults to true (which is the recommended practice, but not the behavior of storage API). | <code>bool</code> | | <code>true</code> |
|
|
|
|
|
| [versioning](variables.tf#L324) | Enable versioning, defaults to false. | <code>bool</code> | | <code>null</code> |
|
|
|
|
|
| [website](variables.tf#L330) | Bucket website. | <code title="object({ main_page_suffix = optional(string) not_found_page = optional(string) })">object({…})</code> | | <code>null</code> |
|
|
|
|
|
|
|
|
|
|
## Outputs
|
|
|
|
|
|
|
|
|
|
|
Julio Castillo