# Google Cloud Storage Module
## TODO
- [ ] add support for defining [notifications](https://www.terraform.io/docs/providers/google/r/storage_notification.html)
## Example
```hcl
module "bucket" {
source = "./modules/gcs"
project_id = "myproject"
prefix = "test"
name = "my-bucket"
iam = {
"roles/storage.admin" = ["group:storage@example.com"]
}
}
```
### Example with Cloud KMS
```hcl
module "bucket" {
source = "./modules/gcs"
project_id = "myproject"
prefix = "test"
name = "my-bucket"
iam = {
"roles/storage.admin" = ["group:storage@example.com"]
}
encryption_keys = local.kms_key.self_link
}
```
### Example with retention policy
```hcl
module "bucket" {
source = "./modules/gcs"
project_id = "myproject"
prefix = "test"
name = "my-bucket"
iam = {
"roles/storage.admin" = ["group:storage@example.com"]
}
retention_policies = {
retention_period = 100
is_locked = true
}
logging_config = {
log_bucket = bucket_name_for_logging
log_object_prefix = null
}
}
```
## Variables
| name | description | type | required | default |
|---|---|:---: |:---:|:---:|
| name | Bucket name suffix. | string
| ✓ | |
| project_id | Bucket project id. | string
| ✓ | |
| *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_members* | IAM members keyed by bucket name and role. | map(set(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. | |