API Reference

Structs

LiftAnnotation

Annotations about preflight data and desired inflight operations.

Initializer

let LiftAnnotation = LiftAnnotation{ ... };

Properties

Name	Type	Description
obj	any	Preflight object to lift.
alias	str	Name of the object in the inflight context.
ops	MutArray<str>	Operations to lift on the object.

---

obj^Required

obj: any;

• Type: any

Preflight object to lift.

---

alias^Optional

alias: str;

• Type: str
• Default: "obj" If the object is a simple identifier, it will be used as the alias

Name of the object in the inflight context.

Required if the object provided is not an identifier.

---

ops^Optional

ops: MutArray<str>;

• Type: MutArray<str>
• Default: * All possible operations will be available

Operations to lift on the object.

---

Protocols

IHostedLiftable

• Extends: ILiftable

• Implemented By: BucketRef, Domain, FunctionRef, QueueRef, SecretRef, Api, Bucket, Counter, Domain, Endpoint, Function, OnDeploy, Queue, Schedule, Secret, Service, Topic, Website, Container, Policy, Resource, State, AutoIdResource, Resource, Test, TestRunner, Button, Field, FileBrowser, HttpClient, Section, Table, ValueField, VisualComponent, IAwsFunction, IAwsInflightHost, IApiEndpointHandler, IBucketEventHandler, IFunctionHandler, IOnDeployHandler, IQueueSetConsumerHandler, IScheduleOnTickHandler, IServiceHandler, IServiceStopHandler, ITopicOnMessageHandler, IResourceFactory, ISimulatorInflightHost, ISimulatorResource, IHostedLiftable, IInflight, IInflightHost, IResource, ITestHandler, IButtonHandler, IFieldHandler, IFileBrowserDeleteHandler, IFileBrowserGetHandler, IFileBrowserListHandler, IFileBrowserPutHandler, IHttpClientGetApiSpecHandler, IHttpClientGetUrlHandler, ITableScanHandler, IPredicateHandler

A liftable object that needs to be registered on the host as part of the lifting process.

This is generally used so the host can set up permissions to access the lifted object inflight.

Methods

Name	Description
onLift	A hook called by the Wing compiler once for each inflight host that needs to use this object inflight.

---

onLift

onLift(host: IInflightHost, ops: MutArray<str>): void

A hook called by the Wing compiler once for each inflight host that needs to use this object inflight.

The list of requested inflight methods needed by the inflight host are given by ops.

Any preflight class can implement this instance method to add permissions, environment variables, or other capabilities to the inflight host when one or more of its methods are called.

host^Required

• Type: IInflightHost

---

ops^Required

• Type: MutArray<str>

---