Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Close
Guides
Updating the Engage Cloudformation Stack
1
.

Updating a Local Measure Engage CloudFormation Stack

Amazon CloudFormation - Stack Update

GUIDE

Updating the Engage Cloudformation Stack

Everything you need to know to keep the Engage CloudFormation stack up-to-date.

Intermediate
Technical
Next Module
2
Updating SMS Configuration
Icon arrow left
All Modules

As mentioned, Local Measure recommends creating a new, parallel CloudFormation stack for upgrades, rather than updating an existing stack. Once everything is confirmed to be working, the old CloudFormation stack can safely be deleted. This ensures that an operational environment can be maintained while any potential issues are investigated on the new CloudFormation stack.

No items found.

Instructions

To perform such a "dual stack" upgrade, log into the AWS account and navigate to the CloudFormation service. 

[.callout-primary--alert]NB: Local Measure does not recommend that environments using email routing be upgraded without assistance from Local Measure. Please reach out to Local Measure for assistance with this.[.callout-primary--alert]

Select 'Create Stack' -> 'With new resources (standard)'

Paste the Local Measure Engage stack template url (https://localmeasure-engage.s3.amazonaws.com/localmeasure-engage.yaml) in the Amazon S3 URL field as shown below and click 'Next'.

If you are updating your Engage environment for use with the Zendesk platform, or you are already using the Engage Voice for Zendesk app, please use the following alternative CloudFormation template URL: https://localmeasure-engage.s3.amazonaws.com/localmeasure-engage-voice.yaml

[.callout-primary--alert]Standard Engage CloudFormation templates can be updated with the Engage Voice template.[.callout-primary--alert]

‍

Under 'Stack name' fill in a descriptive name such as "LM-Engage-V2". NB: Very long stack names can result in a failure upon stack creation. The reason for this is that the stack name is included in the names of the resources, which could result in the eventual resource path exceeding the character limit for that service.

The template should be filled in with exactly the same values as for the original stack, with the following important exceptions:

| Parameter | Mandatory | Description | |---|---|---| | Authentication with Cognito | | | | EnableCognito | y | Select Existing | | UserPoolId | y | Navigate to the userpool which was created by the original CloudFormation stack. AWS Console -> Coginto. Select and open the userpool and copy the 'User pool ID' from the 'User pool overview' section. Paste the value in this field. | | AppClientId | y | After copying the UserPoolId, select the 'App Integration' tab and scroll to the bottom. Copy the 'Client ID'. Paste the value in this field. | | DomainPrefix | y | Enter the exact same value as when the initial stack was created. | | Email channel for Amazon Connect, using Simple Email Service (SES) | | | | EnableEmail | n | Same as original stack | | SESRegion | n | Same as original stack | | SESBucketName | n | If email was enabled in the original stack, the bucket will already exist. Fill in the same bucket name. | | SESBucketRegion | n | Same as original stack | | SESBucketExist | n | If email was enabled in the original stack, the bucket will already exist. Therefore select 'Yes'. | | CreateSESBucketPolicy | n | If email was enabled in the original stack, the bucket will already exist and the policy would already have been applied to the bucket.. Therefore select 'No'. | | SESReceiveEmail | n | Same as original stack | | Enable Engage AI features | | | | AISecretExists | n | If you already have an AI secret configured or it was done so in the original stack select ‘Yes’. | | AISecretARN | n | If AISecretExists was set to yes then copy the ARN of the AI secret into this field. | | AIBucketExists | n | If you already have an AI bucket configured or it was done so in the original stack select ‘Yes’. | | AIBucketName | n | If ‘AIBucketExists’ was set to yes, enter the name of the existing bucket. | | Enable Zendesk Integration | | | | EnableZendesk | n | Choose 'Yes' if you are updating the CloudFormation stack for use with the Engage Voice for Zendesk integration, otherwise leave as ‘no’. |

[.callout-primary--zap]Once you have filled in the CloudFormation template, check all fields to ensure that no additional whitespace (including tabs) have been added while copying and pasting the required values.[.callout-primary--zap]

Once everything has been checked:

  1. Click Next.
  2. On the next page, leave everything as-is and click Next (Tags are optional).
  3. On the next page, leave everything as-is and select “I acknowledge” at the bottom. Click Create Stack.
  4. The CloudFormation Stack will take about 10 minutes to run. Refresh the status (right-side button) to watch for errors. Once it’s complete, the main Stack you created will show CREATE_COMPLETE.

Upon completion, when all resources have been created, switch to the 'Outputs' tab.

[.callout-primary--alert]Local Measure will require these values in order to finalize the account setup. It is recommended to copy these values into an excel spreadsheet and to share this with the Local Measure Architect assisting you.[.callout-primary--alert]

There is no need to reconfigure the Cognito user pool after an upgrade as the existing configuration has been retained. If SMS or Email are enabled then configuration changes will be required in order to use the newly created resources. Please continue with the next modules to complete the configuration if SMS or Email is in use.

‍