aws-codebuild: Project secondaryArtifacts not removed from resource when property is removed

[rahuldeverani]

Describe the bug

In CodeBuild Project , if secondary artifacts are removed from CDK code, secondary artifacts are not removed from the resource. This issue is occurring because CDK removes the secondary artifact from the CFN template from the template when this is commented in cdk code.

There seems to be limitation with CFN resource 'AWS::CodeBuild::Project' where to unset or remove a project value via CFN, explicitly provide the attribute with value as empty input : https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html

So CDK should synthsize the template such that, if the secondary artifact is removed from code during update, then the synthesised template should have SecondaryArtifacts as []. This would unset the property.

Regression Issue

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

Last Known Working CDK Version

No response

Expected Behavior

Secondary artifacts must be removed from the project.

Current Behavior

Secondary artifacts are not getting removed.

Reproduction Steps

Code to replicate:

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as s3 from 'aws-cdk-lib/aws-s3';
import * as codecommit from 'aws-cdk-lib/aws-codecommit';
import * as codebuild from 'aws-cdk-lib/aws-codebuild';


export class CdknewStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const primaryArtifactBucket = new s3.Bucket(this, 'PrimaryArtifactBucket', {
      removalPolicy: cdk.RemovalPolicy.DESTROY,
      autoDeleteObjects: true,
      versioned: true,
    });

    const secondaryArtifactBucket = new s3.Bucket(this, 'SecondaryArtifactBucket', {
      removalPolicy: cdk.RemovalPolicy.DESTROY,
      autoDeleteObjects: true,
      versioned: true,
    });
    const buildProject = new codebuild.Project(this, 'BuildProject', {
      projectName: 'multi-artifact-project',
      buildSpec: codebuild.BuildSpec.fromObjectToYaml({
        version: '0.2',
        phases: {
          build: {
            commands: [
              'echo "Building primary and secondary artifacts"',
              'mkdir -p primary-output/',
              'mkdir -p secondary-output/',
              'echo "Primary content" > primary-output/primary.txt',
              'echo "Secondary content" > secondary-output/secondary.txt',
            ],
          },
        },
        artifacts: {
          files: ['**/*'],
          'base-directory': 'primary-output',
        },
        secondaryArtifacts: [
          {
            artifactIdentifier: 'SecondaryArtifact',
            files: ['**/*'],
            'base-directory': 'secondary-output',
          },
        ],
      }),
      artifacts: codebuild.Artifacts.s3({
        bucket: primaryArtifactBucket,
        includeBuildId: true,
        packageZip: true,
        path: 'primary',
      }),
     secondaryArtifacts: [
        codebuild.Artifacts.s3({
          bucket: secondaryArtifactBucket,
          identifier: 'SecondaryArtifact',
          includeBuildId: true,
          packageZip: true,
          path: 'secondary',
        }),
     ],
      environment: {
        buildImage: codebuild.LinuxBuildImage.AMAZON_LINUX_2_4,
      },
    });

    primaryArtifactBucket.grantReadWrite(buildProject);
   // secondaryArtifactBucket.grantReadWrite(buildProject);

  }}

After the stack is created from above code. Comment or remove secondaryArtifacts from the code and update the stack.

Possible Solution

CDK should synthsize the template such that, if the secondary artifact is removed from code during update, then the synthesised template should have SecondaryArtifacts as []. This would unset the property.

Additional Information/Context

No response

CDK CLI Version

2.175.1

Framework Version

No response

Node.js Version

v23.1.0

OS

MacOs

Language

TypeScript

Language Version

No response

Other information

No response

[pahud]

Did you mean after initial deploy, now if you comment off this

  secondaryArtifacts: [
        codebuild.Artifacts.s3({
          bucket: secondaryArtifactBucket,
          identifier: 'SecondaryArtifact',
          includeBuildId: true,
          packageZip: true,
          path: 'secondary',
        }),
     ],

cdk synth would not remove the SecondaryArtifacts prop?

Can you share what you are seeing with cdk diff ?

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