Class Zap

Class representing the Zap configuration.

ZapConfig

Hierarchy

Construct
- Zap

Index

Constructors

Properties

Methods

synth toString toYaml isConstruct

Constructors

constructor

new Zap(scope: Construct, id: string, props: IZap): Zap
Creates an instance of Zap.
Parameters
- scope: Construct
  The scope in which this construct is defined.
- id: string
  The ID of the construct.
- props: IZap
  The properties of the Zap configuration.
Returns Zap
Overrides Construct.constructor
- Defined in src/constructs/zap/index.ts:19

Properties

config

config: IZap

`Readonly`node

node: Node

The tree node.

Stability

stable

Methods

synth

synth(): string
Synthesizes the Zap configuration to a YAML string.

Returns string
The Zap configuration as a YAML string.
- Defined in src/constructs/zap/index.ts:36

toString

toString(): string
Returns a string representation of this construct.

Returns string
Stability
stable
Inherited from Construct.toString
- Defined in node_modules/constructs/lib/construct.d.ts:319

toYaml

toYaml(): IZap
Converts the Zap configuration to YAML format.

Returns IZap
The Zap configuration in YAML format.
- Defined in src/constructs/zap/index.ts:28

`Static`isConstruct

isConstruct(x: any): x is Construct
(deprecated) Checks if x is a construct.
Parameters
- x: any
  Any object.
Returns x is Construct
true if x is an object created from a class which extends Construct.

Deprecated
use x instanceof Construct instead
Inherited from Construct.isConstruct
- Defined in node_modules/constructs/lib/construct.d.ts:299