Documentation updates

Author: jlhood

pipelines/event-replay-pipeline/README.md

@@ -1,14 +1,14 @@
-## SNS Fork Message Replay
+## SNS Fork: Event Replay Pipeline
 
-This Serverless application provides an SNS Fork processing pipeline that saves topic messages to a replay buffer SQS queue. In a disaster recovery scenario, messages from up to 14 days ago can be replayed back to another processing pipeline's SQS queue.
+This Serverless application provides an SNS Fork processing pipeline that saves SNS topic events to a replay buffer SQS queue. In a disaster recovery scenario, events from up to 14 days ago can be replayed back to another processing pipeline's SQS queue.
 
 ## Architecture
 
-![SNS Fork Message Replay Architecture](https://github.com/aws-samples/aws-serverless-sns-fork-pattern/raw/master/message-replay/images/message-replay-architecture.png)
+![SNS Fork Event Replay Pipeline Architecture](https://github.com/aws-samples/aws-serverless-sns-fork-pattern/raw/master/pipelines/event-replay-pipeline/images/message-replay-architecture.png)
 
 1. An Amazon SQS queue is subscribed to the given SNS Topic ARN with an optional subscription filter policy.
 1. An AWS Lambda function is mapped to the SQS queue, but the event source is initially disabled.
-1. In a disaster scenario, an operator manually enables the Lambda event source mapping and the AWS Lambda function forwards the messages from the replay buffer to the given destination SQS queue.
+1. In a disaster scenario, an operator manually enables the Lambda event source mapping and the AWS Lambda function forwards the events from the replay buffer to the given destination SQS queue.
 
 ## Installation
 
@@ -22,28 +22,28 @@ This app is meant to be used as part of a larger application, so the recommended
  ApplicationId: TODO
  SemanticVersion: 1.0.0
  Parameters:
- # SNS Topic ARN whose messages should be backed up to S3.
- SNSTopicArn: !Ref MessageTopic
- # Name of destination SQS Queue where replay messages should be sent in a disaster recovery scenario. The app assumes the queue
+ # SNS Topic ARN whose events should be backed up to S3.
+ SNSTopicArn: !Ref EventTopic
+ # Name of destination SQS Queue where replay events should be sent in a disaster recovery scenario. The app assumes the queue
  # is in the same account and region as this app.
  DestinationSQSQueueName: !GetAtt OtherPipelineQueue.QueueName
- # Retention period in seconds for the replay buffer SQS queue. This controls how long messages will be stored in the replay buffer.
+ # Retention period in seconds for the replay buffer SQS queue. This controls how long events will be stored in the replay buffer.
  #ReplayBufferRetentionPeriodInSeconds: 1209600 # Uncomment to override default value
 ```
 
-Alternatively, you can deploy the application into your account manually via the [sns-fork-message-replay SAR page](TODO).
+Alternatively, you can deploy the application into your account manually via the [sns-fork-event-replay-pipeline SAR page](TODO).
 
 ### Parameters
 
-1. `SNSTopicArn` (required) - SNS Topic ARN whose messages should be backuped up to S3.
-1. `DestinationSQSQueueName` (required) - Name of destination SQS Queue where replay messages should be sent in a disaster recovery scenario. The app assumes the queue is in the same account and region as this app.
-1. `SubscriptionFilterPolicy` (optional) - SNS Topic Subscription FilterPolicy as a JSON string. This optional parameter allows you to configure message filtering for messages processed by this app. See [the documentation](https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html) for details. The default behavior is to use no subscription filter policy so the app will backup all messages sent to the SNS topic.
-1. `ReplayBufferRetentionPeriodInSeconds` (optional) - Retention period in seconds for the replay buffer SQS queue. This controls how long messages will be stored in the replay buffer. If not specified, the default value of `1209600` (14 days) is used.
+1. `SNSTopicArn` (required) - SNS Topic ARN whose events should be backed up to S3.
+1. `DestinationSQSQueueName` (required) - Name of destination SQS Queue where replay events should be sent in a disaster recovery scenario. The app assumes the queue is in the same account and region as this app.
+1. `SubscriptionFilterPolicy` (optional) - SNS Topic Subscription FilterPolicy as a JSON string. This optional parameter allows you to configure message filtering for events processed by this app. See [the documentation](https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html) for details. The default behavior is to use no subscription filter policy so the app will backup all messages sent to the SNS topic.
+1. `ReplayBufferRetentionPeriodInSeconds` (optional) - Retention period in seconds for the replay buffer SQS queue. This controls how long events will be stored in the replay buffer. If not specified, the default value of `1209600` (14 days) is used.
 
 ### Outputs
 
-1. `ReplayMessagesFunctionName` - Replay messages Lambda function name.
-1. `ReplayMessagesFunctionArn` - Replay messages Lambda function ARN.
+1. `ReplayMessagesFunctionName` - Replay events Lambda function name.
+1. `ReplayMessagesFunctionArn` - Replay events Lambda function ARN.
 1. `ReplayMessagesEventSourceMappingId` - Id of event source mapping of Replay buffer SQS queue to ReplayMessages Lambda function.
 
 ## License Summary

pipelines/event-search-analytics-pipeline/README.md

@@ -1,14 +1,14 @@
-## SNS Fork Search and Analytics
+## SNS Fork: Event Search and Analytics Pipeline
 
-This Serverless application provides an SNS Fork processing pipeline that saves topic messages to an Amazon Elasticsearch Service cluster for searching and analytics.
+This Serverless application provides an SNS Fork processing pipeline that saves topic events to an Amazon Elasticsearch Service cluster for searching and analytics.
 
 ## Architecture
 
 ![SNS Fork Search and Analytics Architecture](https://github.com/aws-samples/aws-serverless-sns-fork-pattern/raw/master/search-analytics/images/search-analytics-architecture.png)
 
 1. An Amazon SQS queue is subscribed to the given SNS Topic ARN with an optional subscription filter policy.
-1. An AWS Lambda function reads messages from the SQS queue and publishes them to an Amazon Kinesis Data Firehose Delivery Stream, which saves them to the given Amazon Elasticsearch Service Domain.
-1. If for some reason Kinesis Data Firehose is not able to write messages to the Amazon Elasticsearch Service Domain, the failed messages are written to a backup Amazon S3 bucket.
+1. An AWS Lambda function reads events from the SQS queue and publishes them to an Amazon Kinesis Data Firehose Delivery Stream, which saves them to the given Amazon Elasticsearch Service Domain.
+1. If for some reason Kinesis Data Firehose is not able to write events to the Amazon Elasticsearch Service Domain, the failed events are written to a backup Amazon S3 bucket.
 
 **Note:** The app does not create an Amazon Elasticsearch Service cluster as part of the app since Amazon ES Domains have many configuration options and users commonly want to use a single cluster across many pipelines to save cost and perform more advanced queries.
 
@@ -24,8 +24,8 @@ This app is meant to be used as part of a larger application, so the recommended
  ApplicationId: TODO
  SemanticVersion: 1.0.0
  Parameters:
- # SNS Topic ARN whose messages should be backed up to S3.
- SNSTopicArn: !Ref MessageTopic
+ # SNS Topic ARN whose events should be backed up to S3.
+ SNSTopicArn: !Ref EventTopic
  # ARN of the Elasticsearch Domain to write to.
  ElasticsearchDomainArn: !GetAtt MyElasticSearchCluster.Arn
  # Elasticsearch index name to write to.
@@ -34,10 +34,10 @@ This app is meant to be used as part of a larger application, so the recommended
  ElasticsearchTypeName: PROVIDE-VALUE
  # The frequency of Elasticsearch index rotation.
  #ElasticsearchIndexRotationPeriod: NoRotation # Uncomment to override default value
- # Number of seconds to retry if messages cannot be written to Elasticsearch index.
+ # Number of seconds to retry if events cannot be written to Elasticsearch index.
  #RetryDurationInSeconds: 300 # Uncomment to override default value
  # SNS Topic Subscription FilterPolicy as a JSON string. This optional parameter allows you to configure message filtering
- # for messages processed by this app. See https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html for details.
+ # for events processed by this app. See https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html for details.
  #SubscriptionFilterPolicy: '' # Uncomment to override default value
  # Prefix used for S3 backup files
  #BackupPrefix: backup/ # Uncomment to override default value
@@ -49,20 +49,20 @@ Alternatively, you can deploy the application into your account manually via the
 
 ### Parameters
 
-1. `SNSTopicArn` (required) - SNS Topic ARN whose messages should be backuped up to S3.
+1. `SNSTopicArn` (required) - SNS Topic ARN whose events should be backed up to S3.
 1. `ElasticsearchDomainArn` (required) - ARN of the Elasticsearch Domain to write to.
 1. `ElasticsearchIndexName` (required) - Elasticsearch index name to write to.
 1. `ElasticsearchTypeName` (required) - The Elasticsearch type name that Amazon ES adds to documents when indexing data.
-1. `SubscriptionFilterPolicy` (optional) - SNS Topic Subscription FilterPolicy as a JSON string. This optional parameter allows you to configure message filtering for messages processed by this app. See [the documentation](https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html) for details. The default behavior is to use no subscription filter policy so the app will backup all messages sent to the SNS topic.
+1. `SubscriptionFilterPolicy` (optional) - SNS Topic Subscription FilterPolicy as a JSON string. This optional parameter allows you to configure message filtering for events processed by this app. See [the documentation](https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html) for details. The default behavior is to use no subscription filter policy so the app will backup all events sent to the SNS topic.
 1. `ElasticsearchIndexRotationPeriod` (optional) - The frequency of Elasticsearch index rotation. See [the documentation](https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation) for details. If not specified, the default value of `NoRotation` is used.
-1. `RetryDurationInSeconds` (optional) - Number of seconds to retry if messages cannot be written to Elasticsearch index. Messages that fail to get written to ElasticSearch are written to an S3 backup bucket created by the app. See [the documentation](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchRetryOptions.html) for details. If not specified, the default value of 300 seconds (5 minutes) is used.
-1. `BackupPrefix` (optional) - A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket (only used for messages that cannot be delivered to the Elasticsearch cluster). If not specified, the default value of `backup/` is used.
-1. `BackupCompressionFormat` (optional) - The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket (only used for messages that cannot be delivered to the Elasticsearch cluster). For valid values, see the `CompressionFormat` content for the [S3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference*.
+1. `RetryDurationInSeconds` (optional) - Number of seconds to retry if events cannot be written to Elasticsearch index. Events that fail to get written to ElasticSearch are written to an S3 backup bucket created by the app. See [the documentation](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchRetryOptions.html) for details. If not specified, the default value of 300 seconds (5 minutes) is used.
+1. `BackupPrefix` (optional) - A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket (only used for events that cannot be delivered to the Elasticsearch cluster). If not specified, the default value of `backup/` is used.
+1. `BackupCompressionFormat` (optional) - The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket (only used for events that cannot be delivered to the Elasticsearch cluster). For valid values, see the `CompressionFormat` content for the [S3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference*.
 
 ### Outputs
 
-1. `BackupBucketName` - Failed messages backup bucket name.
-1. `BackupBucketArn` - Failed messages backup bucket ARN.
+1. `BackupBucketName` - Failed events backup bucket name.
+1. `BackupBucketArn` - Failed events backup bucket ARN.
 
 ## License Summary
 

pipelines/event-search-analytics-pipeline/template.yml

@@ -1,11 +1,11 @@
 AWSTemplateFormatVersion: 2010-09-09
 Transform: AWS::Serverless-2016-10-31
 Description: >
- This app forwards messages from the given SNS topic to the given Elasticsearch domain using Kinesis Firehose.
+ This app forwards events from the given SNS topic to the given Elasticsearch domain using Kinesis Firehose.
 
 Parameters:
  SNSTopicArn:
- Description: SNS Topic ARN whose messages should be sent to Elasticsearch.
+ Description: SNS Topic ARN whose events should be sent to Elasticsearch.
  Type: String
  ElasticsearchDomainArn:
  Description: ARN of the Elasticsearch Domain to write to.
@@ -18,7 +18,7 @@ Parameters:
  Type: String
  SubscriptionFilterPolicy:
  Description: >
- SNS Topic Subscription FilterPolicy as a JSON string. This optional parameter allows you to configure message filtering for messages
+ SNS Topic Subscription FilterPolicy as a JSON string. This optional parameter allows you to configure message filtering for events 
  processed by this app. See https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html for details.
  Type: String
  Default: ''
@@ -27,17 +27,17 @@ Parameters:
  Type: String
  Default: NoRotation
  RetryDurationInSeconds:
- Description: Number of seconds to retry if messages cannot be written to Elasticsearch index.
+ Description: Number of seconds to retry if events cannot be written to Elasticsearch index.
  Type: Number
  MinValue: 0
  MaxValue: 7200
  Default: 300
  BackupPrefix:
- Description: Prefix used for S3 backup files (messages are saved to S3 if they can't be written to the Elasticsearch cluster).
+ Description: Prefix used for S3 backup files (events are saved to S3 if they can't be written to the Elasticsearch cluster).
  Type: String
  Default: 'backup/'
  BackupCompressionFormat:
- Description: Compression format for S3 backup files (messages are saved to S3 if they can't be written to the Elasticsearch cluster).
+ Description: Compression format for S3 backup files (events are saved to S3 if they can't be written to the Elasticsearch cluster).
  Type: String
  AllowedValues:
  - UNCOMPRESSED

pipelines/event-store-backup-pipeline/README.md

@@ -1,13 +1,13 @@
-## SNS Fork Storage and Backup
+## SNS Fork: Storage and Backup Pipeline
 
-This Serverless application provides an SNS Fork processing pipeline that saves topic messages to an Amazon S3 bucket for use as backups or other purposes, e.g., to query with Amazon Athena.
+This Serverless application provides an SNS Fork processing pipeline that saves topic events to an Amazon S3 bucket for use as backups or other purposes, e.g., to query with Amazon Athena.
 
 ## Architecture
 
 ![SNS Fork Backup and Storage Architecture](https://github.com/aws-samples/aws-serverless-sns-fork-pattern/raw/master/storage-backup/images/storage-backup-architecture.png)
 
 1. An Amazon SQS queue is subscribed to the given SNS Topic ARN with an optional subscription filter policy.
-1. An AWS Lambda function reads messages from the SQS queue and publishes them to an Amazon Kinesis Data Firehose Delivery Stream, which saves them to an Amazon S3 bucket.
+1. An AWS Lambda function reads events from the SQS queue and publishes them to an Amazon Kinesis Data Firehose Delivery Stream, which saves them to an Amazon S3 bucket.
 
 ## Installation
 
@@ -21,10 +21,10 @@ This app is meant to be used as part of a larger application, so the recommended
  ApplicationId: TODO
  SemanticVersion: 1.0.0
  Parameters:
- # SNS Topic ARN whose messages should be backed up to S3.
- SNSTopicArn: !Ref MessageTopic
+ # SNS Topic ARN whose events should be backed up to S3.
+ SNSTopicArn: !Ref EventTopic
  # SNS Topic Subscription FilterPolicy as a JSON string. This optional parameter allows you to configure message filtering
- # for messages processed by this app. See https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html for details.
+ # for events processed by this app. See https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html for details.
  #SubscriptionFilterPolicy: '' # Uncomment to override default value
  # Prefix used for S3 backup files
  #BackupPrefix: backup/ # Uncomment to override default value
@@ -36,8 +36,8 @@ Alternatively, you can deploy the application into your account manually via the
 
 ### Parameters
 
-1. `SNSTopicArn` (required) - SNS Topic ARN whose messages should be backuped up to S3.
-1. `SubscriptionFilterPolicy` (optional) - SNS Topic Subscription FilterPolicy as a JSON string. This optional parameter allows you to configure message filtering for messages processed by this app. See [the documentation](https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html) for details. The default behavior is to use no subscription filter policy so the app will backup all messages sent to the SNS topic.
+1. `SNSTopicArn` (required) - SNS Topic ARN whose events should be backed up to S3.
+1. `SubscriptionFilterPolicy` (optional) - SNS Topic Subscription FilterPolicy as a JSON string. This optional parameter allows you to configure message filtering for events processed by this app. See [the documentation](https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html) for details. The default behavior is to use no subscription filter policy so the app will backup all events sent to the SNS topic.
 1. `BackupPrefix` (optional) - A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket. If not specified, the default value of `backup/` is used.
 1. `BackupCompressionFormat` (optional) - The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. For valid values, see the `CompressionFormat` content for the [S3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference*.