Automated Deployment - Real-Time Web Analytics with Kinesis Data Analytics

Automated Deployment

Before you launch the automated deployment, please review the architecture and other considerations discussed in this guide. Follow the step-by-step instructions in this section to configure and deploy Real-Time Web Analytics with Kinesis Data Analytics into your account.

Time to deploy: Approximately 10 minutes

Launch the Stack

This automated AWS CloudFormation template deploys the Real-Time Web Analytics with Kinesis Data Analytics solution in a new VPC. To launch the solution in an existing VPC, see Appendix C. Please make sure that you've verified that you have reviewed the considerations and prerequisites before launching the stack.


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 real-time-web-analytics-with-kinesis AWS CloudFormation template.

                                Real-Time Web Analytics with Kinesis Data Analytics 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) Region by default. To launch this solution in a different AWS Region, use the region selector in the console navigation bar.


    This solution uses the Amazon Kinesis Data Firehose and Amazon Kinesis Data Analytics services, which are currently available in specific AWS Regions only. Therefore, you must launch this solution an AWS Region where these services 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 solution 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
    User Name <Requires input>

    User name to access the real-time dashboard

    User Email Address <Requires input>

    Email address of dashboard user. After launch, an email will be sent to this address with dashboard login instructions.

    CloudWatch Dashboard Yes

    Choose whether to deploy the Amazon CloudWatch metrics dashboard

    CORS Origin *

    The value that is returned by the Access-Control-Allow-Origin header. A star (*) value will support any origin. We recommend specifying a specific origin (e.g. to restrict cross-site access to your API.

    Node Requests/Min 50K

    The number of requests per minute that each beacon node will support. Choose 50K or 100K.

    Min Beacon Servers 2

    The minimum number of beacon web servers. For high availability, specify at least 2.

    Max Beacon Servers 6

    The maximum number of beacon servers

    SSH Key Pair <Requires input>

    Public and private key pair, which allows you to connect securely to the beacon web servers. When you created an AWS account, this is the key pair you created in your preferred AWS Region.

    Enable SSH? false

    Choose whether to allow SSH access to beacon servers. If you select true for this parameter, you must specify an SSH Key Pair and a CIDR block in the Enable SSH From parameter.


    This solution's beacon web servers are configured to be managed by AWS Systems Manager. As a result, you can use Run Command to connect to the beacon server instead of SSH.

    Enable SSH From <Optional input>

    This IP address CIDR block will have access to the beacon web servers

    Beacon Server VPC CIDR

    CIDR block for the new VPC for the beacon web servers

    1st Subnet Network

    CIDR block for the new VPC public subnet created in AZ1

    2nd Subnet Network

    CIDR block for the new VPC public subnet created in AZ2

    1st Subnet AZ # 0

    The Availability Zone number for the first public subnet

    2nd Subnet AZ # 1

    The Availability Zone number for the second public subnet

  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 roughly 10 minutes.

    The solution sends an email invitation to join the real-time dashboard.

  10. In the email, follow the instructions to sign in to the dashboard.


In addition to the primary AWS Lambda function ProcessMetricsFunction, this solution includes the CustomResourceHelper Lambda function, which runs only during initial configuration or when resources are updated or deleted.

After launching this solution, you will see these Lambda functions in the AWS console, but only the ProcessMetricsFunction function is regularly active. However, do not delete the CustomResourceHelper function as it is necessary to manage associated resources.