API.md

API Reference

Constructs

TailscaleLambdaProxy

Initializers

import { TailscaleLambdaProxy } from 'tailscale-lambda-proxy'

new TailscaleLambdaProxy(scope: Construct, id: string, props: TailscaleLambdaProxyProps)

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

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: TailscaleLambdaProxyProps

---

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 { TailscaleLambdaProxy } from 'tailscale-lambda-proxy'

TailscaleLambdaProxy.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.
extension	tailscale-lambda-extension.TailscaleLambdaExtension	No description.
lambda	aws-cdk-lib.aws_lambda_nodejs.NodejsFunction	No description.
lambdaFunctionUrl	aws-cdk-lib.aws_lambda.FunctionUrl	No description.
warmer	aws-cdk-lib.aws_lambda_nodejs.NodejsFunction	No description.
warmerRule	aws-cdk-lib.aws_events.Rule	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

extension^Required

public readonly extension: TailscaleLambdaExtension;

• Type: tailscale-lambda-extension.TailscaleLambdaExtension

---

lambda^Required

public readonly lambda: NodejsFunction;

• Type: aws-cdk-lib.aws_lambda_nodejs.NodejsFunction

---

lambdaFunctionUrl^Required

public readonly lambdaFunctionUrl: FunctionUrl;

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

---

warmer^Optional

public readonly warmer: NodejsFunction;

• Type: aws-cdk-lib.aws_lambda_nodejs.NodejsFunction

---

warmerRule^Optional

public readonly warmerRule: Rule;

• Type: aws-cdk-lib.aws_events.Rule

---

Structs

TailscaleLambdaProxyProps

Initializer

import { TailscaleLambdaProxyProps } from 'tailscale-lambda-proxy'

const tailscaleLambdaProxyProps: TailscaleLambdaProxyProps = { ... }

Properties

Name	Type	Description
tsHostname	string	The "Machine" name as shown in the Tailscale admin console that identifies the Lambda function.
tsSecretApiKey	aws-cdk-lib.aws_secretsmanager.ISecret	The name of the AWS Secrets Manager secret that contains the pure text Tailscale API Key.
debug	boolean	No description.
options	TailscaleLambdaProxyPropsOptions	No description.

---

tsHostname^Required

public readonly tsHostname: string;

• Type: string

The "Machine" name as shown in the Tailscale admin console that identifies the Lambda function.

---

tsSecretApiKey^Required

public readonly tsSecretApiKey: ISecret;

• Type: aws-cdk-lib.aws_secretsmanager.ISecret

The name of the AWS Secrets Manager secret that contains the pure text Tailscale API Key.

---

debug^Optional

public readonly debug: boolean;

• Type: boolean

---

options^Optional

public readonly options: TailscaleLambdaProxyPropsOptions;

• Type: TailscaleLambdaProxyPropsOptions

---

TailscaleLambdaProxyPropsLambdaOption

Initializer

import { TailscaleLambdaProxyPropsLambdaOption } from 'tailscale-lambda-proxy'

const tailscaleLambdaProxyPropsLambdaOption: TailscaleLambdaProxyPropsLambdaOption = { ... }

Properties

Name	Type	Description
functionName	string	No description.
nodeTlsRejectUnauthorized	boolean	No description.

---

functionName^Optional

public readonly functionName: string;

• Type: string

---

nodeTlsRejectUnauthorized^Optional

public readonly nodeTlsRejectUnauthorized: boolean;

• Type: boolean

---

TailscaleLambdaProxyPropsOptions

Initializer

import { TailscaleLambdaProxyPropsOptions } from 'tailscale-lambda-proxy'

const tailscaleLambdaProxyPropsOptions: TailscaleLambdaProxyPropsOptions = { ... }

Properties

Name	Type	Description
extension	aws-cdk-lib.aws_lambda.LayerVersionOptions	No description.
lambda	TailscaleLambdaProxyPropsLambdaOption	No description.
warmer	TailscaleLambdaProxyPropsWarmerOption	If provided, a separate Lambda function will be created to periodically invoke the Tailscale proxy Lambda function to keep it warm.

---

extension^Optional

public readonly extension: LayerVersionOptions;

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

---

lambda^Optional

public readonly lambda: TailscaleLambdaProxyPropsLambdaOption;

• Type: TailscaleLambdaProxyPropsLambdaOption

---

warmer^Optional

public readonly warmer: TailscaleLambdaProxyPropsWarmerOption;

• Type: TailscaleLambdaProxyPropsWarmerOption

If provided, a separate Lambda function will be created to periodically invoke the Tailscale proxy Lambda function to keep it warm.

---

TailscaleLambdaProxyPropsWarmerOption

Initializer

import { TailscaleLambdaProxyPropsWarmerOption } from 'tailscale-lambda-proxy'

const tailscaleLambdaProxyPropsWarmerOption: TailscaleLambdaProxyPropsWarmerOption = { ... }

Properties

Name	Type	Description
concurrentInvocations	number	No description.
functionName	string	No description.

---

concurrentInvocations^Optional

public readonly concurrentInvocations: number;

• Type: number

---

functionName^Optional

public readonly functionName: string;

• Type: string

---