.gitignore

@@ -9,3 +9,6 @@ aws-panorama-sample-dev
 device-id.txt
 application-id.txt
 *.local.json
+samplify.sh
+push.sh
+view-logs.sh

README.md

@@ -1,8 +1,11 @@
 ## AWS Panorama Developer Guide
 
-This repository contains the Markdown version of the AWS Panorama Developer Guide and additional resources that you can use to learn about AWS Panorama concepts and features.
+This repository contains additional resources for the AWS Panorama developer guide.
 
-Table of contents: [index.md](/docs-source/index.md)
+- [cloudformation-templates](./cloudformation-templates) - AWS CloudFormation templates for creating IAM roles, CloudWatch alarms, and VPC network resources to support application development.
+- [resources](./resources) - Reference content for the AWS Panorama application SDK, appliance software updates, and application manifest files.
+- [sample-apps](./sample-apps) - Sample applications that demonstrate features and use cases for the AWS Panorama service and application SDK.
+- [util-scripts](./util-scripts) - Shell scripts that automate common use cases for the AWS Panorama API, including provisioning and updating devices, managing cameras, and deploying applications.
 
 ## License Summary
 

cloudformation-templates/README.md

@@ -0,0 +1,47 @@
+# CloudFormation templates
+
+To create a CloudFormation stack, use the `create-stack.sh` script with the template name.
+
+    $ ./create-stack.sh application-role
+
+If the template takes parameters, specify the parameters after the template name.
+
+    $ ./create-stack.sh alarm-device notificationEmail=me@example.com deviceName=my-appliance deviceId=device-m3axxmpl2tirl6fvf67ast2iqm
+
+To delete a stack, use the `delete-stack.sh` script.
+
+    $ ./delete-stack.sh alarm-device
+
+## alarm-application
+
+Create an alarm that monitors an application for errors. If the application instance raises errors or stops running for 5 minutes, the alarm sends a notification email.
+
+Name and ID parameters are both required. When you deploy a new version of the application, you must update the application ID.
+
+**Parameters**
+- `notificationEmail` - The email address that receives alarm notifications.
+- `applicationName` - The name of the application to monitor.
+- `applicationId` - The ID of the application instance to monitor.
+
+## alarm-device
+
+Create an alarm that monitors a device's connectivity. If the device stops sending metrics for 5 minutes, the alarm sends a notification email.
+
+Name and ID parameters are both required.
+
+**Parameters**
+- `notificationEmail` - The email address that receives alarm notifications.
+- `deviceName` - The name of the device to monitor.
+- `deviceId` - The ID of the device to monitor.
+
+## application-role
+
+Create an application role. The role includes permission to send metrics to CloudWatch. Add permissions to the policy statement for other API operations that your application uses.
+
+## vpc-appliance
+
+Create a VPC with private subnet service access for the AWS Panorama Appliance. To connect the appliance to a VPC, use AWS Direct Connect or AWS Site-to-Site VPN.
+
+## vpc-endpoint
+
+Create a VPC with private subnet service access to the AWS Panorama service. Resources inside of the VPC can connect to AWS Panorama to monitor and manage AWS Panorama resources without connecting to the internet.

cloudformation-templates/alarm-application.yml

@@ -0,0 +1,44 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Description: Creates an alarm and a notification topic for AWS Panorama application metrics.
+Parameters:
+  notificationEmail:
+    Type: String
+    Description: Email address to notify when a alarms are triggered
+    Default: PLACEHOLDER
+  applicationName:
+    Type: String
+    Description: Application name
+    Default: PLACEHOLDER
+  applicationId:
+    Type: String
+    Description: Application ID
+    Default: PLACEHOLDER
+Resources:
+  # needs ApplicationInstanceName and ApplicationInstanceId dimensions
+  applicationErrorAlarm:
+    Type: AWS::CloudWatch::Alarm
+    Properties:
+      AlarmName: ApplicationErrorAlarm
+      AlarmDescription: Alarms when an application is in error
+      AlarmActions:
+      - !Ref alarmNotificationTopic
+      MetricName: ApplicationErrors
+      Dimensions:
+      - Name: ApplicationInstanceName
+        Value: !Ref applicationName
+      - Name: ApplicationInstanceId
+        Value: !Ref applicationId
+      Namespace: PanoramaDeviceMetrics
+      EvaluationPeriods: 5
+      DatapointsToAlarm: 5
+      Period: 60
+      Threshold: 1
+      Statistic: Sum
+      ComparisonOperator: GreaterThanOrEqualToThreshold
+      TreatMissingData: breaching
+  alarmNotificationTopic:
+    Type: AWS::SNS::Topic
+    Properties:
+      Subscription:
+      - Endpoint: !Ref notificationEmail
+        Protocol: email

cloudformation-templates/alarm-device.yml

@@ -0,0 +1,44 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Description: Creates an alarm and a notification topic for AWS Panorama device metrics.
+Parameters:
+  notificationEmail:
+    Type: String
+    Description: Email address to notify when a alarms are triggered
+    Default: PLACEHOLDER
+  deviceName:
+    Type: String
+    Description: Device name
+    Default: PLACEHOLDER
+  deviceId:
+    Type: String
+    Description: Device ID
+    Default: PLACEHOLDER
+Resources:
+  # needs DeviceID and DeviceName dimensions
+  deviceOfflineAlarm:
+    Type: AWS::CloudWatch::Alarm
+    Properties:
+      AlarmName: DeviceOfflineAlarm
+      AlarmDescription: Alarms when a device is offline
+      AlarmActions:
+      - !Ref alarmNotificationTopic
+      MetricName: DeviceActive
+      Dimensions:
+      - Name: DeviceName
+        Value: !Ref deviceName
+      - Name: DeviceId
+        Value: !Ref deviceId
+      Namespace: PanoramaDeviceMetrics
+      EvaluationPeriods: 5
+      DatapointsToAlarm: 5
+      Period: 60
+      ComparisonOperator: LessThanThreshold
+      Threshold: 1
+      Statistic: Sum
+      TreatMissingData: breaching
+  alarmNotificationTopic:
+    Type: AWS::SNS::Topic
+    Properties:
+      Subscription:
+      - Endpoint: !Ref notificationEmail
+        Protocol: email

cloudformation-templates/create-stack.sh

@@ -11,13 +11,13 @@ elif [[ $# -eq 1 ]]; then
     TEMPLATE=$(cat ${TEMPLATE_NAME}.yml)
     if [[ "$TEMPLATE" =~ PLACEHOLDER ]]; then
         echo "Usage: ./create-stack.sh <template-name> <parameters>"
-        echo "e.g.   ./create-stack.sh metric-alarms notificationEmail=me@example.com"
+        echo "e.g.   ./create-stack.sh alarm-device notificationEmail=me@example.com deviceName=my-appliance deviceId=device-6talxmpl5mmik6qh5moba6jium"
         exit 0
     fi
 else
     echo "Usage: ./create-stack.sh <template-name> <parameters>"
     echo "e.g.   ./create-stack.sh application-role"
-    echo "e.g.   ./create-stack.sh metric-alarms notificationEmail=me@example.com"
+    echo "e.g.   ./create-stack.sh alarm-device notificationEmail=me@example.com deviceName=my-appliance deviceId=device-6talxmpl5mmik6qh5moba6jium"
     exit 0
 fi
 STACK_NAME=panorama-${TEMPLATE_NAME}