Deploy the solution
This solution uses AWS CloudFormation templates and stacks to automate its deployment. The CloudFormation templates specify the AWS resources included in this solution and their properties. The CloudFormation stack provisions the resources that are described in the templates.
Prerequisites
Before you launch this solution, review the configuration section and consider the CloudWatch agent and web server configuration files discussed in the Architecture details section of this guide. Follow the step-by-step instructions in this section to configure and deploy this solution into your account.
Note
This solution does not configure your EC2 instances. Amazon CloudWatch agent and required configuration files are provided with the solution so that you can refer to them when configuring EC2 instances for your respective workload. For more information, refer to Configuring your Apache EC2 instance, Configuring your Puma EC2 instance, or Configuring your NGINX instance. Additionally, a demo template is provided for you to use for demo and proof of concept purposes.
AWS CloudFormation templates
You can download the CloudFormation template for this solution before deploying it.
Parameter | Default | Description |
---|---|---|
Workload Name | none |
Workload that you want to monitor. Supported workload names are Apache, Nginx, Puma. NoteWorkload names are case sensitive. |
Tag Schema | none |
Tagging schema to identity workload instances. NoteTags are key sensitive. |
Dashboard Name | none |
Name for the deployed CloudWatch Dashboard. Region will be
appended to the name. For example: ApacheDashboard-us-east-1
|
Access Log Group | none | CloudWatch Log Group where instances push their access logs. |
SSM Parameter Name | none | AWS Systems Manager parameter used for maintaining workload instance list. |
apache-demo.template
nginx-demo.template
puma-demo.template
Note
As of September 2022, the amazon-cloudwatch-monitoring-framework.template
only
supports Apache, NGINX, and Puma workloads and it deploys workload.template
as
nested stacks. Optionally, you can deploy workload.template
as standalone
templates as well.
AWS CloudFormation resources are created from AWS Cloud Development Kit (AWS CDK) constructs.
Deployment process overview
Time to deploy: Approximately five minutes
Use the following steps to deploy this solution on AWS. For detailed instructions, follow the links for each step.
-
Launch the AWS CloudFormation template for the framework into your AWS account.
-
Enter values for required parameters: Tagging Schema and Demo Instance.
-
Review the template parameters, and adjust if necessary.
Step 3. Onboard your workload EC2 instances (Optional)
Important
This solution includes an option to send anonymized operational metrics to AWS. We use
this data to better understand how customers use this solution and related services and
products. AWS owns the data gathered though this survey. Data collection is subject to the
AWS Privacy Notice
To opt out of this feature, download the template, modify the AWS CloudFormation mapping section, and then use the AWS CloudFormation console to upload your template and deploy the solution. For more information, refer to section Anonymized data collection of this guide.