Skip to content

Latest commit

 

History

History
103 lines (50 loc) · 2.92 KB

API.md

File metadata and controls

103 lines (50 loc) · 2.92 KB

API Reference

Classes

Name Description
ConstructWithProperties A simple CDK construct illustrating the differences in declaring construct properties with interfaces.
LambdaConstruct A CDK construct to create Lambda functions.

Structs

Name Description
StructProperties This interface is translated into a struct containing data.

Interfaces

Name Description
IBehaviorProperties This is a behavioral interface identified by I in its name.

class ConstructWithProperties

A simple CDK construct illustrating the differences in declaring construct properties with interfaces.

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new ConstructWithProperties(parent: Construct, name: string, props: StructProperties, props2: IBehaviorProperties)

class LambdaConstruct

A CDK construct to create Lambda functions.

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new LambdaConstruct(parent: Construct, name: string)
  • parent (Construct) No description
  • name (string) No description

interface IBehaviorProperties

This is a behavioral interface identified by I in its name.

It will be translated to a "regular" interface which needs to be implemented. You can also use methods here, e.g. doSth(): void;.

Properties

Name Type Description
otherProp string

struct StructProperties

This interface is translated into a struct containing data.

E.g. if translated to Java, an interface StructProperties is created containing a builder subclass to create an instance of the interface.

Name Type Description
myProp string