From 96492ee7046204fae7fd678781bbaef639e03686 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Wed, 8 Mar 2023 18:05:13 +0100 Subject: [PATCH] docs: updated layer info --- docs/index.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/index.md b/docs/index.md index 2b2654c7bd..43ffd3213d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,13 +24,15 @@ You can use Powertools in both TypeScript and JavaScript code bases. ## Install -Powertools is available in the following formats: +You can install Powertools using one of the following options: * **Lambda Layer**: [**arn:aws:lambda:{region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:9**](#){: .copyMe}:clipboard: -* **npm**: **`npm install @aws-lambda-powertools/tracer @aws-lambda-powertools/metrics @aws-lambda-powertools/logger`** +* **npm**: [`npm install @aws-lambda-powertools/tracer @aws-lambda-powertools/metrics @aws-lambda-powertools/logger`](#){: .copyMe}:clipboard: ### Lambda Layer +???+ warning "As of now, Container Image deployment (OCI) or inline Lambda functions do not support Lambda Layers." + [Lambda Layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html){target="_blank"} is a .zip file archive that can contain additional code, pre-packaged dependencies, data, or configuration files. Layers promote code sharing and separation of responsibilities so that you can iterate faster on writing business logic. You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html#invocation-layers-using){target="_blank"}, or your preferred deployment framework. @@ -245,17 +247,16 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https: ? Do you want to edit the local lambda function now? No ``` - === "Get the Layer .zip contents" - ```bash title="AWS CLI" - aws lambda get-layer-version-by-arn --arn arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:9 --region {region} - ``` - - The pre-signed URL to download this Lambda Layer will be within `Location` key. +!!! info "Using Powertools via Lambda Layer? Simply add the Powertools utilities you are using as a development dependency." -???+ warning "Warning: Limitations" +??? question "Want to inspect the contents of the Layer?" + Change {region} to your AWS region, e.g. `eu-west-1` - Container Image deployment (OCI) or inline Lambda functions do not support Lambda Layers. + ```bash title="AWS CLI" + aws lambda get-layer-version-by-arn --arn arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:9 --region {region} + ``` + The pre-signed URL to download this Lambda Layer will be within `Location` key. ## Instrumentation