asset-staging.ts: target platform ignored when bundling asset

[t3r]

Describe the bug

When bundling an asset e.g. in an s3_deployment using docker, the platform property gets ignored. The bundling always takes place on the host's platform.

Expected Behavior

Using
platform: 'linux/amd64'
should bundle for amd64 on M1 and
platform: 'linux/arm64'
should bundle for ARM on amd64 architecture as described in https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.BundlingOptions.html#platform

Current Behavior

platform: 'something' is silently ignored.

Reproduction Steps

Bundle for a s3_deployment like this:

new s3_deployment.BucketDeployment(this, 'platform-bug', {
      sources: [s3_deployment.Source.asset('.', {
        bundling: {
          image: lambda.Runtime.PYTHON_3_9.bundlingImage,
          platform: 'linux/amd64',
          //platform: 'linux/arm64',
          command: [
            'bash', '-c',
            'uname -m > /asset-output/uname-m.out.txt'
          ],
        },
      })],
      destinationBucket: bucket,
      destinationKeyPrefix: 'test',
    })

Do a cdk synthesize and look into the created output file 'uname-m.out.txt' asset in cdk.out. Whatever you put into 'platform', it always contains your host machine's platform string.

Possible Solution

The reason is that the platform given does not get propagated in aws-cdk-lib/core/lib/private/asset-staging.ts when calling image.run().
adding platform: this.options.platform at two places fixes the issue.
Pull request is on it's way.

Additional Information/Context

No response

CDK CLI Version

2.141.0 (build 3d1c06e)

Framework Version

No response

Node.js Version

v20.11.0

OS

macos 14.4.1 (23E224)

Language

TypeScript

Language Version

No response

Other information

As a sidenote: before changing the platform, the local docker build image, e.g. public.ecr.aws/sam/build-python3.9:latest has to be deleted manually using docker image rm public.ecr.aws/sam/build-python3.9:latest. Otherwise docker would use the same image for a different/wrong platform with unwanted behavior.
Fixing that is not within the scope of this issue.

[pahud]

Thank you for the report. We'll review your PR when it's ready.

[t3r]

Thanks. PR#30240 is here.
Linter complains about missing tests but I intentionally did not implement it to not break tests on machines without docker buildx. Let me know if you need anything else.

[shnjp]

We were faced with the same problem.
Since the PRs have not been merged, we have worked around it with the code shown below.

import { DockerImage, type DockerRunOptions } from 'aws-cdk-lib'

 export class PatchedDockerImage extends DockerImage {
   public static override fromRegistry(image: string) {
     return new PatchedDockerImage(image)
   }

   run(options?: DockerRunOptions): void {
     super.run({ ...options, platform: 'linux/arm64' })
   }
 }

 export const PATCHED_NODEJS_20_X_BUNDLING_IMAGE = PatchedDockerImage.fromRegistry('public.ecr.aws/sam/build-nodejs20.x')