com.hashicorp.cdktf

Class Annotations

java.lang.Object

software.amazon.jsii.JsiiObject

com.hashicorp.cdktf.Annotations

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-12-03T14:55:51.009Z")
 @Stability(value=Experimental)
public class Annotations
extends software.amazon.jsii.JsiiObject

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

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Annotations(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Annotations(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addError(String message) (experimental) Adds an { "error": } metadata entry to this construct.
void	addInfo(String message) (experimental) Adds an info metadata entry to this construct.
void	addWarning(String message) (experimental) Adds a warning metadata entry to this construct.
static Annotations	of(software.constructs.IConstruct scope) (experimental) Returns the annotations API for a construct scope.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Annotations

protected Annotations(software.amazon.jsii.JsiiObjectRef objRef)

Annotations

protected Annotations(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

of

@Stability(value=Experimental)
 @NotNull
public static Annotations of(@NotNull
                                                                      software.constructs.IConstruct scope)

(experimental) Returns the annotations API for a construct scope.

Parameters:

scope - The scope. This parameter is required.

addError

@Stability(value=Experimental)
public void addError(@NotNull
                                                    String message)

(experimental) Adds an { "error": } metadata entry to this construct.

The toolkit will fail synthesis when errors are reported.

Parameters:

message - The error message. This parameter is required.

addInfo

@Stability(value=Experimental)
public void addInfo(@NotNull
                                                   String message)

(experimental) Adds an info metadata entry to this construct.

The CLI will display the info message when apps are synthesized.

Parameters:

message - The info message. This parameter is required.

addWarning

@Stability(value=Experimental)
public void addWarning(@NotNull
                                                      String message)

(experimental) 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.

Parameters:

message - The warning message. This parameter is required.