Update the solution

PDF

If you have previously deployed the solution, follow this procedure to update the solution’s CloudFormation stack to get the latest features and enhancements. There are three parts to the upgrade process:

• Step 1: Update Deployment dashboard

• Step 2: Migrate use case configurations

• Step 3: Update use cases

Note

1. In v2.0.0, we are deprecating direct integration with Anthropic and Hugging Face, in favor of Amazon Bedrock (Anthropic models hosted through Bedrock) and Amazon SageMaker. You can deploy models available through Hugging Face through SageMaker JumpStart. Refer to Use Hugging Face with Amazon SageMaker for more details.

2. Ensure you test the update process in a non-production environment before running these steps.

Step 1: Update Deployment dashboard

1. Sign in to the CloudFormation console, select your existing CloudFormation stack, and select Update.

2. Select Replace current template.

3. Under Specify template:

   1. Select Amazon S3 URL.

   2. Copy the latest CloudFormation template link.

   3. Paste the link in the Amazon S3 URL box.

   4. Verify that the correct template URL shows in the Amazon S3 URL text box, and choose Next. Choose Next again.

4. Under Parameters, review the parameters for the template and modify them as necessary. For details about the parameters, see Step 1: Launch the Deployment dashboard stack.

5. Choose Next.

6. On the Configure stack options page, choose Next.

7. On the Review page, review and confirm the settings. Check the box acknowledging that the template will create IAM resources.

8. Choose View change set and verify the changes.

9. Choose Update stack to deploy the stack.

You can view the status of the stack in the AWS CloudFormation console in the Status column. You should receive an UPDATE_COMPLETE status in approximately 10 minutes.

This update will create a web UI stack (which replaces amplify-ui implementation of the login screen with Cognito hosted UI) and new CloudFront URL, which can be obtained from the Output section of the CloudFormation console once the stack status is UPDATE_COMPLETE.

Note

Existing use cases created using versions prior to v2.0.0 will NOT be displayed until you completed the steps outlined below.

Step 2: Migrate use case configurations

The schema for storing and the AWS service to store use case configuration has changed in this version. Follow the steps described in GAAB v2 Migration User Guide using the gaab_v2_migration.py script. After you run the script, you can access the Deployment dashboard to view the deployed use cases.

Note

You must follow the steps below to complete migrating the use cases.

Step 3: Update use cases

You can edit the deployed use cases with new features available in v2.0.0. See Use the solution for information about how to use the features in this solution.

To update use cases to v2.0.0, you must complete the `Edit`use case steps in the Deployment dashboard (although you might not make any changes). This action triggers a CloudFormation stack update and uses the latest template version, which will upgrade the use cases to v2.0.0.

Note

Use cases created with 1.x versions of the solution might not work with later versions. Hence, we recommend cloning existing use cases created with versions prior to v2.0.0 through the Deployment dashboard. Then, gradually migrate and replace with new use cases created using v2.0.0 or later.