From 60a55ffab24b088b49200b178a2e7d6002abe70f Mon Sep 17 00:00:00 2001
From: David Timber <dxdt@dev.snart.me>
Date: Fri, 20 May 2022 12:16:44 +0800
Subject: Refactor, add AWS SNS MUA ...

- Refactor BootReport
- Modularise MUA impls
- Refactor setup_conf()
- Add missing info from __str__() funcs
- Doc AWS SNS MUA
---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 0a41adb..9e643bf 100644
--- a/README.md
+++ b/README.md
@@ -234,6 +234,26 @@ or a rc.d script on SysVinit based systems.
 }
 ```
 
+### AWS SNS MUA
+The boot report can be sent to a AWS SNS topic. The `aws-sns` MUA comes with
+the `aws` module.
+
+```jsonc
+{
+	"modules": [ "aws" ],
+	"boot-report": {
+		"mua": "aws-sns",
+		"mua-param": {
+			// "profile": "default",
+			// If the profile does not have the default region.
+			"region": "us-east-1"
+		},
+		// Target ARNs. Any ARN recognised by the SNS can be used.
+		"mail-to": [ "arn:aws:sns:us-east-1:NNNNNNNNNNNN:topic-test" ]
+	}
+}
+```
+
 ## DNSSEC Check
 If your domain is configured with DNSSEC[^2], PALHM can be used to check the
 reachability of your RRs. Your domain will become unavailable when the keys are
-- 
cgit v1.2.3-70-g09d2