From 2fd6e60e0587857c0b891f7ee6850b7dd9e36b15 Mon Sep 17 00:00:00 2001 From: Juanjo Diaz Date: Sun, 18 Feb 2024 20:25:06 +0100 Subject: [PATCH] docs: fix documentation of default role --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ff5e5e..04972be 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ The options are the same for all the warmers: * **cleanFolder** Whether to automatically delete the generated code folder. You might want to keep it if you are doing some custom packaging (defaults to `true`) * **name** Name of the generated warmer lambda (defaults to `${service}-${stage}-warmup-plugin-${warmerName}`) * **roleName** Name to be applied to the default warmer lambda role. Ignored if a the role setting is used (defaults to `${service.service}-${stage}-${region}-${warmerName.toLowerCase()}-role`) -* **role** Role to apply to the warmer lambda (defaults to the role in the provider) +* **role** Role to apply to the warmer lambda (defaults to a custom role with minimal [permissions](#permissions)) * **tags** Tag to apply to the generated warmer lambda (defaults to the serverless default tags) * **vpc** The VPC and subnets in which to deploy. Can be any [Serverless VPC configuration](https://serverless.com/framework/docs/providers/aws/guide/functions#vpc-configuration) or be set to `false` in order to deploy the warmup function outside of a VPC (defaults to the vpc in the provider) * **memorySize** The memory to be assigned to the warmer lambda (defaults to `128`)