Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change documentation references from topic to topicArn #75

Merged
merged 1 commit into from
Mar 29, 2022
Merged

Change documentation references from topic to topicArn #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ You can customize the configuration:
### Plugin configuration
Top-level plugin configuration can be specified in the `custom` → `slicWatch` section of `serverless.yml`

- The `topic` may be optionally provided as an SNS Topic destination for all alarms. If you omit the topic, alarms are still created but are not sent to any destination.
- The `topicArn` may be optionally provided as an SNS Topic destination for all alarms. If you omit the topic, alarms are still created but are not sent to any destination.
- Alarms or dashboards can be disabled at any level in the configuration by adding `enabled: false`. You can even disable all plugin functionality by specifying `enabled: false` at the top-level plugin configuration.

Supported options along with their defaults are shown below.
Expand All @@ -161,7 +161,7 @@ Supported options along with their defaults are shown below.

custom:
slicWatch:
topic: SNS_TOPIC_ARN # This is optional but recommended so you can receive alarms via email, Slack, etc.
topicArn: SNS_TOPIC_ARN # This is optional but recommended so you can receive alarms via email, Slack, etc.
enabled: true

alarms:
Expand Down