2020-05-11 08:51:00 -07:00
# 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.
## Examples
### Simple topic with IAM
```hcl
module "pubsub" {
source = "./modules/pubsub"
2020-05-28 23:08:09 -07:00
project_id = "my-project"
2020-05-11 08:51:00 -07:00
name = "my-topic"
2020-11-05 12:28:34 -08:00
iam = {
2020-05-11 08:51:00 -07:00
"roles/pubsub.viewer" = ["group:foo@example.com"]
"roles/pubsub.subscriber" = ["user:user1@example.com"]
}
2020-05-28 23:07:08 -07:00
}
2022-01-28 11:15:35 -08:00
# tftest modules=1 resources=3
2020-05-11 08:51:00 -07:00
```
### 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 = "./modules/pubsub"
2020-11-06 00:36:32 -08:00
project_id = "my-project"
2020-05-11 08:51:00 -07:00
name = "my-topic"
subscriptions = {
test-pull = null
test-pull-override = {
labels = { test = "override" }
options = {
ack_deadline_seconds = null
message_retention_duration = null
retain_acked_messages = true
expiration_policy_ttl = null
}
}
}
}
2022-01-28 11:15:35 -08:00
# tftest modules=1 resources=3
2020-05-11 08:51:00 -07:00
```
### Push subscriptions
Push subscriptions need extra configuration in the `push_configs` variable.
```hcl
module "pubsub" {
source = "./modules/pubsub"
2020-11-06 00:36:32 -08:00
project_id = "my-project"
2020-05-11 08:51:00 -07:00
name = "my-topic"
subscriptions = {
test-push = null
}
push_configs = {
test-push = {
endpoint = "https://example.com/foo"
attributes = null
oidc_token = null
}
}
}
2022-01-28 11:15:35 -08:00
# tftest modules=1 resources=2
2020-05-11 08:51:00 -07:00
```
### Subscriptions with IAM
```hcl
module "pubsub" {
source = "./modules/pubsub"
2020-11-06 00:36:32 -08:00
project_id = "my-project"
2020-05-11 08:51:00 -07:00
name = "my-topic"
subscriptions = {
test-1 = null
test-1 = null
}
2020-11-05 12:28:34 -08:00
subscription_iam = {
2020-05-11 08:51:00 -07:00
test-1 = {
"roles/pubsub.subscriber" = ["user:user1@ludomagno.net"]
}
}
}
2022-01-28 11:15:35 -08:00
# tftest modules=1 resources=3
2020-05-11 08:51:00 -07:00
```
<!-- BEGIN TFDOC -->
2021-12-20 23:51:51 -08:00
2020-05-11 08:51:00 -07:00
## Variables
| name | description | type | required | default |
2021-12-20 23:51:51 -08:00
|---|---|:---:|:---:|:---:|
2022-01-22 04:34:35 -08:00
| [name ](variables.tf#L60 ) | PubSub topic name. | < code > string</ code > | ✓ | |
| [project_id ](variables.tf#L65 ) | Project used for resources. | < code > string</ code > | ✓ | |
| [dead_letter_configs ](variables.tf#L17 ) | Per-subscription dead letter policy configuration. | < code title = "map(object({ topic = string max_delivery_attempts = number }))" > map( object({…})) </ code > | | < code > {} </ code > |
| [defaults ](variables.tf#L26 ) | Subscription defaults for options. | < code title = "object({ ack_deadline_seconds = number message_retention_duration = string retain_acked_messages = bool expiration_policy_ttl = string })" > object({…}) </ code > | | < code title = "{ ack_deadline_seconds = null message_retention_duration = null retain_acked_messages = null expiration_policy_ttl = null }" > {…} </ code > |
| [iam ](variables.tf#L42 ) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | < code > map( list( string)) </ code > | | < code > {} </ code > |
| [kms_key ](variables.tf#L48 ) | KMS customer managed encryption key. | < code > string</ code > | | < code > null</ code > |
| [labels ](variables.tf#L54 ) | Labels. | < code > map( string) </ code > | | < code > {} </ code > |
| [push_configs ](variables.tf#L70 ) | Push subscription configurations. | < code title = "map(object({ attributes = map(string) endpoint = string oidc_token = object({ audience = string service_account_email = string }) }))" > map( object({…})) </ code > | | < code > {} </ code > |
| [regions ](variables.tf#L83 ) | List of regions used to set persistence policy. | < code > list( string) </ code > | | < code > [] </ code > |
| [subscription_iam ](variables.tf#L89 ) | IAM bindings for subscriptions in {SUBSCRIPTION => {ROLE => [MEMBERS]}} format. | < code > map( map( list( string))) </ code > | | < code > {} </ code > |
| [subscriptions ](variables.tf#L95 ) | 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. | < code title = "map(object({ labels = map(string) options = object({ ack_deadline_seconds = number message_retention_duration = string retain_acked_messages = bool expiration_policy_ttl = string }) }))" > map( object({…})) </ code > | | < code > {} </ code > |
2020-05-11 08:51:00 -07:00
## Outputs
| name | description | sensitive |
|---|---|:---:|
2022-01-22 04:34:35 -08:00
| [id ](outputs.tf#L17 ) | Topic id. | |
| [subscription_id ](outputs.tf#L25 ) | Subscription ids. | |
| [subscriptions ](outputs.tf#L35 ) | Subscription resources. | |
| [topic ](outputs.tf#L43 ) | Topic resource. | |
2021-12-20 23:51:51 -08:00
2020-05-11 08:51:00 -07:00
<!-- END TFDOC -->