Skip to content

Latest commit

 

History

History
179 lines (109 loc) · 6.07 KB

API.md

File metadata and controls

179 lines (109 loc) · 6.07 KB

API Reference

Constructs

LambdaKeepActive

Initializers 

import { LambdaKeepActive } from '@beesolve/lambda-keep-active'

new LambdaKeepActive(scope: Construct, id: string, props?: LambdaKeepActiveProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props LambdaKeepActiveProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsOptional

Methods

Name Description
toString Returns a string representation of this construct.
keepActive No description.
toString 
public toString(): string

Returns a string representation of this construct.

keepActive 
public keepActive(lambda: IFunction): void
lambdaRequired
  • 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.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Structs

LambdaKeepActiveProps

Initializer 

import { LambdaKeepActiveProps } from '@beesolve/lambda-keep-active'

const lambdaKeepActiveProps: 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.
enableLogsOptional 
public readonly enableLogs: boolean;
  • Type: boolean
  • Default: true

If disabled no logs are logged to CloudWatch.

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

Adjusts logging for SQS handler.