Skip to content

pbs/terraform-aws-sns-topic-subscription-module

Repository files navigation

PBS TF SNS Topic Subscription Module

Installation

Using the Repo Source

Use this URL for the source of the module. See the usage examples below for more details.

github.com/pbs/terraform-aws-sns-topic-subscription-module?ref=0.0.17

Alternative Installation Methods

More information can be found on these install methods and more in the documentation here.

Usage

Subscribes an endpoint to an SNS topic.

Integrate this module like so:

module "subscription" {
  source = "github.com/pbs/terraform-aws-sns-topic-subscription-module?ref=0.0.17"

  topic_arn = module.topic.arn
  protocol  = "lambda"
  endpoint  = module.lambda.arn
}

Adding This Version of the Module

If this repo is added as a subtree, then the version of the module should be close to the version shown here:

0.0.17

Note, however that subtrees can be altered as desired within repositories.

Further documentation on usage can be found here.

Below is automatically generated documentation on this Terraform module using terraform-docs


Requirements

Name Version
terraform >= 1.3.2
aws >= 4.5.0

Providers

Name Version
aws 5.24.0

Modules

No modules.

Resources

Name Type
aws_sns_topic_subscription.subscription resource

Inputs

Name Description Type Default Required
endpoint The endpoint to send data to, the contents will vary with the protocol. See this for more info: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription#endpoint. string n/a yes
protocol The protocol to use. See this for more info: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription#protocol. string n/a yes
topic_arn The ARN of the SNS topic to subscribe to string n/a yes

Outputs

Name Description
arn ARN of the subscription