Package software.amazon.awscdk.integtests.alpha

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.

  • Method Details

    • awsApiCall

      @Stability(Experimental) @NotNull default IApiCall awsApiCall(@NotNull String service, @NotNull String api, @Nullable Object parameters, @Nullable List<String> outputPaths)
      (experimental) Query AWS using JavaScript SDK 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

      The service is the name of an AWS service, in one of the following forms:

      • An AWS SDK for JavaScript v3 package name (@aws-sdk/client-api-gateway)
      • An AWS SDK for JavaScript v3 client name (api-gateway)
      • An AWS SDK for JavaScript v2 constructor name (APIGateway)
      • A lowercase AWS SDK for JavaScript v2 constructor name (apigateway)

      The api is the name of an AWS API call, in one of the following forms:

      • An API call name as found in the API Reference documentation (GetObject)
      • The API call name starting with a lowercase letter (getObject)
      • The AWS SDK for JavaScript v3 command class name (GetObjectCommand)

      Example: 

       App app;
 IntegTest integ;
 integ.assertions.awsApiCall("SQS", "sendMessage", Map.of(
         "QueueUrl", "url",
         "MessageBody", "hello"));
 IApiCall 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 -
      outputPaths -

    • expect

      @Stability(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.

    • httpApiCall

      @Stability(Experimental) @NotNull default IApiCall httpApiCall(@NotNull String url, @Nullable FetchOptions options)
      (experimental) Make an HTTP call to the provided endpoint.

      Example: 

       App app;
 IntegTest integ;
 IApiCall call = integ.assertions.httpApiCall("https://example.com/test");
 call.expect(ExpectedResult.objectLike(Map.of(
         "Message", "Hello World!")));

      Specified by:
      httpApiCall in interface IDeployAssert
      Parameters:
      url - This parameter is required.
      options -

    • invokeFunction

      @Stability(Experimental) @NotNull default IApiCall invokeFunction(@NotNull LambdaInvokeFunctionProps props)
      (experimental) Invoke a lambda function and return the response which can be asserted.

      Example: 

       App app;
 IntegTest integ;
 IApiCall 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.