[cloudfront]: migrating cloudfrontWebDistribution to Distribution

[santiagovj22]

Describe the bug

i am migrating from cloudfrontWebDistribution to Distribution.

before:

  const logicalIdcloudfrontDist = genLogicalId(scopeId, 'webDist')
  const cfDistribution: aws_cloudfront.CloudFrontWebDistribution = new aws_cloudfront.CloudFrontWebDistribution(
    scope,
    logicalIdcloudfrontDist,
    defaultProps
  )

after:

  const logicalIdcloudfrontDist = genLogicalId(scopeId, 'webDist')
  const cfDistribution: aws_cloudfront.Distribution = new aws_cloudfront.Distribution(
    scope,
    logicalIdcloudfrontDist,
    defaultProps
  )

then got this error:

| 8:27:58 AM | CREATE_FAILED | AWS::CloudFront::Distribution | CoreInfra/AppTier/CFNDist0/webDist (webDist) Resource handler returned message: "Invalid request provided: AWS::CloudFront::Distribution: One or more of the CNAMEs you provided are already associated with a different resource. (Service: CloudFront, Status Code: 409, Request ID: 103a9d3c-7f66-4b54-bc1c-9ea13f3cc799)" (RequestToken: d276c6f3-5447-4bec-0bb7-5a761708a076, HandlerErrorCode: InvalidRequest)`

This is because the deployment tried to create a new CloudFront distribution instead of reusing the old one.

after possibles workarounds none of them work:

   const cfnDistribution = cfDistribution.node.defaultChild as aws_cloudfront.CfnDistribution
   cfnDistribution.overrideLogicalId(logicalIdcloudfrontDist)

neither

 const cfnDistribution = cfDistribution.node.defaultChild as CfnElement
  cfnDistribution.node.id = logicalIdcloudfrontDist

due to:

Cannot assign to 'id' because it is a read-only property.ts(2540)
(property) Node.id: any
The id of this construct within the current scope.

This is a a scope-unique id. To obtain an app-unique id for this construct, use uniqueId.

@stability — stable

what should i do in this case? i have many cloudfrontDistributions already deployed using aws_cloudfront.cloudfrontWebDistribution but i have to migrate to aws_cloudfront.Distribution to use some features such as responseHeaderPolicy

i need to keep the old logicalId and reuse to the distribution

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Version

"aws-cdk": "2.97.1",     "aws-cdk-lib": "2.97.1",

Expected Behavior

deploy without issues

Current Behavior

stopped by this error

Reproduction Steps

migrating from cloudfrontWebDistribution to Distribution having deployed a distribution and deploy a new one with the same CNAME

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.148.1 (build 283525d)

Framework Version

No response

Node.js Version

v20.15.0

OS

windows

Language

TypeScript

Language Version

No response

Other information

No response

[pahud]

migrating cloudfrontWebDistribution to Distribution

If you need to migrate from cloudfrontWebDistribution to Distribution

1. you need to find out the logicalId of cloudfrontWebDistribution
2. create a new Distribution and override its logicalId using overrideLogicalId
3. run cdk diff make sure the existing distribution will not update any property that requires "resource replacement" as this will trigger CFN to create a new distribution which might conflict the existing one.
4. as long as the override would not update any properties it should work as expected.

[github-actions]

This issue has not received a response in a while. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

[santiagovj22]

Hi @pahud Thanks for your answer.

i did a wrokaround that i saw related to this issue:

Issue

this worked for me as scalable solution for hundreds distributions that i im unable to have fixed the LogicalId

(<any>(cfDistribution.node.defaultChild as CfnElement).node).id = 'CFDistribution'

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.