47 lines
1.6 KiB
Markdown
47 lines
1.6 KiB
Markdown
|
<!-- This readme file is generated with terraform-docs -->
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
| Name | Version |
|
||
|
|
|------|---------|
|
||
|
|
| terraform | >= 1.3.0 |
|
||
|
|
| aws | >= 5.0 |
|
||
|
|
|
||
|
|
## Providers
|
||
|
|
|
||
|
|
| Name | Version |
|
||
|
|
|------|---------|
|
||
|
|
| aws | >= 5.0 |
|
||
|
|
|
||
|
|
## Modules
|
||
|
|
|
||
|
|
No modules.
|
||
|
|
|
||
|
|
## Resources
|
||
|
|
|
||
|
|
| Name | Type |
|
||
|
|
|------|------|
|
||
|
|
| [aws_sns_topic.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic) | resource |
|
||
|
|
| [aws_sns_topic_subscription.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_subscription) | resource |
|
||
|
|
| [aws_caller_identity.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
|
||
|
|
| [aws_region.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
|
||
|
|
|
||
|
|
## Inputs
|
||
|
|
|
||
|
|
| Name | Description | Type | Default | Required |
|
||
|
|
|------|-------------|------|---------|:--------:|
|
||
|
|
| email-addresses | Email recipients of SNS notifications | `set(string)` | n/a | yes |
|
||
|
|
| kms-key-id | KMS key id for SNS topic at-rest encryption. Make sure the sender has access to this key | `string` | n/a | yes |
|
||
|
|
| sender | ARN of SNS sender or sending service name | `string` | n/a | yes |
|
||
|
|
| sender-type | Sender principal type. Value should be either *AWS* or *Service* | `string` | n/a | yes |
|
||
|
|
| sns-topic-description | SNS topic display name | `string` | n/a | yes |
|
||
|
|
| sns-topic-name | Name of SNS topic | `string` | n/a | yes |
|
||
|
|
|
||
|
|
## Outputs
|
||
|
|
|
||
|
|
| Name | Description |
|
||
|
|
|------|-------------|
|
||
|
|
| sns-topic-arn | n/a |
|
||
|
|
|
||
|
|
---
|
||
|
|
## Authorship
|
||
|
|
This module was developed by xpk.
|