Package software.amazon.awscdk.integtests.alpha

Interface IApiCall.Jsii$Default

All Superinterfaces:
IApiCall, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IApiCall.Jsii$Proxy
Enclosing interface:
IApiCall
@Internal public static interface IApiCall.Jsii$Default extends IApiCall, software.constructs.IConstruct.Jsii$Default
Internal default implementation for IApiCall.

  • Nested Class Summary

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

    IApiCall.Jsii$Default, IApiCall.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IDependable

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

  • Method Summary

    Modifier and Type
    Method
    Description
    default IApiCall
    assertAtPath(String path, ExpectedResult expected)
    (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.
    default IApiCall
    expect(ExpectedResult expected)
    (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall.
    default Reference
    getAtt(String attributeName)
    (experimental) Returns the value of an attribute of the custom resource of an arbitrary type.
    default String
    getAttString(String attributeName)
    (experimental) Returns the value of an attribute of the custom resource of type string.
    default software.constructs.Node
    getNode()
    The tree node.
    default AssertionsProvider
    getProvider()
    (experimental) access the AssertionsProvider.
    default IApiCall
    next(IApiCall next)
    (experimental) Allows you to chain IApiCalls.
    default IApiCall
    waitForAssertions(WaiterStateMachineOptions options)
    (experimental) Wait for the IApiCall to return the expected response.

    Methods inherited from interface software.amazon.awscdk.integtests.alpha.IApiCall

    waitForAssertions

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default

    • getProvider

      @Stability(Experimental) @NotNull default AssertionsProvider getProvider()
      (experimental) access the AssertionsProvider.

      This can be used to add additional IAM policies the the provider role policy

      Example: 

       AwsApiCall apiCall;
 apiCall.provider.addToRolePolicy(Map.of(
         "Effect", "Allow",
         "Action", List.of("s3:GetObject"),
         "Resource", List.of("*")));
      Specified by:
      getProvider in interface IApiCall

    • assertAtPath

      @Stability(Experimental) @NotNull default IApiCall assertAtPath(@NotNull String path, @NotNull ExpectedResult expected)
      (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.

      Providing a path will filter the output of the initial API call.

      For example the SQS.receiveMessage api response would look like:

      If you wanted to assert the value of Body you could do

      Example: 

       IntegTest integ;
 Map<String, Map<String, Object>[]> actual = Map.of(
         "Messages", List.of(Map.of(
                 "MessageId", "",
                 "ReceiptHandle", "",
                 "MD5OfBody", "",
                 "Body", "hello",
                 "Attributes", Map.of(),
                 "MD5OfMessageAttributes", Map.of(),
                 "MessageAttributes", Map.of())));
 IApiCall message = integ.assertions.awsApiCall("SQS", "receiveMessage");
 message.assertAtPath("Messages.0.Body", ExpectedResult.stringLikeRegexp("hello"));

      Specified by:
      assertAtPath in interface IApiCall
      Parameters:
      path - This parameter is required.
      expected - This parameter is required.

    • expect

      @Stability(Experimental) @NotNull default IApiCall expect(@NotNull ExpectedResult expected)
      (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall.

      Example: 

       IntegTest integ;
 IApiCall invoke = integ.assertions.invokeFunction(LambdaInvokeFunctionProps.builder()
         .functionName("my-func")
         .build());
 invoke.expect(ExpectedResult.objectLike(Map.of("Payload", "OK")));

      Specified by:
      expect in interface IApiCall
      Parameters:
      expected - This parameter is required.

    • getAtt

      @Stability(Experimental) @NotNull default Reference getAtt(@NotNull String attributeName)
      (experimental) Returns the value of an attribute of the custom resource of an arbitrary type.

      Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

      Specified by:
      getAtt in interface IApiCall
      Parameters:
      attributeName - the name of the attribute. This parameter is required.
      Returns:
      a token for Fn::GetAtt. Use Token.asXxx to encode the returned Reference as a specific type or use the convenience getAttString for string attributes.

    • getAttString

      @Stability(Experimental) @NotNull default String getAttString(@NotNull String attributeName)
      (experimental) Returns the value of an attribute of the custom resource of type string.

      Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

      Specified by:
      getAttString in interface IApiCall
      Parameters:
      attributeName - the name of the attribute. This parameter is required.
      Returns:
      a token for Fn::GetAtt encoded as a string.

    • next

      @Stability(Experimental) @NotNull default IApiCall next(@NotNull IApiCall next)
      (experimental) Allows you to chain IApiCalls. This adds an explicit dependency betweent the two resources.

      Returns the IApiCall provided as next

      Example: 

       IApiCall first;
 IApiCall second;
 first.next(second);

      Specified by:
      next in interface IApiCall
      Parameters:
      next - This parameter is required.

    • waitForAssertions

      @Stability(Experimental) @NotNull default IApiCall waitForAssertions(@Nullable WaiterStateMachineOptions options)
      (experimental) Wait for the IApiCall to return the expected response.

      If no expected response is specified then it will wait for the IApiCall to return a success

      Example: 

       IntegTest integ;
 String executionArn;
 integ.assertions.awsApiCall("StepFunctions", "describeExecution", Map.of(
         "executionArn", executionArn)).waitForAssertions();

      Specified by:
      waitForAssertions in interface IApiCall
      Parameters:
      options -