API Reference

Constructs

App

Initializers

import { core } from '@monadahq/wingsdk'

new core.App(props: AppProps)

Name	Type	Description
`props`	`@monadahq/wingsdk.core.AppProps`	No description.

`props`^Required

Type: @monadahq/wingsdk.core.AppProps

Methods

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

`toString`

public toString(): string

Returns a string representation of this construct.

`synth`

public synth(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { core } from '@monadahq/wingsdk'

core.App.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.
`outdir`	`string`	No description.
`root`	`constructs.Construct`	No description.
`stateFile`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`outdir`^Required

public readonly outdir: string;

Type: string

`root`^Required

public readonly root: Construct;

Type: constructs.Construct

`stateFile`^Optional

public readonly stateFile: string;

Type: string

App

Initializers

import { local } from '@monadahq/wingsdk'

new local.App(props: AppProps)

Name	Type	Description
`props`	`@monadahq/wingsdk.local.AppProps`	No description.

`props`^Required

Type: @monadahq/wingsdk.local.AppProps

Methods

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

`toString`

public toString(): string

Returns a string representation of this construct.

`synth`

public synth(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { local } from '@monadahq/wingsdk'

local.App.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.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

Bucket

Represents a cloud object store.

Initializers

import { cloud } from '@monadahq/wingsdk'

new cloud.Bucket(scope: Construct, id: string, props?: BucketProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`@monadahq/wingsdk.cloud.BucketProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Optional

Type: @monadahq/wingsdk.cloud.BucketProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(_consumer: any, _capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`_consumer`^Required

Type: any

`_capture`^Required

Type: @monadahq/wingsdk.core.Capture

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { cloud } from '@monadahq/wingsdk'

cloud.Bucket.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

Bucket

Implements: @monadahq/wingsdk.cloud.IBucket, @monadahq/wingsdk.local.IResource

Initializers

import { local } from '@monadahq/wingsdk'

new local.Bucket(scope: Construct, id: string, props: BucketProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`@monadahq/wingsdk.cloud.BucketProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: @monadahq/wingsdk.cloud.BucketProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(consumer: any, _capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`consumer`^Required

Type: any

`_capture`^Required

Type: @monadahq/wingsdk.core.Capture

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { local } from '@monadahq/wingsdk'

local.Bucket.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

Bucket

Implements: @monadahq/wingsdk.cloud.IBucket

Initializers

import { tfaws } from '@monadahq/wingsdk'

new tfaws.Bucket(scope: Construct, id: string, props: BucketProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`@monadahq/wingsdk.cloud.BucketProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: @monadahq/wingsdk.cloud.BucketProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(consumer: any, capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`consumer`^Required

Type: any

`capture`^Required

Type: @monadahq/wingsdk.core.Capture

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { tfaws } from '@monadahq/wingsdk'

tfaws.Bucket.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

BucketBase

Implements: @monadahq/wingsdk.cloud.IBucket

Functionality shared between all Bucket implementations.

Initializers

import { cloud } from '@monadahq/wingsdk'

new cloud.BucketBase(scope: Construct, id: string, props: BucketProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`@monadahq/wingsdk.cloud.BucketProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: @monadahq/wingsdk.cloud.BucketProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(consumer: any, capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`consumer`^Required

Type: any

`capture`^Required

Type: @monadahq/wingsdk.core.Capture

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { cloud } from '@monadahq/wingsdk'

cloud.BucketBase.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

FileBase

Initializers

import { fs } from '@monadahq/wingsdk'

new fs.FileBase(scope: Construct, id: string, filePath: string)

Name	Type	Description
`scope`	`constructs.Construct`	construct scope.
`id`	`string`	construct id.
`filePath`	`string`	relative file path.

`scope`^Required

Type: constructs.Construct

construct scope.

`id`^Required

Type: string

construct id.

`filePath`^Required

Type: string

relative file path.

Methods

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

`toString`

public toString(): string

Returns a string representation of this construct.

`save`

public save(outdir: string): void

`outdir`^Required

Type: string

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { fs } from '@monadahq/wingsdk'

fs.FileBase.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.
`filePath`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`filePath`^Required

public readonly filePath: string;

Type: string

Function

Represents a serverless function.

Initializers

import { cloud } from '@monadahq/wingsdk'

new cloud.Function(scope: Construct, id: string, inflight: Inflight, props?: FunctionProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`inflight`	`@monadahq/wingsdk.core.Inflight`	No description.
`props`	`@monadahq/wingsdk.cloud.FunctionProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`inflight`^Required

Type: @monadahq/wingsdk.core.Inflight

`props`^Optional

Type: @monadahq/wingsdk.cloud.FunctionProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(_consumer: any, _capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`_consumer`^Required

Type: any

`_capture`^Required

Type: @monadahq/wingsdk.core.Capture

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { cloud } from '@monadahq/wingsdk'

cloud.Function.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

Function

Implements: @monadahq/wingsdk.local.IResource

Initializers

import { local } from '@monadahq/wingsdk'

new local.Function(scope: Construct, id: string, inflight: Inflight, props: FunctionProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`inflight`	`@monadahq/wingsdk.core.Inflight`	No description.
`props`	`@monadahq/wingsdk.cloud.FunctionProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`inflight`^Required

Type: @monadahq/wingsdk.core.Inflight

`props`^Required

Type: @monadahq/wingsdk.cloud.FunctionProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.
`addEnvironment`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(_consumer: any, _capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`_consumer`^Required

Type: any

`_capture`^Required

Type: @monadahq/wingsdk.core.Capture

`addEnvironment`

public addEnvironment(name: string, value: string): void

`name`^Required

Type: string

`value`^Required

Type: string

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { local } from '@monadahq/wingsdk'

local.Function.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

Function

Initializers

import { tfaws } from '@monadahq/wingsdk'

new tfaws.Function(scope: Construct, id: string, inflight: Inflight, props: FunctionProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`inflight`	`@monadahq/wingsdk.core.Inflight`	No description.
`props`	`@monadahq/wingsdk.cloud.FunctionProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`inflight`^Required

Type: @monadahq/wingsdk.core.Inflight

`props`^Required

Type: @monadahq/wingsdk.cloud.FunctionProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.
`addEnvironment`	No description.
`addPolicyStatements`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(_consumer: any, _capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`_consumer`^Required

Type: any

`_capture`^Required

Type: @monadahq/wingsdk.core.Capture

`addEnvironment`

public addEnvironment(name: string, value: string): void

`name`^Required

Type: string

`value`^Required

Type: string

`addPolicyStatements`

public addPolicyStatements(statements: PolicyStatement): void

`statements`^Required

Type: @monadahq/wingsdk.tfaws.PolicyStatement

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { tfaws } from '@monadahq/wingsdk'

tfaws.Function.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

FunctionBase

Implements: @monadahq/wingsdk.cloud.IFunction

Functionality shared between all Function implementations.

Initializers

import { cloud } from '@monadahq/wingsdk'

new cloud.FunctionBase(scope: Construct, id: string, inflight: Inflight, props: FunctionProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`inflight`	`@monadahq/wingsdk.core.Inflight`	No description.
`props`	`@monadahq/wingsdk.cloud.FunctionProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`inflight`^Required

Type: @monadahq/wingsdk.core.Inflight

`props`^Required

Type: @monadahq/wingsdk.cloud.FunctionProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(consumer: any, capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`consumer`^Required

Type: any

`capture`^Required

Type: @monadahq/wingsdk.core.Capture

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { cloud } from '@monadahq/wingsdk'

cloud.FunctionBase.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

JsonFile

Initializers

import { fs } from '@monadahq/wingsdk'

new fs.JsonFile(scope: Construct, id: string, filePath: string, props: JsonFileProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`filePath`	`string`	No description.
`props`	`@monadahq/wingsdk.fs.JsonFileProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`filePath`^Required

Type: string

`props`^Required

Type: @monadahq/wingsdk.fs.JsonFileProps

Methods

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

`toString`

public toString(): string

Returns a string representation of this construct.

`save`

public save(outdir: string): void

`outdir`^Required

Type: string

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { fs } from '@monadahq/wingsdk'

fs.JsonFile.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.
`filePath`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`filePath`^Required

public readonly filePath: string;

Type: string

Queue

Represents a serverless queue.

Initializers

import { cloud } from '@monadahq/wingsdk'

new cloud.Queue(scope: Construct, id: string, props: QueueProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`@monadahq/wingsdk.cloud.QueueProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: @monadahq/wingsdk.cloud.QueueProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(_consumer: any, _capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`_consumer`^Required

Type: any

`_capture`^Required

Type: @monadahq/wingsdk.core.Capture

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { cloud } from '@monadahq/wingsdk'

cloud.Queue.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

Queue

Implements: @monadahq/wingsdk.cloud.IQueue

Initializers

import { tfaws } from '@monadahq/wingsdk'

new tfaws.Queue(scope: Construct, id: string, props?: QueueProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`@monadahq/wingsdk.cloud.QueueProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Optional

Type: @monadahq/wingsdk.cloud.QueueProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.
`addWorker`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(_consumer: any, _capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`_consumer`^Required

Type: any

`_capture`^Required

Type: @monadahq/wingsdk.core.Capture

`addWorker`

public addWorker(fn: IFunction): void

`fn`^Required

Type: @monadahq/wingsdk.cloud.IFunction

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { tfaws } from '@monadahq/wingsdk'

tfaws.Queue.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

QueueBase

Implements: @monadahq/wingsdk.cloud.IQueue

Functionality shared between all Queue implementations.

Initializers

import { cloud } from '@monadahq/wingsdk'

new cloud.QueueBase(scope: Construct, id: string, props: QueueProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`@monadahq/wingsdk.cloud.QueueProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: @monadahq/wingsdk.cloud.QueueProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(consumer: any, capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`consumer`^Required

Type: any

`capture`^Required

Type: @monadahq/wingsdk.core.Capture

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { cloud } from '@monadahq/wingsdk'

cloud.QueueBase.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

Resource

Implements: @monadahq/wingsdk.cloud.IResource, @monadahq/wingsdk.core.ICapturable

Initializers

import { cloud } from '@monadahq/wingsdk'

new cloud.Resource(scope: Construct, id: string)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings. If the ID includes a path separator (/), then it will be replaced by double dash --.

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.

`toString`

public toString(): string

Returns a string representation of this construct.

`capture`

public capture(consumer: any, capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`consumer`^Required

Type: any

`capture`^Required

Type: @monadahq/wingsdk.core.Capture

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { cloud } from '@monadahq/wingsdk'

cloud.Resource.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.
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

TextFile

Initializers

import { fs } from '@monadahq/wingsdk'

new fs.TextFile(scope: Construct, id: string, filePath: string, props?: TextFileProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`filePath`	`string`	No description.
`props`	`@monadahq/wingsdk.fs.TextFileProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`filePath`^Required

Type: string

`props`^Optional

Type: @monadahq/wingsdk.fs.TextFileProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`save`	No description.
`addLine`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`save`

public save(outdir: string): void

`outdir`^Required

Type: string

`addLine`

public addLine(line: string): void

`line`^Required

Type: string

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { fs } from '@monadahq/wingsdk'

fs.TextFile.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.
`filePath`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`filePath`^Required

public readonly filePath: string;

Type: string

Structs

AppProps

Initializer

import { core } from '@monadahq/wingsdk'

const appProps: core.AppProps = { ... }

Properties

Name	Type	Description
`synthesizer`	`@monadahq/wingsdk.core.Synthesizer`	A synthesizer that handles setting up a CDK framework and registering a polycon factory.
`stateFile`	`string`	The path to a state file which will track all synthesized files.

`synthesizer`^Required

public readonly synthesizer: Synthesizer;

Type: @monadahq/wingsdk.core.Synthesizer

A synthesizer that handles setting up a CDK framework and registering a polycon factory.

`stateFile`^Optional

public readonly stateFile: string;

Type: string

The path to a state file which will track all synthesized files.

If a statefile is not specified, we won't be able to remove extrenous files.

AppProps

Initializer

import { local } from '@monadahq/wingsdk'

const appProps: local.AppProps = { ... }

Properties

Name	Type	Description
`outdir`	`string`	No description.

`outdir`^Required

public readonly outdir: string;

Type: string

BucketProps

Properties for Bucket.

Initializer

import { cloud } from '@monadahq/wingsdk'

const bucketProps: cloud.BucketProps = { ... }

Properties

Name	Type	Description
`public`	`boolean`	Whether objects in the bucket are publicly accessible.

`public`^Optional

public readonly public: boolean;

Type: boolean
Default: false

Whether objects in the bucket are publicly accessible.

Capture

Capture information.

A capture is a reference from an Inflight to a construction-time object or value.

Initializer

import { core } from '@monadahq/wingsdk'

const capture: core.Capture = { ... }

Properties

Name	Type	Description
`obj`	`any`	The captured object.
`methods`	`string[]`	Which methods are called on the captured object.

`obj`^Required

public readonly obj: any;

Type: any

The captured object.

`methods`^Optional

public readonly methods: string[];

Type: string[]

Which methods are called on the captured object.

FunctionProps

Properties for Function.

This is the type users see when constructing a cloud.Function instance.

Initializer

import { cloud } from '@monadahq/wingsdk'

const functionProps: cloud.FunctionProps = { ... }

Properties

Name	Type	Description
`env`	`{[ key: string ]: string}`	Environment variables to pass to the function.

`env`^Optional

public readonly env: {[ key: string ]: string};

Type: {[ key: string ]: string}
Default: No environment variables.

Environment variables to pass to the function.

InflightProps

Options for Inflight.

Initializer

import { core } from '@monadahq/wingsdk'

const inflightProps: core.InflightProps = { ... }

Properties

Name	Type	Description
`code`	`@monadahq/wingsdk.core.Code`	Reference to code containing the entrypoint function.
`entrypoint`	`string`	Name of the exported function to run.
`captures`	`{[ key: string ]: @monadahq/wingsdk.core.Capture}`	Capture information.

`code`^Required

public readonly code: Code;

Type: @monadahq/wingsdk.core.Code

Reference to code containing the entrypoint function.

`entrypoint`^Required

public readonly entrypoint: string;

Type: string

Name of the exported function to run.

Example

"exports.handler"

`captures`^Optional

public readonly captures: {[ key: string ]: Capture};

Type: {[ key: string ]: @monadahq/wingsdk.core.Capture}

Capture information.

During runtime, a map containing all captured values will be passed as the first argument of the entrypoint function.

Each key here will be the key for the final value in the map.

JsonFileProps

Initializer

import { fs } from '@monadahq/wingsdk'

const jsonFileProps: fs.JsonFileProps = { ... }

Properties

Name	Type	Description
`obj`	`any`	The object that will be serialized into the file during synthesis.

`obj`^Required

public readonly obj: any;

Type: any

The object that will be serialized into the file during synthesis.

PolicyStatement

Initializer

import { tfaws } from '@monadahq/wingsdk'

const policyStatement: tfaws.PolicyStatement = { ... }

Properties

Name	Type	Description
`action`	`string[]`	No description.
`effect`	`string`	No description.
`resource`	`string[]`	No description.

`action`^Optional

public readonly action: string[];

Type: string[]

`effect`^Optional

public readonly effect: string;

Type: string

`resource`^Optional

public readonly resource: string[];

Type: string[]

QueueProps

Properties for Queue.

Initializer

import { cloud } from '@monadahq/wingsdk'

const queueProps: cloud.QueueProps = { ... }

Properties

Name	Type	Description
`timeout`	`@monadahq/wingsdk.core.Duration`	No description.

`timeout`^Optional

public readonly timeout: Duration;

Type: @monadahq/wingsdk.core.Duration

ResourceSpec

Initializer

import { local } from '@monadahq/wingsdk'

const resourceSpec: local.ResourceSpec = { ... }

Properties

Name	Type	Description
`kind`	`string`	No description.
`name`	`string`	No description.
`props`	`any`	No description.

`kind`^Required

public readonly kind: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`props`^Required

public readonly props: any;

Type: any

SynthesizerProps

Initializer

import { core } from '@monadahq/wingsdk'

const synthesizerProps: core.SynthesizerProps = { ... }

Properties

Name	Type	Description
`customFactory`	`@monadahq/polycons.IPolyconFactory`	No description.
`outdir`	`string`	No description.

`customFactory`^Optional

public readonly customFactory: IPolyconFactory;

Type: @monadahq/polycons.IPolyconFactory

`outdir`^Optional

public readonly outdir: string;

Type: string

TextFileProps

Initializer

import { fs } from '@monadahq/wingsdk'

const textFileProps: fs.TextFileProps = { ... }

Properties

Name	Type	Description
`lines`	`string[]`	No description.

`lines`^Optional

public readonly lines: string[];

Type: string[]

Classes

Code

Reference to a piece of code.

Initializers

import { core } from '@monadahq/wingsdk'

new core.Code()

Name	Type	Description

Properties

Name	Type	Description
`language`	`@monadahq/wingsdk.core.Language`	The language of the code.
`path`	`string`	A path to the code in the user's file system that can be referenced for bundling purposes.
`text`	`string`	The code contents.

`language`^Required

public readonly language: Language;

Type: @monadahq/wingsdk.core.Language

The language of the code.

`path`^Required

public readonly path: string;

Type: string

A path to the code in the user's file system that can be referenced for bundling purposes.

`text`^Required

public readonly text: string;

Type: string

The code contents.

Duration

Static Functions

Name	Description
`fromHours`	No description.
`fromMinutes`	No description.
`fromSeconds`	No description.

`fromHours`

import { core } from '@monadahq/wingsdk'

core.Duration.fromHours(amount: number)

`amount`^Required

Type: number

`fromMinutes`

import { core } from '@monadahq/wingsdk'

core.Duration.fromMinutes(amount: number)

`amount`^Required

Type: number

`fromSeconds`

import { core } from '@monadahq/wingsdk'

core.Duration.fromSeconds(amount: number)

`amount`^Required

Type: number

Properties

Name	Type	Description
`hours`	`number`	No description.
`minutes`	`number`	No description.
`seconds`	`number`	No description.

`hours`^Required

public readonly hours: number;

Type: number

`minutes`^Required

public readonly minutes: number;

Type: number

`seconds`^Required

public readonly seconds: number;

Type: number

Inflight

Represents a unit of application code that can be executed at runtime within a cloud resource.

Initializers

import { core } from '@monadahq/wingsdk'

new core.Inflight(props: InflightProps)

Name	Type	Description
`props`	`@monadahq/wingsdk.core.InflightProps`	No description.

`props`^Required

Type: @monadahq/wingsdk.core.InflightProps

Properties

Name	Type	Description
`captures`	`{[ key: string ]: @monadahq/wingsdk.core.Capture}`	Capture information.
`code`	`@monadahq/wingsdk.core.Code`	Reference to code containing the entrypoint function.
`entrypoint`	`string`	Name of the exported function which will be run.

`captures`^Required

public readonly captures: {[ key: string ]: Capture};

Type: {[ key: string ]: @monadahq/wingsdk.core.Capture}

Capture information.

During runtime, a map containing all captured values will be passed as the first argument of the entrypoint function.

Each key here will be the key for the final value in the map.

`code`^Required

public readonly code: Code;

Type: @monadahq/wingsdk.core.Code

Reference to code containing the entrypoint function.

`entrypoint`^Required

public readonly entrypoint: string;

Type: string

Name of the exported function which will be run.

NodeJsCode

Reference to a piece of Node.js code.

Static Functions

Name	Description
`fromFile`	Reference code from a file path.
`fromInline`	Reference code directly from a string.

`fromFile`

import { core } from '@monadahq/wingsdk'

core.NodeJsCode.fromFile(path: string)

Reference code from a file path.

`path`^Required

Type: string

`fromInline`

import { core } from '@monadahq/wingsdk'

core.NodeJsCode.fromInline(text: string)

Reference code directly from a string.

`text`^Required

Type: string

Properties

Name	Type	Description
`language`	`@monadahq/wingsdk.core.Language`	The language of the code.
`path`	`string`	No description.
`text`	`string`	The code contents.

`language`^Required

public readonly language: Language;

Type: @monadahq/wingsdk.core.Language

The language of the code.

`path`^Required

public readonly path: string;

Type: string

`text`^Required

public readonly text: string;

Type: string

The code contents.

PolyconFactory

Implements: @monadahq/polycons.IPolyconFactory

Initializers

import { local } from '@monadahq/wingsdk'

new local.PolyconFactory()

Name	Type	Description

Methods

Name	Description
`resolve`	Resolve the parameters needed for creating a specific polycon into a concrete construct.

`resolve`

public resolve(polyconId: string, scope: IConstruct, id: string, args: any): IConstruct

Resolve the parameters needed for creating a specific polycon into a concrete construct.

`polyconId`^Required

Type: string

`scope`^Required

Type: constructs.IConstruct

`id`^Required

Type: string

`args`^Required

Type: any

PolyconFactory

Implements: @monadahq/polycons.IPolyconFactory

Initializers

import { tfaws } from '@monadahq/wingsdk'

new tfaws.PolyconFactory()

Name	Type	Description

Methods

Name	Description
`resolve`	Resolve the parameters needed for creating a specific polycon into a concrete construct.

`resolve`

public resolve(polyconId: string, scope: IConstruct, id: string, args: any): IConstruct

Resolve the parameters needed for creating a specific polycon into a concrete construct.

`polyconId`^Required

Type: string

`scope`^Required

Type: constructs.IConstruct

`id`^Required

Type: string

`args`^Required

Type: any

Synthesizer

Handles the initialization and synthesis of constructs for a given CDK framework.

Initializers

import { core } from '@monadahq/wingsdk'

new core.Synthesizer(props: SynthesizerProps)

Name	Type	Description
`props`	`@monadahq/wingsdk.core.SynthesizerProps`	No description.

`props`^Required

Type: @monadahq/wingsdk.core.SynthesizerProps

Methods

Name	Description
`synth`	Synthesize the app.

`synth`

public synth(): void

Synthesize the app.

Properties

Name	Type	Description
`outdir`	`string`	Path to the output directory.
`root`	`constructs.Construct`	Place in the construct tree where all users constructs will get added.

`outdir`^Required

public readonly outdir: string;

Type: string

Path to the output directory.

For example, if synthesizing to terraform, cdktf.out will be created in here.

`root`^Required

public readonly root: Construct;

Type: constructs.Construct

Place in the construct tree where all users constructs will get added.

Synthesizer

Initializers

import { local } from '@monadahq/wingsdk'

new local.Synthesizer(props?: SynthesizerProps)

Name	Type	Description
`props`	`@monadahq/wingsdk.core.SynthesizerProps`	No description.

`props`^Optional

Type: @monadahq/wingsdk.core.SynthesizerProps

Methods

Name	Description
`synth`	Synthesize the app.

`synth`

public synth(): void

Synthesize the app.

Properties

Name	Type	Description
`outdir`	`string`	Path to the output directory.
`root`	`constructs.Construct`	Place in the construct tree where all users constructs will get added.

`outdir`^Required

public readonly outdir: string;

Type: string

Path to the output directory.

For example, if synthesizing to terraform, cdktf.out will be created in here.

`root`^Required

public readonly root: Construct;

Type: constructs.Construct

Place in the construct tree where all users constructs will get added.

Synthesizer

Initializers

import { tfaws } from '@monadahq/wingsdk'

new tfaws.Synthesizer(props?: SynthesizerProps)

Name	Type	Description
`props`	`@monadahq/wingsdk.core.SynthesizerProps`	No description.

`props`^Optional

Type: @monadahq/wingsdk.core.SynthesizerProps

Methods

Name	Description
`synth`	Synthesize the app.

`synth`

public synth(): void

Synthesize the app.

Properties

Name	Type	Description
`outdir`	`string`	Path to the output directory.
`root`	`constructs.Construct`	Place in the construct tree where all users constructs will get added.

`outdir`^Required

public readonly outdir: string;

Type: string

Path to the output directory.

For example, if synthesizing to terraform, cdktf.out will be created in here.

`root`^Required

public readonly root: Construct;

Type: constructs.Construct

Place in the construct tree where all users constructs will get added.

Protocols

IBucket

Extends: @monadahq/wingsdk.cloud.IResource
Implemented By: @monadahq/wingsdk.cloud.Bucket, @monadahq/wingsdk.cloud.BucketBase, @monadahq/wingsdk.local.Bucket, @monadahq/wingsdk.tfaws.Bucket, @monadahq/wingsdk.cloud.IBucket

Properties

Name	Type	Description
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

ICapturable

Implemented By: @monadahq/wingsdk.cloud.Bucket, @monadahq/wingsdk.cloud.BucketBase, @monadahq/wingsdk.cloud.Function, @monadahq/wingsdk.cloud.FunctionBase, @monadahq/wingsdk.cloud.Queue, @monadahq/wingsdk.cloud.QueueBase, @monadahq/wingsdk.cloud.Resource, @monadahq/wingsdk.local.Bucket, @monadahq/wingsdk.local.Function, @monadahq/wingsdk.tfaws.Bucket, @monadahq/wingsdk.tfaws.Function, @monadahq/wingsdk.tfaws.Queue, @monadahq/wingsdk.core.ICapturable

Represents something that is capturable.

Methods

Name	Description
`capture`	Captures the resource for a given consumer so that it can be used in an Inflight.

`capture`

public capture(consumer: any, capture: Capture): Code

Captures the resource for a given consumer so that it can be used in an Inflight.

`consumer`^Required

Type: any

`capture`^Required

Type: @monadahq/wingsdk.core.Capture

IFunction

Extends: @monadahq/wingsdk.cloud.IResource
Implemented By: @monadahq/wingsdk.cloud.Function, @monadahq/wingsdk.cloud.FunctionBase, @monadahq/wingsdk.local.Function, @monadahq/wingsdk.tfaws.Function, @monadahq/wingsdk.cloud.IFunction

Properties

Name	Type	Description
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

IQueue

Extends: @monadahq/wingsdk.cloud.IResource
Implemented By: @monadahq/wingsdk.cloud.Queue, @monadahq/wingsdk.cloud.QueueBase, @monadahq/wingsdk.tfaws.Queue, @monadahq/wingsdk.cloud.IQueue

Properties

Name	Type	Description
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

IResource

Implemented By: @monadahq/wingsdk.cloud.Bucket, @monadahq/wingsdk.cloud.BucketBase, @monadahq/wingsdk.cloud.Function, @monadahq/wingsdk.cloud.FunctionBase, @monadahq/wingsdk.cloud.Queue, @monadahq/wingsdk.cloud.QueueBase, @monadahq/wingsdk.cloud.Resource, @monadahq/wingsdk.local.Bucket, @monadahq/wingsdk.local.Function, @monadahq/wingsdk.tfaws.Bucket, @monadahq/wingsdk.tfaws.Function, @monadahq/wingsdk.tfaws.Queue, @monadahq/wingsdk.cloud.IBucket, @monadahq/wingsdk.cloud.IFunction, @monadahq/wingsdk.cloud.IQueue, @monadahq/wingsdk.cloud.IResource

Properties

Name	Type	Description
`stateful`	`boolean`	Whether a resource is stateful, i.e. it stores information that is not defined by your application.

`stateful`^Required

public readonly stateful: boolean;

Type: boolean

Whether a resource is stateful, i.e. it stores information that is not defined by your application.

A non-stateful resource does not remember information about past transactions or events, and can typically be replaced by a cloud provider with a fresh copy without any consequences.

IResource

Extends: constructs.IConstruct
Implemented By: @monadahq/wingsdk.local.Bucket, @monadahq/wingsdk.local.Function, @monadahq/wingsdk.local.IResource

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

Enums

Language

The language of a piece of code.

Members

Name	Description
`NODE_JS`	No description.

API Reference

Constructs ​

App ​

Initializers ​

propsRequired ​

Methods ​

toString ​

synth ​

Static Functions ​

isConstruct ​

xRequired ​

Properties ​

nodeRequired ​

outdirRequired ​

rootRequired ​

stateFileOptional ​

App ​

Initializers ​

propsRequired ​

Methods ​

toString ​

synth ​

Static Functions ​

isConstruct ​

xRequired ​

Properties ​

nodeRequired ​

Bucket ​

Initializers ​

scopeRequired ​

idRequired ​

propsOptional ​

Methods ​

toString ​

capture ​

_consumerRequired ​

_captureRequired ​

Static Functions ​

isConstruct ​

xRequired ​

Properties ​

nodeRequired ​

statefulRequired ​

Bucket ​

Initializers ​

scopeRequired ​

idRequired ​

propsRequired ​

Methods ​

toString ​

capture ​

consumerRequired ​

_captureRequired ​

Static Functions ​

isConstruct ​

xRequired ​

Properties ​

nodeRequired ​

statefulRequired ​

Bucket ​

Initializers ​

scopeRequired ​

idRequired ​

propsRequired ​

Methods ​

toString ​

capture ​

consumerRequired ​

captureRequired ​

Static Functions ​

isConstruct ​

xRequired ​

Properties ​

nodeRequired ​

statefulRequired ​

BucketBase ​

Initializers ​

scopeRequired ​

idRequired ​

propsRequired ​

Constructs

App

Initializers

`props`^Required

Methods

`toString`

`synth`

Static Functions

`isConstruct`

`x`^Required

Properties

`node`^Required

`outdir`^Required

`root`^Required

`stateFile`^Optional

App

Initializers

`props`^Required

Methods

`toString`

`synth`

Static Functions

`isConstruct`

`x`^Required

Properties

`node`^Required

Bucket

Initializers

`scope`^Required

`id`^Required

`props`^Optional

Methods

`toString`

`capture`

`_consumer`^Required

`_capture`^Required

Static Functions

`isConstruct`

`x`^Required

Properties

`node`^Required

`stateful`^Required

Bucket

Initializers

`scope`^Required

`id`^Required

`props`^Required

Methods

`toString`

`capture`

`consumer`^Required

`_capture`^Required

Static Functions

`isConstruct`

`x`^Required

Properties

`node`^Required

`stateful`^Required

Bucket

Initializers

`scope`^Required

`id`^Required

`props`^Required

Methods

`toString`

`capture`

`consumer`^Required

`capture`^Required

Static Functions

`isConstruct`

`x`^Required

Properties

`node`^Required

`stateful`^Required

BucketBase

Initializers

`scope`^Required

`id`^Required

`props`^Required

Methods