Menu
Cross-Region Replication Monitor
Reference Implementation

Automated Deployment

This solution is intended for customers who have already configured Amazon S3 cross-region replication in their account. Before you launch the automated deployment, please review the architecture, configuration, and other considerations discussed in this guide. Follow the step-by-step instructions in this section to configure and deploy the Cross-Region Replication Monitor into your account.

Time to deploy: Approximately five minutes

What We'll Cover

The procedure for deploying this architecture on AWS consists of the following steps. For detailed instructions, follow the links for each step.

Step 1. Launch the Stack

  • Launch the AWS CloudFormation template into your AWS account.

  • Enter values for optional parameters: Archive to S3, S3 Archive Bucket

  • Review the other template parameters, and adjust if necessary.

Step 2. Subscribe to Amazon SNS Topic

  • Subscribe to the custom Amazon SNS Topic to receive failure notifications.

Step 1. Launch the Stack

Note

You are responsible for the cost of the AWS services used while running this solution. See the Cost section for more details. For full details, see the pricing webpage for each AWS service you will be using in this solution.

  1. Sign in to the AWS Management Console and click the button below to launch the crr-monitor AWS CloudFormation template.

    
                                Cross-Region Replication Monitor launch button

    You can also download the template as a starting point for your own implementation.

  2. The template is launched in the US East (N. Virginia) by default. To launch the CRR Monitor in a different AWS Region, use the region selector in the console navigation bar.

    Note

    This solution uses the AWS Lambda service and Amazon Kinesis Firehose, which is currently available in specific AWS Regions only. Therefore, you must deploy this solution an AWS Region where Lambda and Kinesis Firehose are available. For the most current service availability by region, see AWS service offerings by region.

  3. On the Select Template page, verify that you selected the correct template and choose Next.

  4. On the Specify Details page, assign a name to your CRR Monitor stack.

  5. Under Parameters, review the parameters for the template, and modify them as necessary. This solution uses the following default values.

    Parameter Default Description
    Archive to S3 No This solution has the option to archive status data from DynamoDB to Amazon S3 for later analysis. To enable this feature, select Yes.

    Note

    If you use this feature, you must deploy this template in an AWS Region that supports Amazon Kinesis Firehose.

    S3 Archive Bucket <Requires Input> If you chose to enable data archiving to Amazon S3, enter the name of an existing S3 bucket.

    Note

    To use this feature, you must select Yes for the Archive to S3 parameter. You must specify an existing S3 bucket. If you plan to use multiple implementations of the solution in different AWS Regions, we recommend that you use the same bucket to collect all solution data.

    Send Anonymous Usage Data Yes Send anonymous data to AWS to help us understand CRR Monitor usage across our customer base as a whole. To opt out of this feature, choose No. For more information, see the Appendix.
  6. Choose Next.

  7. On the Options page, choose Next.

  8. On the Review page, review and confirm the settings. Be sure to check the box acknowledging that the template will create AWS Identity and Access Management (IAM) resources.

  9. Choose Create to deploy the stack.

    You can view the status of the stack in the AWS CloudFormation console in the Status column. You should see a status of CREATE_COMPLETE in approximately five minutes.

Note

In addition to the solution’s AWS Lambda functions, this solution includes the solution-helper, Lambda function, which runs only during initial configuration or when resources are updated or deleted.

When running this solution, you will see the regularly active Lambda function whose names contain crr. However, do not delete the solution-helper function as it is necessary to manage associated resources.

Step 2. Subscribe to Amazon SNS Topic

This solution uses the FailedReplication Amazon CloudWatch metric to trigger a CloudWatch alarm. If an object fails to replicate across AWS Regions, the CloudWatch alarm will trigger and Amazon SNS notification about the failure. This enables customers to identify failures in near real-time and troubleshoot them immediately.

To receive this notification, you must subscribe to the solution's custom Amazon SNS topic: CRRMonitorMetricsTopic. For detailed instructions, see Subscribe to a Topic in the Amazon SNS Developer Guide.