software.amazon.awscdk.assertions

Class Annotations

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.assertions.Annotations

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:49.465Z")
public class Annotations
extends software.amazon.jsii.JsiiObject

Suite of assertions that can be run on a CDK Stack.

Focused on asserting annotations.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.assertions.*;
 import software.amazon.awscdk.core.*;
 Stack stack;
 Annotations annotations = Annotations.fromStack(stack);
 

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
java.util.List<SynthesisMessage>	findError(java.lang.String constructPath, java.lang.Object message) Get the set of matching errors of a given construct path and message.
java.util.List<SynthesisMessage>	findInfo(java.lang.String constructPath, java.lang.Object message) Get the set of matching infos of a given construct path and message.
java.util.List<SynthesisMessage>	findWarning(java.lang.String constructPath, java.lang.Object message) Get the set of matching warning of a given construct path and message.
static Annotations	fromStack(Stack stack) Base your assertions on the messages returned by a synthesized CDK `Stack`.
void	hasError(java.lang.String constructPath, java.lang.Object message) Assert that an error with the given message exists in the synthesized CDK `Stack`.
void	hasInfo(java.lang.String constructPath, java.lang.Object message) Assert that an info with the given message exists in the synthesized CDK `Stack`.
void	hasNoError(java.lang.String constructPath, java.lang.Object message) Assert that an error with the given message does not exist in the synthesized CDK `Stack`.
void	hasNoInfo(java.lang.String constructPath, java.lang.Object message) Assert that an info with the given message does not exist in the synthesized CDK `Stack`.
void	hasNoWarning(java.lang.String constructPath, java.lang.Object message) Assert that an warning with the given message does not exist in the synthesized CDK `Stack`.
void	hasWarning(java.lang.String constructPath, java.lang.Object message) Assert that an warning with the given message exists in the synthesized CDK `Stack`.

Methods inherited from class java.lang.Object

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

Constructor Detail

Annotations

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

Annotations

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

Method Detail

fromStack

public static Annotations fromStack(Stack stack)

Base your assertions on the messages returned by a synthesized CDK `Stack`.

Parameters:

stack - the CDK Stack to run assertions on. This parameter is required.

findError

public java.util.List<SynthesisMessage> findError(java.lang.String constructPath,
                                                  java.lang.Object message)

Get the set of matching errors of a given construct path and message.

Parameters:

constructPath - the construct path to the error. This parameter is required.

message - the error message as should be expected. This parameter is required.

findInfo

public java.util.List<SynthesisMessage> findInfo(java.lang.String constructPath,
                                                 java.lang.Object message)

Get the set of matching infos of a given construct path and message.

Parameters:

constructPath - the construct path to the info. This parameter is required.

message - the info message as should be expected. This parameter is required.

findWarning

public java.util.List<SynthesisMessage> findWarning(java.lang.String constructPath,
                                                    java.lang.Object message)

Get the set of matching warning of a given construct path and message.

Parameters:

constructPath - the construct path to the warning. This parameter is required.

message - the warning message as should be expected. This parameter is required.

hasError

public void hasError(java.lang.String constructPath,
                     java.lang.Object message)

Assert that an error with the given message exists in the synthesized CDK `Stack`.

Parameters:

constructPath - the construct path to the error. This parameter is required.

message - the error message as should be expected. This parameter is required.

hasInfo

public void hasInfo(java.lang.String constructPath,
                    java.lang.Object message)

Assert that an info with the given message exists in the synthesized CDK `Stack`.

Parameters:

constructPath - the construct path to the info. This parameter is required.

message - the info message as should be expected. This parameter is required.

hasNoError

public void hasNoError(java.lang.String constructPath,
                       java.lang.Object message)

Assert that an error with the given message does not exist in the synthesized CDK `Stack`.

Parameters:

constructPath - the construct path to the error. This parameter is required.

message - the error message as should be expected. This parameter is required.

hasNoInfo

public void hasNoInfo(java.lang.String constructPath,
                      java.lang.Object message)

Assert that an info with the given message does not exist in the synthesized CDK `Stack`.

Parameters:

constructPath - the construct path to the info. This parameter is required.

message - the info message as should be expected. This parameter is required.

hasNoWarning

public void hasNoWarning(java.lang.String constructPath,
                         java.lang.Object message)

Assert that an warning with the given message does not exist in the synthesized CDK `Stack`.

Parameters:

constructPath - the construct path to the warning. This parameter is required.

message - the warning message as should be expected. This parameter is required.

hasWarning

public void hasWarning(java.lang.String constructPath,
                       java.lang.Object message)

Assert that an warning with the given message exists in the synthesized CDK `Stack`.

Parameters:

constructPath - the construct path to the warning. This parameter is required.

message - the warning message as should be expected. This parameter is required.