summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/docsite/rst/userguide/notifications.rst13
-rw-r--r--docs/notification_system.md5
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/docsite/rst/userguide/notifications.rst b/docs/docsite/rst/userguide/notifications.rst
index e7e8234111..ff7691c6fd 100644
--- a/docs/docsite/rst/userguide/notifications.rst
+++ b/docs/docsite/rst/userguide/notifications.rst
@@ -84,6 +84,7 @@ Notification Types
.. index::
pair: notifications; types
+ triple: notifications; types; AWS SNS
triple: notifications; types; Email
triple: notifications; types; Grafana
triple: notifications; types; IRC
@@ -101,6 +102,18 @@ Notification types supported with AWX:
Each of these have their own configuration and behavioral semantics and testing them may need to be approached in different ways. Additionally, you can customize each type of notification down to a specific detail, or a set of criteria to trigger a notification. See :ref:`ug_custom_notifications` for more detail on configuring custom notifications. The following sections will give as much detail as possible on each type of notification.
+AWS SNS
+-------
+
+The AWS SNS(https://aws.amazon.com/sns/) notification type supports sending messages into an SNS topic.
+
+You must provide the following details to setup a SNS notification:
+
+- AWS Region
+- AWS Access Key ID
+- AWS Secret Access Key
+- AWS SNS Topic ARN
+
Email
-------
diff --git a/docs/notification_system.md b/docs/notification_system.md
index edd64275fe..96502edfa9 100644
--- a/docs/notification_system.md
+++ b/docs/notification_system.md
@@ -70,6 +70,7 @@ Once a Notification Template has been created, its configuration can be tested b
The currently-defined Notification Types are:
+* AWS SNS
* Email
* Slack
* Mattermost
@@ -82,6 +83,10 @@ The currently-defined Notification Types are:
Each of these have their own configuration and behavioral semantics and testing them may need to be approached in different ways. The following sections will give as much detail as possible.
+## AWS SNS
+
+The AWS SNS notification type supports sending messages into an SNS topic.
+
## Email
The email notification type supports a wide variety of SMTP servers and has support for SSL/TLS connections and timeouts.