(CloudWatch Insights): amazon-cloudwatch-observability already exists

[pennywisdom]

Describe the bug

Upgrading from v1.13.1 to v1.14.1 fails with "amazon-cloudwatch-observability already exists" even when the implementation has not changed.

Expected Behavior

No change.

Current Behavior

Between 1.13.1 and 1.14.1 the logical id is changing from CloudWatchInsightsAddon to amazoncloudwatchobservabilityaddOn. As per the following documentation for CDK (see Logical ID stability at the foot of this page - https://docs.aws.amazon.com/cdk/v2/guide/identifiers.html):

Avoid changing the logical ID of a resource after it has been created. AWS CloudFormation identifies resources by their logical ID. Therefore, if you change the logical ID of a resource, AWS CloudFormation creates a new resource with the new logical ID, then deletes the existing one.

This is the issue we are experiencing, the previous object with the CloudWatchInsightsAddon is being deleted after the newer amazoncloudwatchobservabilityaddOn but both have the same physical id.

So when updating CDK even though a diff wants to destroy the previous one, the create is happening before the destroy as you would typically expect, but because physical id already exists then the error occurs

Reproduction Steps

create a cluster using 1.13.1 and add the cloudwatch insights addon using the default props e.g. const addOn = new blueprints.addons.CloudWatchInsights(). Then upgrade to 1.14.1.

Possible Solution

change the default props add on name or add a warning.

Additional Information/Context

No response

CDK CLI Version

2.133.0

EKS Blueprints Version

v1.14.1

Node.js Version

18

Environment details (OS name and version, etc.)

container - redhat/ubi8-minimal:8.8

Other information

No response