Amazon IVS Multi-host Serverless Demo

This readme includes instructions for deploying the Amazon IVS Multi-host Serverless Demo to an AWS Account. This serverless application supports the following Amazon IVS demos:

*IMPORTANT NOTE: Deploying this demo application in your AWS account will create and consume AWS resources, which will cost money.*

Application overview

A full description of the diagram is available in the architecture description.

Prerequisites

AWS CLI Version 2
NodeJS and npm (npm is usually installed with NodeJS).
- If you have node version manager installed, run nvm use to sync your node version with this project.
Access to an AWS Account with at least the following permissions:
- Create IAM roles
- Create Lambda Functions
- Create Amazon IVS Channels, Stages, and Chat rooms
- Create Amazon S3 Buckets
- Create Amazon DynamoDB Tables

Configure the AWS CLI

Before you start, run the following command to make sure you're in the correct AWS account (or configure as needed):

aws configure

For configuration specifics, refer to the AWS CLI User Guide

Run this app locally

To run the app locally, first install the AWS SAM CLI and Docker. With AWS SAM CLI installed and Docker running on your machine, take the following steps:

Install the required packages: npm install
Bootstrap the required resources: npm run bootstrap
Run the application: sam local start-api -t ./cdk.out/AmazonIVSMultiHostServerlessStack.template.json

Deploy this app to AWS

With NodeJS and NPM installed, take the following steps:

Install the required packages: npm install
Bootstrap the required resources: npm run bootstrap
Run the application: npm run deploy

Use your deployed backend in the client applications

When the deployment successfully completes, copy the URL provided in the Outputs of the script. The URL will be similar to the following format:

https://<ID>.execute-api.<REGION>.amazonaws.com/prod/

This URL can be used to run the following demo applications:

Accessing the deployed application

If needed, you can retrieve the Cloudformation stack outputs by running the following command:

aws cloudformation describe-stacks --stack-name AmazonIVSMultiHostServerlessStack \
--query 'Stacks[].Outputs'

Cleanup

To delete all resources associated with this demo, including the DynamoDB table! run the following command:

npm run destroy

This command may not delete all associated Amazon IVS stages, channels, or chat rooms. Visit the Amazon IVS web console to delete any lingering resources.

Known issues

In some instances, the Amazon IVS stage, channel, or room may fail to delete. To remove resources manually, look for resources tagged with the key AmazonIVSDemoResource and value AmazonIVSMultiHostResource.

aws-samples / amazon-ivs-multi-host-serverless-demo Goto Github PK