software.amazon.awscdk.integtests

Interface IAwsApiCall.Jsii$Default

All Superinterfaces:

IAwsApiCall, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IAwsApiCall.Jsii$Proxy

Enclosing interface:

IAwsApiCall

@Internal
public static interface IAwsApiCall.Jsii$Default
extends IAwsApiCall, IConstruct.Jsii$Default

Internal default implementation for IAwsApiCall.

Nested Class Summary

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

IAwsApiCall.Jsii$Default, IAwsApiCall.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	assertAtPath(String path, ExpectedResult expected) (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.
default void	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 ConstructNode	getNode() (experimental) The construct tree node for this construct.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Experimental)
 @NotNull
default ConstructNode getNode()

(experimental) The construct tree node for this construct.

assertAtPath

@Stability(value=Experimental)
default void assertAtPath(@NotNull
                                                         String path,
                                                         @NotNull
                                                         ExpectedResult expected)

(experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.

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())));
 IAwsApiCall message = integ.assertions.awsApiCall("SQS", "receiveMessage");
 message.assertAtPath("Messages.0.Body", ExpectedResult.stringLikeRegexp("hello"));
 

Specified by:

assertAtPath in interface IAwsApiCall

Parameters:

path - This parameter is required.

expected - This parameter is required.

expect

@Stability(value=Experimental)
default void expect(@NotNull
                                                   ExpectedResult expected)

(experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall.

Example:

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

Specified by:

expect in interface IAwsApiCall

Parameters:

expected - This parameter is required.

getAtt

@Stability(value=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 IAwsApiCall

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(value=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 IAwsApiCall

Parameters:

attributeName - the name of the attribute. This parameter is required.

Returns:

a token for `Fn::GetAtt` encoded as a string.