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

update layer doc to add short version #8161

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

update layer doc to add short version #8161

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4202d3
update layer doc to add short version
ykethan Dec 12, 2024
6f77bda
nits
ykethan Dec 13, 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
18 changes: 16 additions & 2 deletions src/pages/[platform]/build-a-backend/functions/add-lambda-layers/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,23 @@ To add a Lambda layer to your function, follow these steps:
},
});
```

The Lambda layer is represented by an object of key/value pairs where the key is the module name that is exported from your layer and the value is the ARN of the layer. The key (module name) is used to externalize the module dependency so it doesn't get bundled with your lambda function. A maximum of 5 layers can be attached to a function, and they must be in the same region as the function.

The Lambda layer is represented by an object of key/value pairs where the key is the module name that is exported from your layer and the value is the ARN of the layer. The key (module name) is used to externalize the module dependency so it doesn't get bundled with your lambda function. A maximum of 5 layers can be attached to a function, and they must be in the same region as the function.
ykethan marked this conversation as resolved.
Show resolved Hide resolved
<br/><br/>Alternatively, you can specify the layer as `myLayer:1` where `myLayer` is the name of the layer and `1` is the version of the layer. For example:
ykethan marked this conversation as resolved.
Show resolved Hide resolved

```ts title="amplify/functions/my-function/resource.ts"
import { defineFunction } from "@aws-amplify/backend";

export const myFunction = defineFunction({
name: "my-function",
layers: {
"module": "myLayer:1"
ykethan marked this conversation as resolved.
Show resolved Hide resolved
},
});
```

Amplify will automatically convert this to the full layer ARN format `arn:aws:lambda:<region>:<account-id>:layer:myLayer:1` using your existing account id and region.
ykethan marked this conversation as resolved.
Show resolved Hide resolved

<Callout type="warning">

When using layers, be mindful of versioning. The ARN includes a version number (e.g., `:12` in the example). Ensure you're using the appropriate version and have a strategy for updating layers when new versions are released.
Expand Down
Loading