API.md

API Reference

Constructs

WakeOnLambda

Initializers

import { WakeOnLambda } from 'wake-on-lambda'

new WakeOnLambda(scope: Construct, id: string, props: WakeOnLambdaProps)

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

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: WakeOnLambdaProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { WakeOnLambda } from 'wake-on-lambda'

WakeOnLambda.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
lambdaFn	aws-cdk-lib.aws_lambda.Function	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

lambdaFn^Required

public readonly lambdaFn: Function;

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

---

Structs

WakeOnLambdaProps

Initializer

import { WakeOnLambdaProps } from 'wake-on-lambda'

const wakeOnLambdaProps: WakeOnLambdaProps = { ... }

Properties

Name	Type	Description
destinationUrl	string	The url of destination server.
instanceId	string	The instance id of destination server.

---

destinationUrl^Required

public readonly destinationUrl: string;

• Type: string

The url of destination server.

---

instanceId^Required

public readonly instanceId: string;

• Type: string

The instance id of destination server.

---