Media Services Application Mapper
Media Services Application Mapper

Automated Deployment

Before you launch the automated deployment, please review the architecture, security, and other considerations discussed in this guide. Follow the step-by-step instructions in this section to configure and deploy the Media Services Application Mapper into your account.

Time to deploy: Approximately 40 mins

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 DynamoDB Template

  • Launch the AWS CloudFormation template into your AWS account.

  • Enter values for required parameters: Stack Name

Step 2. Launch the Core Template

  • Launch the AWS CloudFormation template into your AWS account.

  • Enter values for required parameters: Stack Name, Alarms Table Name, Channels Table Name, Content Table Name, Events Table Name, Layout Table Name, Settings Table Name

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

Step 3. Launch the Events Template

  • Launch the AWS CloudFormation template into your AWS account.

  • Enter values for required parameters: Stack Name, Events Table Name, Events Table Region

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

Step 4. Launch the Browser App Template

  • Launch the AWS CloudFormation template into your AWS account.

  • Enter values for required parameters: Stack Name

Step 5. Configure the Browser App

  • Enter values for Endpoint URL and API Key

Step 1. Launch the DynamoDB Template

This automated AWS CloudFormation template deploys the solution's Amazon DynamoDB tables.

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 msam-dynamodb-release AWS CloudFormation template.

    
                                Media Services Application Mapper DynamoDB 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 the solution in a different AWS Region, use the region selector in the console navigation bar.

  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 stack.

  5. Choose Next.

  6. On the Options page, choose Next.

  7. 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.

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

  9. After the stack deploys, navigate to the stack Outputs tab and note the values of the SettingsTable, ChannelsTable, LayoutTable, ContentTable, EventsTable, and AlarmsTable keys. You will use these values as input parameters for the other templates.

    Note

    After the DynamoDB stack is created, you can launch the Core, Events, and Browser App templates at the same time. You do not need to wait for each stack launch to complete before you deploy the next template.

Step 2. Launch the Core Template

This automated AWS CloudFormation template deploys the Media Services Application Mapper microservices on the AWS Cloud.

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 msam-core-release AWS CloudFormation template.

    
                                Media Services Application Mapper core API 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 the solution in a different AWS Region, use the region selector in the console navigation bar.

  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 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
    Alarms Table Name <Requires input>

    The name of the table that stores alarm states. The name is generated by the DynamoDB template you deployed in Step 1.

    Note

    You can find the name of the alarms table in the DynamoDB stack Outputs tab. The table name is value of the AlarmsTable key.

    Cache Item TTL 7200 The maximum time (in seconds) a cached item is retained, if never updated
    Channels Table Name <Requires input>

    The name of the table that stores channel definitions. The name is generated by the DynamoDB template you deployed in Step 1.

    Note

    You can find the name of the channels table in the DynamoDB stack Outputs tab. The table name is value of the ChannelsTable key.

    Content Table Name <Requires input>

    The name of the table that stores cached content. The name is generated by the DynamoDB template you deployed in Step 1.

    Note

    You can find the name of the content table in the DynamoDB stack Outputs tab. The table name is value of the ContentTable key.

    Events Table Name <Requires input>

    The name of the table that stores events. The name is generated by the DynamoDB template you deployed in Step 1.

    Note

    You can find the name of the events table in the DynamoDB stack Outputs tab. The table name is value of the EventsTable key. This table name must match the table name you enter in the Events Table Name events template parameter.

    Layout Table Name <Requires input>

    The name of the table that stores diagram layout information. The name is generated by the DynamoDB template you deployed in Step 1.

    Note

    You can find the name of the layout table in the DynamoDB stack Outputs tab. The table name is value of the LayoutTable key.

    Settings Table Name <Requires input>

    The name of the table that stores configuration settings. The name is generated by the DynamoDB template you deployed in Step 1.

    Note

    You can find the name of the settings table in the DynamoDB stack Outputs tab. The table name is value of the SettingsTable key.

  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. Select Create Change Set.

  10. Choose Execute 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 10 minutes.

Step 3. Launch the Events Template

This automated AWS CloudFormation template deploys the solution's event handler microservices.

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 msam-events-release AWS CloudFormation template.

    
                                Media Services Application Mapper events 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 the solution in a different AWS Region, use the region selector in the console navigation bar.

  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 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
    Events Table Name <Requires input>

    The name of the table that stores events. The name is generated by the DynamoDB template you deployed in Step 1.

    Note

    You can find the name of the events table in the DynamoDB stack Outputs tab. The table name is value of the EventsTable key. This table name must match the table name you enter in the Events Table Name events template parameter.

    Events Table Region <Requires input> The AWS Region where the events table is located
    Item TTL 604800 The maximum time (in seconds) a record in the events table is retained
  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. Select Create Change Set.

  10. Choose Execute 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 10 minutes.

Step 4. Launch the Browser App Template

This automated AWS CloudFormation template deploys the solution's browser app.

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 msam-browser-app-release AWS CloudFormation template.

    
                                Media Services Application Mapper browser app 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 the solution in a different AWS Region, use the region selector in the console navigation bar.

  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 stack.

  5. Choose Next.

  6. On the Options page, choose Next.

  7. 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.

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

Step 5. Configure the Browser App

  1. Navigate to the to the AWS CloudFormation console and check the box next to the core solution stack name.

  2. In the stack Outputs tab, note the value of the EndpointURL key. You will need it later.

  3. Navigate to the to the Amazon API Gateway console.

  4. In the navigation pane, select Usage Plans.

  5. Select MSAM Usage Plan.

  6. In the API Keys tab, select the API key.

  7. Select Show.

  8. Note the API key. You will need it later.

  9. Navigate to the to the AWS CloudFormation console and check the box next to the browser app stack name.

  10. In the stack Outputs tab, select the value of the MSAMBrowserURL key.

  11. In the API Endpoint Connection window, enter the Endpoint URL and the API Key you noted earlier.

  12. Turn on Do Not Remember if you do not want to store the endpoint and the API key in your browser cookies after the browser is closed. If you do not turn on Do Not Remember, the endpoint and API key will be stored in your browser cookies and reused the next time you attempt to connect.

    Important

    If a stored endpoint and API key are not used for seven consecutive days, they will be deleted automatically. When you use a stored endpoint and key, the expiration timer is reset.

  13. Select Connect.