Class IApiCall.Jsii$Proxy
- All Implemented Interfaces:
IApiCall
,IApiCall.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
IApiCall
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal IApiCall
assertAtPath
(String path, ExpectedResult expected) (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.final IApiCall
expect
(ExpectedResult expected) (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall.final Reference
(experimental) Returns the value of an attribute of the custom resource of an arbitrary type.final String
getAttString
(String attributeName) (experimental) Returns the value of an attribute of the custom resource of type string.final software.constructs.Node
getNode()
The tree node.final AssertionsProvider
(experimental) access the AssertionsProvider.final IApiCall
(experimental) Allows you to chain IApiCalls.final IApiCall
(experimental) Wait for the IApiCall to return the expected response.final IApiCall
(experimental) Wait for the IApiCall to return the expected response.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
@Stability(Stable) @NotNull public final software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfaceIApiCall.Jsii$Default
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
-
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 interfaceIApiCall
- Specified by:
getProvider
in interfaceIApiCall.Jsii$Default
-
assertAtPath
@Stability(Experimental) @NotNull public final 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 doExample:
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 interfaceIApiCall
- Specified by:
assertAtPath
in interfaceIApiCall.Jsii$Default
- Parameters:
path
- This parameter is required.expected
- This parameter is required.
-
expect
(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 interfaceIApiCall
- Specified by:
expect
in interfaceIApiCall.Jsii$Default
- Parameters:
expected
- This parameter is required.
-
getAtt
(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 interfaceIApiCall
- Specified by:
getAtt
in interfaceIApiCall.Jsii$Default
- Parameters:
attributeName
- the name of the attribute. This parameter is required.- Returns:
- a token for
Fn::GetAtt
. UseToken.asXxx
to encode the returnedReference
as a specific type or use the conveniencegetAttString
for string attributes.
-
getAttString
(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 interfaceIApiCall
- Specified by:
getAttString
in interfaceIApiCall.Jsii$Default
- Parameters:
attributeName
- the name of the attribute. This parameter is required.- Returns:
- a token for
Fn::GetAtt
encoded as a string.
-
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 interfaceIApiCall
- Specified by:
next
in interfaceIApiCall.Jsii$Default
- Parameters:
next
- This parameter is required.
-
waitForAssertions
@Stability(Experimental) @NotNull public final 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 interfaceIApiCall
- Specified by:
waitForAssertions
in interfaceIApiCall.Jsii$Default
- Parameters:
options
-
-
waitForAssertions
(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 interfaceIApiCall
-