Google Cloud Storage Module
TODO
Example
module "bucket" {
source = "./modules/gcs"
project_id = "myproject"
prefix = "test"
name = "my-bucket"
iam = {
"roles/storage.admin" = ["group:storage@example.com"]
}
}
# tftest:modules=1:resources=2
Example with Cloud KMS
module "bucket" {
source = "./modules/gcs"
project_id = "myproject"
prefix = "test"
name = "my-bucket"
iam = {
"roles/storage.admin" = ["group:storage@example.com"]
}
encryption_key = "my-encryption-key"
}
# tftest:modules=1:resources=2
Example with retention policy
module "bucket" {
source = "./modules/gcs"
project_id = "myproject"
prefix = "test"
name = "my-bucket"
iam = {
"roles/storage.admin" = ["group:storage@example.com"]
}
retention_policy = {
retention_period = 100
is_locked = true
}
logging_config = {
log_bucket = var.bucket
log_object_prefix = null
}
}
# tftest:modules=1:resources=2
Variables
name |
description |
type |
required |
default |
name |
Bucket name suffix. |
string |
✓ |
|
project_id |
Bucket project id. |
string |
✓ |
|
cors |
CORS configuration for the bucket. Defaults to null. |
object({...}) |
|
null |
encryption_key |
KMS key that will be used for encryption. |
string |
|
null |
force_destroy |
Optional map to set force destroy keyed by name, defaults to false. |
bool |
|
false |
iam |
IAM bindings in {ROLE => [MEMBERS]} format. |
map(list(string)) |
|
{} |
labels |
Labels to be attached to all buckets. |
map(string) |
|
{} |
location |
Bucket location. |
string |
|
EU |
logging_config |
Bucket logging configuration. |
object({...}) |
|
null |
prefix |
Prefix used to generate the bucket name. |
string |
|
null |
retention_policy |
Bucket retention policy. |
object({...}) |
|
null |
storage_class |
Bucket storage class. |
string |
|
... |
uniform_bucket_level_access |
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). |
bool |
|
true |
versioning |
Enable versioning, defaults to false. |
bool |
|
false |
Outputs
name |
description |
sensitive |
bucket |
Bucket resource. |
|
name |
Bucket name. |
|
url |
Bucket URL. |
|