CSharp: 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`

private void AddError(string Message)

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`

private void AddInfo(string Message)

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`

private void AddWarning(string Message)

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`

using Io.Cdktn;

Annotations.Of(IConstruct Scope);

Returns the annotations API for a construct scope.

`Scope`^Required

Type: Constructs.IConstruct

The scope.

CSharp: WinrmProvisionerConnection

CSharp: 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