Note: This module is in alpha state and is likely to contain bugs and updates may introduce breaking changes. It is not recommended for production use at this time.
Authors : Rahul Gaikwad ([email protected]), Jomcy Pappachen ([email protected])
This Terraform module will create an Amazon Simple Notification Service (SNS) Topic with other resources.
- deploy/ contains .tf configuration files and
dev.auto.tfvarsto define default variables.
To deploy this module, do the following: Install Terraform. (See Install Terraform for a tutorial.)
Sign up and log into Terraform Cloud. (There is a free tier available.)
Generate terraform cloud token
terraform login
Export the TERRAFORM_CONFIG variable
export TERRAFORM_CONFIG="$HOME/.terraform.d/credentials.tfrc.json"
Example filepath = $HOME/.aws/terraform.tfvars
Example tfvars file contents
AWS_SECRET_ACCESS_KEY = "*****************"
AWS_ACCESS_KEY_ID = "*****************"
AWS_SESSION_TOKEN = "*****************"
(replace *** with AKEY and SKEY)
Note: STS-based credentials are optional but highly recommended.
!!!!CAUTION!!!!: Make sure your credential are secured ourside version control (and follow secrets mangement bestpractices)
Clone the aws-ia/terraform-aws-sns repository.
git clone https://github.com/aws-ia/terraform-aws-sns
Change directory to module root.
cd terraform-aws-sns.
Start by setting up you cloud workspace
cd setup_workspace.
Run to following commands in order:
terraform init
terraform apply or terraform apply -var-file="$HOME/.aws/terraform.tfvars".
Change directory to deploy dir (previous command auto generates backend.hcl)
cd ../deploy
Open dev.auto.tfvars and edit the default values to match your enviornment.
- See Protocols and endpoints later in this document for supported protocols and endpoint examples.
terraform apply or terraform apply -var-file="$HOME/.aws/terraform.tfvars".
Terraform apply is run remotely in Terraform Cloud
The following table shows the endpoint format for each supported protocol.
| Protocol | Endpoint Description | Argument | Endpoint example |
|---|---|---|---|
| Amazon Kinesis Data Firehose | Delivers JSON-encoded messages to an Amazon Kinesis Data Firehose delivery stream. Endpoint is the ARN of a Kinesis Data Firehose delivery stream. | firehose | arn:aws:firehose:us-east-1:123456789012:deliverystream/ticketUploadStream |
| Amazon SQS | Delivers JSON-encoded messages to an Amazon SQS queue. Endpoint is the ARN of an SQS queue. | sqs | arn:aws:sqs:us-west-2:123456789012:terraform-queue-too |
| AWS Lambda | Delivers JSON-encoded messages to an AWS Lambda function. Endpoint is the ARN of an AWS Lambda function. | lambda | arn:aws:lambda:us-east-1:123456789012:function:sample-lambda |
| Delivers messages via SMTP. Endpoint is an email address. | [email protected] | ||
| Email-JSON | Delivers JSON-encoded messages via SMTP. Endpoint is an email address. | email-json | [email protected] |
| HTTP | Delivers JSON-encoded messages via HTTP POST. Endpoint is a URL beginning with http://. | http | http://www.example.com |
| HTTPS | Delivers JSON-encoded messages via HTTPS POST. Endpoint is a URL beginning with https://. | https | https://www.example.com |
| Platform application endpoint | Delivers JSON-encoded messages to an EndpointArn for a mobile app and device. Endpoint is the EndpointArn of a mobile app and device. | application | arn:aws:sns:us-west-2:123456789012:endpoint/ADM/MyApplication/abcd1efg2hi4jk6lmnopqr |
| SMS | Delivers text messages via SMS. Endpoint is the phone number of an SMS-enabled device. | sms | +91 1234567890 |