API.md

API Reference

Constructs

LambdaKeepActive

Initializers

import{LambdaKeepActive}from'@beesolve/lambda-keep-active'newLambdaKeepActive(scope: Construct,id: string,props?: LambdaKeepActiveProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	LambdaKeepActiveProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Optional

• Type:LambdaKeepActiveProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
keepActive	No description.

---

toString

publictoString(): string

Returns a string representation of this construct.

keepActive

publickeepActive(lambda: IFunction): void

lambda^Required

• Type: aws-cdk-lib.aws_lambda.IFunction

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import{LambdaKeepActive}from'@beesolve/lambda-keep-active'LambdaKeepActive.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.

---

node^Required

public readonlynode: Node;

• Type: constructs.Node

The tree node.

---

Structs

LambdaKeepActiveProps

Initializer

import{LambdaKeepActiveProps}from'@beesolve/lambda-keep-active'constlambdaKeepActiveProps: LambdaKeepActiveProps={ ... }

Properties

Name	Type	Description
enableLogs	boolean	If disabled no logs are logged to CloudWatch.
logGroupProps	aws-cdk-lib.aws_logs.LogGroupProps	Adjusts logging for SQS handler.

---

enableLogs^Optional

publicreadonly enableLogs: boolean;

• Type: boolean
• Default: true

If disabled no logs are logged to CloudWatch.

---

logGroupProps^Optional

publicreadonly logGroupProps: LogGroupProps;

• Type: aws-cdk-lib.aws_logs.LogGroupProps
• Default: { removalPolicy: RemovalPolicy.DESTROY, retention: RetentionDays.TWO_WEEKS }

Adjusts logging for SQS handler.

---