software.amazon.awscdk.integtests

Interface IDeployAssert.Jsii$Default

All Superinterfaces:

IDeployAssert, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IDeployAssert.Jsii$Proxy

Enclosing interface:

IDeployAssert

@Internal
public static interface IDeployAssert.Jsii$Default
extends IDeployAssert

Internal default implementation for IDeployAssert.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.integtests.IDeployAssert

IDeployAssert.Jsii$Default, IDeployAssert.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default IAwsApiCall	awsApiCall(String service, String api, Object parameters) (experimental) Query AWS using JavaScript SDK V2 API calls.
default void	expect(String id, ExpectedResult expected, ActualResult actual) (experimental) Assert that the ExpectedResult is equal to the ActualResult.
default IAwsApiCall	invokeFunction(LambdaInvokeFunctionProps props) (experimental) Invoke a lambda function and return the response which can be asserted.

Methods inherited from interface software.amazon.awscdk.integtests.IDeployAssert

awsApiCall

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

awsApiCall

@Stability(value=Experimental)
 @NotNull
default IAwsApiCall awsApiCall(@NotNull
                                                                        String service,
                                                                        @NotNull
                                                                        String api,
                                                                        @Nullable
                                                                        Object parameters)

(experimental) Query AWS using JavaScript SDK V2 API calls.

This can be used to either trigger an action or to return a result that can then be asserted against an expected value

Example:

 App app;
 IntegTest integ;
 integ.assertions.awsApiCall("SQS", "sendMessage", Map.of(
         "QueueUrl", "url",
         "MessageBody", "hello"));
 IAwsApiCall message = integ.assertions.awsApiCall("SQS", "receiveMessage", Map.of(
         "QueueUrl", "url"));
 message.expect(ExpectedResult.objectLike(Map.of(
         "Messages", List.of(Map.of("Body", "hello")))));
 

Specified by:

awsApiCall in interface IDeployAssert

Parameters:

service - This parameter is required.

api - This parameter is required.

parameters -

expect

@Stability(value=Experimental)
default void expect(@NotNull
                                                   String id,
                                                   @NotNull
                                                   ExpectedResult expected,
                                                   @NotNull
                                                   ActualResult actual)

(experimental) Assert that the ExpectedResult is equal to the ActualResult.

Example:

 IntegTest integ;
 AwsApiCall apiCall;
 integ.assertions.expect("invoke", ExpectedResult.objectLike(Map.of("Payload", "OK")), ActualResult.fromAwsApiCall(apiCall, "Body"));
 

Specified by:

expect in interface IDeployAssert

Parameters:

id - This parameter is required.

expected - This parameter is required.

actual - This parameter is required.

invokeFunction

@Stability(value=Experimental)
 @NotNull
default IAwsApiCall invokeFunction(@NotNull
                                                                            LambdaInvokeFunctionProps props)

(experimental) Invoke a lambda function and return the response which can be asserted.

Example:

 App app;
 IntegTest integ;
 IAwsApiCall invoke = integ.assertions.invokeFunction(LambdaInvokeFunctionProps.builder()
         .functionName("my-function")
         .build());
 invoke.expect(ExpectedResult.objectLike(Map.of(
         "Payload", "200")));
 

Specified by:

invokeFunction in interface IDeployAssert

Parameters:

props - This parameter is required.