Skip to content

Commit 652b7f0

Browse files
dreamorosidreamorosi
authored
docs: fix format issues (#1122)
1 parent 9b52de4 commit 652b7f0

File tree

2 files changed

+62
-67
lines changed

2 files changed

+62
-67
lines changed

Diff for: ‎docs/core/logger.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ In each case, the printed log will look like this:
201201
When debugging in non-production environments, you can instruct Logger to log the incoming event with the middleware/decorator parameter `logEvent` or via `POWERTOOLS_LOGGER_LOG_EVENT` env var set to `true`.
202202

203203
???+ warning
204-
This is disabled by default to prevent sensitive info being logged
204+
This is disabled by default to prevent sensitive info being logged
205205

206206
=== "Middy Middleware"
207207

Diff for: ‎docs/index.md

+61-66
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
7676

7777
```yaml hl_lines="5"
7878
MyLambdaFunction:
79-
Type: AWS::Serverless::Function
79+
Type: AWS::Serverless::Function
8080
Properties:
81-
Layers:
82-
- !Sub arn:aws:lambda:${AWS::Region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3
81+
Layers:
82+
- !Sub arn:aws:lambda:${AWS::Region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3
8383
```
8484

8585
=== "Serverless framework"
@@ -89,56 +89,52 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
8989
hello:
9090
handler: lambda_function.lambda_handler
9191
layers:
92-
- arn:aws:lambda:${aws:region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3
92+
- arn:aws:lambda:${aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3
9393
```
9494

9595
=== "CDK"
9696

97-
```typescript hl_lines="11 16"
97+
```typescript hl_lines="13 19"
9898
import * as cdk from 'aws-cdk-lib';
9999
import { Construct } from 'constructs';
100100
import * as lambda from 'aws-cdk-lib/aws-lambda';
101+
101102
export class SampleFunctionWithLayer extends Construct {
102-
constructor(scope: Construct, id: string) {
103-
super(scope, id);
104-
// Create a Layer with AWS Lambda Powertools for TypeScript
105-
const powertoolsLayer = lambda.LayerVersion.fromLayerVersionArn(
106-
this,
107-
'PowertoolsLayer',
108-
`arn:aws:lambda:${cdk.Stack.of(this).region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3`
109-
);
110-
new lambda.Function(this, 'Function', {
111-
runtime: lambda.Runtime.NODEJS_16_X,
112-
// Add the Layer to a Lambda function
113-
layers: [powertoolsLayer],
114-
code: lambda.Code.fromInline(`
115-
const { Logger } = require('@aws-lambda-powertools/logger');
116-
const { Metrics } = require('@aws-lambda-powertools/metrics');
117-
const { Tracer } = require('@aws-lambda-powertools/tracer');
118-
const logger = new Logger({logLevel: 'DEBUG'});
119-
const metrics = new Metrics();
120-
const tracer = new Tracer();
121-
exports.handler = function(event, ctx) {
122-
logger.debug("Hello World!");
123-
}`),
124-
handler: 'index.handler',
125-
});
126-
}
103+
constructor(scope: Construct, id: string) {
104+
super(scope, id);
105+
106+
// Create a Layer with AWS Lambda Powertools for TypeScript
107+
const powertoolsLayer = lambda.LayerVersion.fromLayerVersionArn(
108+
this,
109+
'PowertoolsLayer',
110+
`arn:aws:lambda:${cdk.Stack.of(this).region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3`
111+
);
112+
113+
new lambda.Function(this, 'Function', {
114+
runtime: lambda.Runtime.NODEJS_16_X,
115+
// Add the Layer to a Lambda function
116+
layers: [powertoolsLayer],
117+
code: lambda.Code.fromInline(`...`),
118+
handler: 'index.handler',
119+
});
120+
}
127121
}
128122
```
129123

130124
=== "Terraform"
131125

132-
```terraform hl_lines="9 38"
126+
```terraform hl_lines="9 36"
133127
terraform {
134128
required_version = "~> 1.0.5"
135129
required_providers {
136130
aws = "~> 3.50.0"
137131
}
138132
}
133+
139134
provider "aws" {
140-
region = "{region}"
135+
region = "{aws::region}"
141136
}
137+
142138
resource "aws_iam_role" "iam_for_lambda" {
143139
name = "iam_for_lambda"
144140
assume_role_policy = <<EOF
@@ -154,15 +150,16 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
154150
}
155151
]
156152
}
157-
EOF
158-
}
153+
EOF
154+
}
155+
159156
resource "aws_lambda_function" "test_lambda" {
160157
filename = "lambda_function_payload.zip"
161158
function_name = "lambda_function_name"
162159
role = aws_iam_role.iam_for_lambda.arn
163-
handler = "index.test"
160+
handler = "index.handler"
164161
runtime = "nodejs16.x"
165-
layers = ["arn:aws:lambda:{region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3"]
162+
layers = ["arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3"]
166163
source_code_hash = filebase64sha256("lambda_function_payload.zip")
167164
}
168165
```
@@ -178,7 +175,7 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
178175
? Do you want to configure advanced settings? Yes
179176
...
180177
? Do you want to enable Lambda layers for this function? Yes
181-
? Enter up to 5 existing Lambda layer ARNs (comma-separated): arn:aws:lambda:eu-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:3
178+
? Enter up to 5 existing Lambda layer ARNs (comma-separated): arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3
182179
❯ amplify push -y
183180
# Updating an existing function and add the layer
184181
❯ amplify update function
@@ -187,15 +184,13 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
187184
- Name: <NAME-OF-FUNCTION>
188185
? Which setting do you want to update? Lambda layers configuration
189186
? Do you want to enable Lambda layers for this function? Yes
190-
? Enter up to 5 existing Lambda layer ARNs (comma-separated): arn:aws:lambda:eu-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:3
187+
? Enter up to 5 existing Lambda layer ARNs (comma-separated): arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3
191188
? Do you want to edit the local lambda function now? No
192189
```
193190

194191
=== "Get the Layer .zip contents"
195-
Change `{region}` to your AWS region, e.g. `eu-west-1`
196-
197192
```bash title="AWS CLI"
198-
aws lambda get-layer-version-by-arn --arn arn:aws:lambda:{region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3 --region {region}
193+
aws lambda get-layer-version-by-arn --arn arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:3 --region {region}
199194
```
200195

201196
The pre-signed URL to download this Lambda Layer will be within `Location` key.
@@ -206,23 +201,23 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
206201

207202
If you use `esbuild` to bundle your code, make sure to exclude `@aws-lambda-powertools` from being bundled since the packages will be brought by the Layer:
208203

209-
=== "SAM" (check the [doc](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-using-build-typescript.html) for more details)
204+
=== "SAM (check the [doc](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-using-build-typescript.html) for more details)"
210205

211206
```yaml hl_lines="5"
212207
MyLambdaFunction:
213-
Type: AWS::Serverless::Function
214-
Properties:
215-
...
216-
Metadata:
217-
# Manage esbuild properties
218-
BuildMethod: esbuild
219-
BuildProperties:
220-
Minify: true
221-
External:
222-
- '@aws-lambda-powertools/commons'
223-
- '@aws-lambda-powertools/logger'
224-
- '@aws-lambda-powertools/metrics'
225-
- '@aws-lambda-powertools/tracer'
208+
Type: AWS::Serverless::Function
209+
Properties:
210+
...
211+
Metadata:
212+
# Manage esbuild properties
213+
BuildMethod: esbuild
214+
BuildProperties:
215+
Minify: true
216+
External:
217+
- '@aws-lambda-powertools/commons'
218+
- '@aws-lambda-powertools/logger'
219+
- '@aws-lambda-powertools/metrics'
220+
- '@aws-lambda-powertools/tracer'
226221
```
227222

228223
=== "Serverless framework (check the [doc](https://floydspace.github.io/serverless-esbuild/) for more details)"
@@ -240,17 +235,17 @@ If you use `esbuild` to bundle your code, make sure to exclude `@aws-lambda-powe
240235
=== "CDK (check the [doc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda_nodejs.BundlingOptions.html#externalmodules) for more details)"
241236

242237
```typescript hl_lines="11 16"
243-
new awsLambdaNodejs.NodejsFunction(this, 'Function', {
244-
...
245-
bundling: {
246-
externalModules: [
247-
'@aws-lambda-powertools/commons',
248-
'@aws-lambda-powertools/logger',
249-
'@aws-lambda-powertools/metrics',
250-
'@aws-lambda-powertools/tracer',
251-
],
252-
}
253-
});
238+
new awsLambdaNodejs.NodejsFunction(this, 'Function', {
239+
...
240+
bundling: {
241+
externalModules: [
242+
'@aws-lambda-powertools/commons',
243+
'@aws-lambda-powertools/logger',
244+
'@aws-lambda-powertools/metrics',
245+
'@aws-lambda-powertools/tracer',
246+
],
247+
}
248+
});
254249
```
255250

256251
### NPM Modules

0 commit comments

Comments
 (0)