pipelines: Stage can't deploy an existing stack bound to another scope

[justinwiley]

Describe the bug

I have an existing application, with a stack called 'ExampleStack' that I have been deploying via cdk deploy ExampleStack. It's bound to the scope of the app:

const app = new App();
const exampleStack = new ExampleStack(app, 'ExampleStack', props); 

I want to set up a new code pipeline, using CDK Pipeline to deploy ExampleStack, per AWS recommended best practices.

However, when I move the example stack into a stage:

class ExampleStage extends Stage {
  constructor(scope: Construct, id: string, props: StageProps) {
    super(scope, id, props);

    new ExampleStack(this, 'ExampleStack', props);  // example stack duplicate created
  }
}

...the logical id of the stack changes, since it's now in the scope of the Stage, not the app, meaning an entirely new stack with duplicated resources is created which is not the desired behavior.

If I use the app in the stage:

class ExampleStage extends Stage {
  constructor(scope: Construct, id: string, props: StageProps) {
    super(scope, id, props);

    new ExampleStack(app, 'ExampleStack', props); // synth fails
  }
}

...it fails during synthesis time with:

The given Stage construct ('Example') should contain at least one Stack.

Expected Behavior

A convenient and documented way of deploying existing stacks in stages without having to recreate the or import their resources into a new stack.

Current Behavior

Stacks are recreated when moved into stages, or blueprint errors are thrown.

Reproduction Steps

See above.

Possible Solution

Update the stage synth method to allow a scope to be passed in, and reference it during synthesis:

  interface StageSynthesisOptions = {
    ...
    synthesisScope: App|Stage
  }

  public synth(options: StageSynthesisOptions = { }): cxapi.CloudAssembly {
    if (!this.assembly || options.force) {
      this.assembly = synthesize(options.synthesisScope || this, {
        skipValidation: options.skipValidation,
        validateOnSynthesis: options.validateOnSynthesis,
      });
    }

    return this.assembly;
  }

...and updating what invokes snyth to pass on the new argument as well.

Additional Information/Context

No response

CDK CLI Version

2.83.0 (build 0fd7f2b)

Framework Version

No response

Node.js Version

18

OS

mac

Language

Typescript

Language Version

No response

Other information

No response

[peterwoodworth]

Did you try supplying the stackName directly?

[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.