Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(doc): improve the doc on DockerImageFunction for cross-platform bundling #31053

Merged
merged 4 commits into from
Aug 28, 2024
Merged

chore(doc): improve the doc on DockerImageFunction for cross-platform bundling #31053

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
79a2dd2
improve doc
pahud Aug 7, 2024
1de4c10
minor
pahud Aug 7, 2024
d845830
Update packages/aws-cdk-lib/aws-lambda/README.md
pahud Aug 28, 2024
31c1e48
Merge branch 'main' into pahud/lambda-default-architecture-31048
mergify[bot] Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/aws-cdk-lib/aws-lambda/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ configurations as well as choosing a specific tag or digest. See their docs for
To deploy a `DockerImageFunction` on Lambda `arm64` architecture, specify `Architecture.ARM_64` in `architecture`.
This will bundle docker image assets for `arm64` architecture with `--platform linux/arm64` even if build within an `x86_64` host.

With that being said, if you are bundling `DockerImageFunction` for Lambda `amd64` architecture from a `arm64` machine like a Macbook with `arm64` CPU, you would
need to specify `architecture: lambda.Architecture.X86_64` as well. This ensures the `--platform` argument is passed to the image assets
bundling process so you can bundle up `X86_64` images from the `arm64` machine.

```ts
new lambda.DockerImageFunction(this, 'AssetFunction', {
code: lambda.DockerImageCode.fromImageAsset(path.join(__dirname, 'docker-arm64-handler')),
Expand Down