Skip to main content

Resources

Resources are created similar to other CDKs (awscdk, cdktf, cdk8s, etc.). They make up the tree that represents your infrastructure. Resources are classes typically constructed with at least two arguments: The scope (parent) resource and an id.

Creating these resources starts with main() from @wingcloud/framework:

import { main } from "@wingcloud/framework";

main(() => {
// your app goes here
});

The callback passed to main() is the entry point for your application. The first argument provided is the root of this tree of resources and can be used to construct your first resource:

import { main, cloud } from "@wingcloud/framework";

main((root) => {
new cloud.Bucket(root, "Bucket");
});

API documentation for the cloud namespace is available here. Note that those docs are meant for The TypeScript API is similar, with two primary differences:

  • Resources always have 2 arguments first: the scope resource to contain the new one and an id for it
  • Some types are different, a table can be found in the winglang reference

Creating new resources

Resources can be grouped together by using constructs.

// my-construct.ts
import { cloud, Construct } from "@wingcloud/framework";

export class MyConstruct extends Construct {
public bucket: cloud.Bucket;
constructor(scope: Construct, id: string) {
super(scope, id);

this.bucket = new cloud.Bucket(this, "MyBucket");
}
}
// main.ts
import { main } from "@wingcloud/framework";
import { MyConstruct } from "./my-construct";

main((root) => {
new MyConstruct(root, "MyConstruct");
});

The creation of liftable classes like winglang is not currently supported in TypeScript.