Typescript: Annotations - CDK Terrain (CDKTN)

Includes API for attaching annotations such as warning messages to constructs.

Methods

Name	Description
`addError`	Adds an { “error”: < message > } metadata entry to this construct.
`addInfo`	Adds an info metadata entry to this construct.
`addWarning`	Adds a warning metadata entry to this construct.

`addError`

public addError(message: string): void

Adds an { “error”: < message > } metadata entry to this construct. The toolkit will fail synthesis when errors are reported.

`message`^Required

Type: string

The error message.

`addInfo`

public addInfo(message: string): void

Adds an info metadata entry to this construct. The CLI will display the info message when apps are synthesized.

`message`^Required

Type: string

The info message.

`addWarning`

public addWarning(message: string): void

Adds a warning metadata entry to this construct. The CLI will display the warning when an app is synthesized. In a future release the CLI might introduce a —strict flag which will then fail the synthesis if it encounters a warning.

`message`^Required

Type: string

The warning message.

Static Functions

Name	Description
`of`	Returns the annotations API for a construct scope.

`of`

import { Annotations } from 'cdktn'

Annotations.of(scope: IConstruct)

Returns the annotations API for a construct scope.

`scope`^Required

Type: constructs.IConstruct

The scope.

Typescript: WinrmProvisionerConnection

Typescript: AnyListList

⌘I

​Methods

​addError

​messageRequired

​addInfo

​messageRequired

​addWarning

​messageRequired

​Static Functions

​of

​scopeRequired

Methods

`addError`

`message`^Required

`addInfo`

`message`^Required

`addWarning`

`message`^Required

Static Functions

`of`

`scope`^Required