/** * Copyright 2025 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ variable "autoclass" { description = "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." type = bool default = null } variable "bucket_create" { description = "Create bucket." type = bool nullable = false default = true } variable "context" { description = "Context-specific interpolations." type = object({ condition_vars = optional(map(map(string)), {}) custom_roles = optional(map(string), {}) iam_principals = optional(map(string), {}) kms_keys = optional(map(string), {}) locations = optional(map(string), {}) project_ids = optional(map(string), {}) storage_buckets = optional(map(string), {}) tag_values = optional(map(string), {}) tag_vars = optional(object({ projects = optional(map(map(string)), {}) organization = optional(map(string), {}) }), {}) }) default = {} nullable = false } variable "cors" { description = "CORS configuration for the bucket. Defaults to null." type = object({ origin = optional(list(string)) method = optional(list(string)) response_header = optional(list(string)) max_age_seconds = optional(number) }) default = null } variable "custom_placement_config" { type = list(string) default = null description = "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." } variable "default_event_based_hold" { description = "Enable event based hold to new objects added to specific bucket, defaults to false." type = bool default = null } variable "enable_hierarchical_namespace" { description = "Enables hierarchical namespace." type = bool default = null } variable "enable_object_retention" { description = "Enables object retention on a storage bucket." type = bool default = null } variable "encryption_key" { description = "KMS key that will be used for encryption." type = string default = null } variable "force_destroy" { description = "Optional map to set force destroy keyed by name, defaults to false." type = bool default = false } variable "ip_filter" { description = "The bucket's IP filter configuration." type = object({ allow_cross_org_vpcs = optional(bool) allow_all_service_agent_access = optional(bool) public_network_sources = optional(list(string)) vpc_network_sources = optional(map(list(string)), {}) }) default = null } variable "kms_autokeys" { description = "KMS Autokey key handles. If location is not specified the bucket location will be used. Key handle names will be added to the kms_keys context with an `autokeys/` prefix." type = map(object({ location = optional(string) resource_type_selector = optional(string, "storage.googleapis.com/Bucket") })) nullable = false default = {} validation { condition = alltrue([ for k, v in var.kms_autokeys : k == try(regex( "^[a-z][a-z0-9-]+[a-z0-9]$", k ), null) ]) error_message = "Autokey keys need to be valid GCP resource names." } } variable "labels" { description = "Labels to be attached to all buckets." type = map(string) default = {} } variable "lifecycle_rules" { description = "Bucket lifecycle rule." type = 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" }) })) default = {} nullable = false validation { condition = alltrue([ for k, v in var.lifecycle_rules : v.action != null && v.condition != null ]) error_message = "Lifecycle rules action and condition cannot be null." } validation { condition = alltrue([ for k, v in var.lifecycle_rules : contains( ["Delete", "SetStorageClass", "AbortIncompleteMultipartUpload"], v.action.type ) ]) error_message = "Lifecycle rules action type has unsupported value." } validation { condition = alltrue([ for k, v in var.lifecycle_rules : v.action.type != "SetStorageClass" || v.action.storage_class != null ]) error_message = "Lifecycle rules with action type SetStorageClass require a storage class." } } variable "location" { description = "Bucket location." type = string default = null validation { condition = var.bucket_create != true || var.location != null error_message = "Bucket location needs to be defined when creating a bucket." } } variable "logging_config" { description = "Bucket logging configuration." type = object({ log_bucket = string log_object_prefix = optional(string) }) default = null } variable "managed_folders" { description = "Managed folders to create within the bucket in {PATH => CONFIG} format." type = 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) })) })), {}) })) default = {} nullable = false } variable "name" { description = "Bucket name suffix." type = string } variable "notification_config" { description = "GCS Notification configuration." type = object({ enabled = bool payload_format = string sa_email = string topic_name = string create_topic = optional(object({ create = optional(bool, true) kms_key_id = optional(string) }), {}) event_types = optional(list(string)) custom_attributes = optional(map(string)) object_name_prefix = optional(string) }) default = null } variable "objects_to_upload" { description = "Objects to be uploaded to bucket." type = 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 })) })) default = {} nullable = false } variable "prefix" { description = "Optional prefix used to generate the bucket name." type = string default = null validation { condition = var.prefix != "" error_message = "Prefix cannot be empty, please use null instead." } } variable "project_id" { description = "Bucket project id. Only required when creating buckets, or notification config topics." type = string nullable = true default = null validation { condition = ( var.bucket_create != true || var.project_id != null ) error_message = "Project id needs to be defined when creating a bucket." } validation { condition = ( try(var.notification_config.create_topic.create, null) != true || var.project_id != null ) error_message = "Project id needs to be defined when creating a notification topic." } } variable "public_access_prevention" { description = "Prevents public access to the bucket." type = string default = null validation { condition = var.public_access_prevention == null || contains(["enforced", "inherited"], coalesce(var.public_access_prevention, "none")) error_message = "public_access_prevention must be either enforced or inherited." } } variable "requester_pays" { description = "Enables Requester Pays on a storage bucket." type = bool default = null } variable "retention_policy" { description = "Bucket retention policy." type = object({ retention_period = string is_locked = optional(bool) }) default = null } variable "rpo" { description = "Bucket recovery point objective." type = string default = null validation { condition = var.rpo == null || contains(["ASYNC_TURBO", "DEFAULT"], coalesce(var.rpo, "none")) error_message = "rpo must be one of ASYNC_TURBO, DEFAULT." } } variable "soft_delete_retention" { description = "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." type = number default = null } variable "storage_class" { description = "Bucket storage class." type = string default = "STANDARD" validation { condition = contains(["STANDARD", "MULTI_REGIONAL", "REGIONAL", "NEARLINE", "COLDLINE", "ARCHIVE"], var.storage_class) error_message = "Storage class must be one of STANDARD, MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE." } } variable "tag_bindings" { description = "Tag bindings for this folder, in key => tag value id format." type = map(string) nullable = false default = {} } variable "uniform_bucket_level_access" { description = "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)." type = bool default = true } variable "versioning" { description = "Enable versioning, defaults to false." type = bool default = null } variable "website" { description = "Bucket website." type = object({ main_page_suffix = optional(string) not_found_page = optional(string) }) default = null }