Added Manual Steps for AWS SES Setup #844
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dlpzx
reviewed
Oct 31, 2023
pages/deploy/deploy_aws.md
Outdated
| @@ -518,6 +518,25 @@ diagram. | |||
| With this pipeline we can now deploy the infrastructure to the deployment account(s). Navigate to AWS CodePipeline | |||
| in the tooling account and check the status of your pipeline. | |||
|
|
|||
| ## 12. Setting SES for Email Notifications | |||
|
|
|||
| Please follow instructions from below if you have enabled email notification by switching the email.active config to true in the `share_notifications` feature under `datasets` module. | |||
There was a problem hiding this comment.
Can we add here that we are referring to the config.json? Deployment is quite confusing for new data.all-ers so I would make it as clear as possible
There was a problem hiding this comment.
Yes. I made changes to specify where exactly the configuration is present.
dlpzx
reviewed
Oct 31, 2023
pages/deploy/deploy_aws.md
Outdated
| When SES Stack is deployed during the pipeline stage, it will setup a <a href="https://docs.aws.amazon.com/ses/latest/dg/using-configuration-sets.html">configuration set</a> | ||
| which will send any email bounces, delivery failures , rejects & complaints to an SNS topic. In this step, you can add subscriptions to this SNS topic to monitor email delivery problems | ||
|
|
||
| In order to do that goto AWS Console -> SNS -> Select the SNS topic which would look like `{resource_prefix}-{envname}-SNS-Email-Bounce-Topic` ( where resource_prefix and envname are specified in the cdk.json ) -> Create Subscription. You can attach multiple subscriptions to |
There was a problem hiding this comment.
typo: "goto" and extra space before comma "failures , rejects"
There was a problem hiding this comment.
Addressed typos in the next update
dlpzx
reviewed
Oct 31, 2023
There was a problem hiding this comment.
@TejasRGitHub ultra minor comments. I like it, it is very concise and clear
noah-paige
approved these changes
Nov 3, 2023
|
Thanks @TejasRGitHub |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Detail
When enabling email notification on share workflow, an SES identity is created on AWS SES. This PR contains documentation about the manual steps that need to be taken towards setting up SES and also additional steps to setup monitoring.
Relates
Security
Please answer the questions below briefly where applicable, or write
N/A. Based onOWASP 10.
fetching data from storage outside the application (e.g. a database, an S3 bucket)? N/A
evalor similar functions are used?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.