ProductStackProps should extend StackProps

[bdoyle0182]

Describe the bug

ProductStack does not allow configuration of the underlying stack template for stack level configuration. This means you can't disable things like analyticsReporting on the stack template that the ProductStack generates. ProductStack constructor currently takes ProductStackProps which doesn't extend the base level StackProps even though ProductStack extends Stack Since CDK::AWS::METADATA resource type does not exist in GovCloud, this means a Stack with a StackSet that references a ProductStack cannot be deployed to GovCloud.

Regression Issue

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

Last Known Working CDK Version

No response

Expected Behavior

Being able to configure the Stack template that is generated by a ProductStack

Current Behavior

ProductStack doesn't allow configuring stack level options for how it synthesizes its stack templates.

Reproduction Steps

    readonly templateFile: string;
    private _parentProductStackHistory?;
    private _templateUrl?;
    private _parentStack;
    private assetBucket?;
    constructor(scope: Construct, id: string, props?: **ProductStackProps**);```

### Possible Solution

_No response_

### Additional Information/Context

_No response_

### CDK CLI Version

2.164.1

### Framework Version

_No response_

### Node.js Version

node22

### OS

n/a

### Language

TypeScript

### Language Version

_No response_

### Other information

_No response_

[bdoyle0182]

I've found a workaround where the ProductStack template will not include the AWS::CDK::METADATA resource if I include "versionReporting": false in my cdk.json for my repo where this is defined. However this limits me from adding conditional logic to disable the versionReporting / analyticsReporting only for the GovCloud template, allowing me to keep it on for all other regions that would be able to be done if ProductStackProps extended StackProps.

[ashishdhingra]

@bdoyle0182 Good afternoon. Could you please share self-contained minimal code to reproduce the issue that demonstrates CDK modules and constructs you are trying to use? Are you using ProductStackProps from aws-cdk-lib » aws_servicecatalog package? If yes, I do see that ProductStackProps interface doesn't extend StackProps interface, which would have provided access to other stack level properties like https://github.com/aws/aws-cdk/blob/a9d3b02783104fe862a3e863e8c89af845b49c8c/packages/aws-cdk-lib/core/lib/stack.ts#L167.

StackProps.analyticsReporting is used to set Stack's _versionReportingEnabled property here, which in injectMetadataResources() is used to determine whether metadata should be emitted in the synthesized CloudFormation template.

I'm unsure if ProductStackProps interface could be modified to extend StackProps interface since it could be a breaking change. Also, most of the constructs use pattern of defining property interface with relevant fields for construct and using it as one of the parameters for L2 construct.

The documentation for analyticsReporting specifies that it is an optional property with the default value as analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key. Hence, as a workaround, you could set analyticsReporting at CDK App level const app = new cdk.App({analyticsReporting: true});.

Thanks,
Ashish

[bdoyle0182]

Hi Ashish,

Unfortunately I can't share any code. But your assessment is correct, we're using that ProductStack from aws_servicecatalog.

Here is how the project looks

1. Create an app that instantiates a stack for each region we deploy to
2. The stack for each region instantiated by the app manages a stack set resource.
3. The stack set resource uses an instantiated ProductStack as the reference for the stack template to deploy as a part of the stack set.

I am actually using your work around right now by setting the config in my cdk.json of my project and it successfully does what I need. However, it is limiting. I have no issue with having version reporting enabled, it is just that AWS::CDK::METADATA does not exist in govcloud so there is no way to have version reporting enabled when one of my stack instances for my app is going to govcloud. If I wanted to have an override for just this region so that my commercial regions can still report, that does not work with the work around since it's app level and I can't override the setting on the ProductStack conditionally for the current region.

So there's really two issues here:

1. ProductStack type needs to be more flexible on how you configure the Stack template it uses by leveraging StackProps or something similar, whatever is needed to make the change non-breaking; but really at present you can't really do any stack configs on ProductStack which would be possible if you just hand provided the yaml / json for the template.
2. AWS CDK's current versions at the base level should not allow version reporting to be turned on for a stack
   resource if the stack's region is govcloud until the AWS::CDK::METADATA resource type is supported in govcloud. i.e. this can be fixed by having the Stack class have conditional logic that sets version reporting to false if the region for the Stack is a govcloud region. This should be non-breaking since you can't currently deploy a stack to govcloud with this turned on for a stack.

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

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