Sub-route method in an APIView class.
Whether to allow the Lambda to send all network traffic.
If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.
Lambda Functions in a public subnet can NOT access the internet.
Use this property to acknowledge this limitation and still place the function in a public subnet.
(experimental) The list of OIDC scopes to include in the authorization.
These scopes will be merged with the scopes from the attached authorizer
(experimental) Authorizer for a WebSocket API or an HTTP API.
Autoscaling and provisioned concurrency settings.
This sets the
AWS_NODEJS_CONNECTION_REUSE_ENABLED environment variable
Code signing config associated with this function.
Options for the
lambda.Version resource automatically created by the
The SQS queue to use if DLQ is enabled.
deadLetterQueue is undefined,
an SQS queue with default options will be defined for your Function.
The path to the dependencies lock file (
This will be used as the source for the volume mounted in the Docker container.
Modules specified in
nodeModules will be installed using the right
yarn) along with this lock file.
A description of the function.
Path to the file containing the handler. Normally shouldn't need to be specified and can be guessed.
Key-value pairs that Lambda caches and makes available for your Lambda functions.
Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.
The AWS KMS key that's used to encrypt your function's environment variables.
Event sources for this function.
You can also add event sources using
The filesystem configuration for the lambda function.
A name for the function.
The name of the exported handler in the entry file.
Initial policy statements to add to the created Lambda Role.
You can call
addToRolePolicy to the created lambda to add statements post creation.
Specify the version of CloudWatch Lambda insights to use for monitoring.
A list of layers to add to the function's execution environment.
You can configure your Lambda function to pull in additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies that can be used by multiple functions.
The number of days log events are kept in CloudWatch Logs.
this property, unsetting it doesn't remove the log retention policy. To
remove the retention policy, set the value to
When log retention is specified, a custom resource attempts to create the CloudWatch log group.
These options control the retry policy when interacting with CloudWatch APIs.
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
The maximum age of a request that Lambda sends to a function for processing.
Minimum: 60 seconds Maximum: 6 hours
The amount of memory, in MB, that is allocated to your Lambda function.
Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide.
Enabled HttpMethods for route.
path is defined, this determines which methods the path responds to.
The destination for failed invocations.
The destination for successful invocations.
An optional API Gateway path to trigger this function.
The path to the directory containing project config files (
The maximum of concurrent executions you want to reserve for the function.
The maximum number of times to retry when the function returns an error.
Minimum: 0 Maximum: 2
Lambda execution role.
This is the role that will be assumed by the function upon execution. It controls the permissions that the function will have. The Role must be assumable by the 'lambda.amazonaws.com' service principal.
The default Role automatically has permissions granted for Lambda execution. If you provide a Role, you must add the relevant AWS managed policies yourself.
The relevant managed policies are "service-role/AWSLambdaBasicExecutionRole" and "service-role/AWSLambdaVPCAccessExecutionRole".
The runtime environment.
Only runtimes of the Node.js family are supported.
Schedule on which to invoke this function. Triggers a CloudWatch Event.
(deprecated) What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead.
Only used if 'vpc' is supplied.
Use securityGroups property instead. Function constructor will throw an error if both are specified.
The list of security groups to associate with the Lambda's network interfaces.
Only used if 'vpc' is supplied.
The function execution time (in seconds) after which Lambda terminates the function.
Because the execution time affects cost, set this value based on the function's expected execution time.
Enable AWS X-Ray Tracing for Lambda Function.
Disable default authorizer.
Set to true for routes that do not require authorization if your routes normally require it.
VPC for functions. Defaults to database VPC if grantDatabaseAccess is true.
Where to place the network interfaces within the VPC.
Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.
Generated using TypeDoc