# Google Cloud Pub/Sub Module
This module allows managing a single Pub/Sub topic, including multiple subscriptions and IAM bindings at the topic and subscriptions levels, as well as schemas.
## Examples
### Simple topic with IAM
```hcl
module "pubsub" {
source = "./fabric/modules/pubsub"
project_id = "my-project"
name = "my-topic"
iam = {
"roles/pubsub.viewer" = ["group:foo@example.com"]
"roles/pubsub.subscriber" = ["user:user1@example.com"]
}
}
# tftest modules=1 resources=3 inventory=simple.yaml
```
### Topic with schema
```hcl
module "topic_with_schema" {
source = "./fabric/modules/pubsub"
project_id = "my-project"
name = "my-topic"
schema = {
msg_encoding = "JSON"
schema_type = "AVRO"
definition = jsonencode({
"type" = "record",
"name" = "Avro",
"fields" = [{
"name" = "StringField",
"type" = "string"
},
{
"name" = "FloatField",
"type" = "float"
},
{
"name" = "BooleanField",
"type" = "boolean"
},
]
})
}
}
# tftest modules=1 resources=2 inventory=schema.yaml
```
### Subscriptions
Subscriptions are defined with the `subscriptions` variable, allowing optional configuration of per-subscription defaults. Push subscriptions need extra configuration, shown in the following example.
```hcl
module "pubsub" {
source = "./fabric/modules/pubsub"
project_id = "my-project"
name = "my-topic"
subscriptions = {
test-pull = {}
test-pull-override = {
labels = { test = "override" }
retain_acked_messages = true
}
}
}
# tftest modules=1 resources=3 inventory=subscriptions.yaml
```
### Push subscriptions
Push subscriptions need extra configuration in the `push_configs` variable.
```hcl
module "pubsub" {
source = "./fabric/modules/pubsub"
project_id = "my-project"
name = "my-topic"
subscriptions = {
test-push = {
push = {
endpoint = "https://example.com/foo"
}
}
}
}
# tftest modules=1 resources=2
```
### BigQuery subscriptions
BigQuery subscriptions need extra configuration in the `bigquery_subscription_configs` variable.
```hcl
module "pubsub" {
source = "./fabric/modules/pubsub"
project_id = "my-project"
name = "my-topic"
subscriptions = {
test-bigquery = {
bigquery = {
table = "my_project_id:my_dataset.my_table"
use_topic_schema = true
write_metadata = false
drop_unknown_fields = true
}
}
}
}
# tftest modules=1 resources=2
```
### Cloud Storage subscriptions
Cloud Storage subscriptions need extra configuration in the `cloud_storage_subscription_configs` variable.
```hcl
module "pubsub" {
source = "./fabric/modules/pubsub"
project_id = "my-project"
name = "my-topic"
subscriptions = {
test-cloudstorage = {
cloud_storage = {
bucket = "my-bucket"
filename_prefix = "test_prefix"
filename_suffix = "test_suffix"
max_duration = "100s"
max_bytes = 1000
avro_config = {
write_metadata = true
}
}
}
}
}
# tftest modules=1 resources=2
```
### Subscriptions with IAM
```hcl
module "pubsub" {
source = "./fabric/modules/pubsub"
project_id = "my-project"
name = "my-topic"
subscriptions = {
test-1 = {
iam = {
"roles/pubsub.subscriber" = ["user:user1@example.com"]
}
}
}
}
# tftest modules=1 resources=3
```
## Variables
| name | description | type | required | default |
|---|---|:---:|:---:|:---:|
| [name](variables.tf#L73) | PubSub topic name. | string | ✓ | |
| [project_id](variables.tf#L78) | Project used for resources. | string | ✓ | |
| [iam](variables.tf#L17) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} |
| [iam_bindings](variables.tf#L24) | Authoritative IAM bindings in {KEY => {role = ROLE, members = [], condition = {}}}. Keys are arbitrary. | map(object({…})) | | {} |
| [iam_bindings_additive](variables.tf#L39) | Keyring individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} |
| [kms_key](variables.tf#L54) | KMS customer managed encryption key. | string | | null |
| [labels](variables.tf#L60) | Labels. | map(string) | | {} |
| [message_retention_duration](variables.tf#L67) | Minimum duration to retain a message after it is published to the topic. | string | | null |
| [regions](variables.tf#L83) | List of regions used to set persistence policy. | list(string) | | [] |
| [schema](variables.tf#L90) | Topic schema. If set, all messages in this topic should follow this schema. | object({…}) | | null |
| [subscriptions](variables.tf#L100) | Topic subscriptions. Also define push configs for push subscriptions. If options is set to null subscription defaults will be used. Labels default to topic labels if set to null. | map(object({…})) | | {} |
## Outputs
| name | description | sensitive |
|---|---|:---:|
| [id](outputs.tf#L17) | Fully qualified topic id. | |
| [schema](outputs.tf#L27) | Schema resource. | |
| [schema_id](outputs.tf#L32) | Schema resource id. | |
| [subscription_id](outputs.tf#L37) | Subscription ids. | |
| [subscriptions](outputs.tf#L48) | Subscription resources. | |
| [topic](outputs.tf#L57) | Topic resource. | |