Follow these steps to launch and access your TDM (Test Data Manager) application using AWS CloudFormation stack.

One-click Deployment

1. Choose a Deployment Option

When launching the stack, select one of the following options:

• Launch Stack (self-hosted custom domain)
  Choose this if you have a custom domain configured in Route 53 that you want TDM to use.
• Launch Stack (no domain, self-signed certificate)
  Choose this if you prefer to access TDM via an AWS-generated URL secured with a self-signed certificate.

2. Configure Stack Parameters

Provide values for the required parameters:

• Most fields come with default values (for example, redgate/tdm:latest for ContainerImageUri).
• Enter a Stack Name of your choice.
• If using a custom domain:
  • Select your Route 53 Hosted Zone ID.
  • Enter a subdomain prefix that TDM will use.

3. Acknowledge Permissions

• Check the box labeled:
  “I acknowledge that AWS CloudFormation might create IAM resources.”

4. Create the Stack

• Click Create Stack to begin deployment.

5. Wait for Deployment to Complete

• Stack creation typically takes 5–10 minutes.
• You can monitor progress in the CloudFormation console.

6. Access TDM

• If you used the self-signed certificate option:
  • Navigate to the Outputs tab in CloudFormation to find the access URL.
• If you used a custom domain:
  • Access TDM via the domain you configured (can find the URL under the Outputs tab in CloudFormation as well).

Managing TDM Container Versions

Default Behavior

• The ContainerImageUri parameter is set to latest by default.
• The stack does not automatically update while running.
• However, TDM will update to the latest version when:
  • The stack is restarted, or
  • A stack update is triggered (even without changing parameters)

Pinning to a Specific Version

• You can specify a fixed version by updating the ContainerImageUri parameter with a specific image tag.
• After changing the value, run a stack update.
• This ensures TDM remains on a consistent, known version.

Deployment Behavior

• During a stack update:
  • ECS performs a rolling deployment, minimizing downtime.
  • Existing tasks are gradually replaced with new ones.

Data Persistence

• TDM data stored in EFS is preserved across deployments.
• Updating or redeploying the stack will not affect your stored data.

Viewing TDM Container Logs

After creating the stack, you can access the TDM container logs via CloudWatch:

1. In the AWS CloudFormation console, click Create Stack and wait for deployment to begin.
2. Open the newly created stack.
3. Navigate to the Resources tab.
4. Locate the resource named TdmLogGroup.
5. Click on this resource to open it in CloudWatch Logs.

This will take you directly to the log group for the TDM container, where you can view application logs and troubleshoot any issues.

Viewing and Editing Container Environment Variables

You can inspect and modify the TDM container’s environment variables via the task definition:

1. In the AWS CloudFormation console, open your stack.
2. Go to the Resources tab.
3. Locate and click on TDMTaskDef.

View Environment Variables

• On the task definition page, select the container.
• You will see a list of environment variables along with their current values.

Edit Environment Variables

• To make changes, click Create new revision at the top of the task definition page.
• Update the required environment variables in the new revision.
• Save the revision.

After creating a new revision, the updated configuration will be used the next time the service is deployed or updated.

Network Configuration

The TDM CloudFormation stack is configured with three types of subnets to separate resources and control network access:

• Public Subnet
  Used for resources that need direct access to the internet, such as load balancers.
• Private Subnet
  Used for resources that require outbound internet access (e.g. to download updates) but should not be directly accessible from the internet.
• Isolated Subnet
  Used for internal resources that should have no internet access at all, providing an additional layer of security.

This subnet structure helps enforce best practices for security and network segmentation within your deployment.

Removing the TDM Stack

• Using the AWS Console
  • Navigate to the CloudFormation console.
  • Select your stack.
  • Click Delete.

Data Retention

• The associated EFS (Elastic File System) is configured with a Retain removal policy.
• This means your TDM data is not deleted when the stack is removed.

Cleaning Up Resources

• After deleting the stack, the EFS instance will remain as an orphaned resource.
• If you no longer need the stored data, you can manually delete the EFS resource from the AWS console.