Package software.amazon.awscdk.integtests.alpha

Class AwsApiCall

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.integtests.alpha.ApiCallBase

software.amazon.awscdk.integtests.alpha.AwsApiCall

All Implemented Interfaces:

IApiCall, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

LambdaInvokeFunction

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:26.403Z")
@Stability(Experimental)
public class AwsApiCall
extends ApiCallBase

(experimental) Construct that creates a custom resource that will perform a query using the AWS SDK.

Example:

 Stack stack;
 AwsApiCall.Builder.create(stack, "MyAssertion")
         .service("SQS")
         .api("receiveMessage")
         .parameters(Map.of(
                 "QueueUrl", "url"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AwsApiCall.Builder	(experimental) A fluent builder for AwsApiCall.

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

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

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AwsApiCall(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AwsApiCall(software.amazon.jsii.JsiiObjectRef objRef)
	AwsApiCall(software.constructs.Construct scope, String id, AwsApiCallProps props)

Method Summary

Modifier and Type	Method	Description
IApiCall	assertAtPath(String path, ExpectedResult expected)	(experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.
protected CustomResource	getApiCallResource()
AssertionsProvider	getProvider()	(experimental) access the AssertionsProvider.
AssertionsProvider	getWaiterProvider()	(experimental) access the AssertionsProvider for the waiter state machine.
void	setWaiterProvider(AssertionsProvider value)	(experimental) access the AssertionsProvider for the waiter state machine.
IApiCall	waitForAssertions()	(experimental) Wait for the IApiCall to return the expected response.
IApiCall	waitForAssertions(WaiterStateMachineOptions options)	(experimental) Wait for the IApiCall to return the expected response.

Methods inherited from class software.amazon.awscdk.integtests.alpha.ApiCallBase

expect, getAtt, getAttString, getExpectedResult, getFlattenResponse, getOutputPaths, getStateMachineArn, next, setExpectedResult, setFlattenResponse, setOutputPaths, setStateMachineArn

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

AwsApiCall

protected AwsApiCall(software.amazon.jsii.JsiiObjectRef objRef)

AwsApiCall

protected AwsApiCall(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AwsApiCall

@Stability(Experimental)
public AwsApiCall(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 AwsApiCallProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

assertAtPath

@Stability(Experimental)
@NotNull
public 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

Specified by:

assertAtPath in interface IApiCall

Specified by:

assertAtPath in class ApiCallBase

Parameters:

path - This parameter is required.

expected - This parameter is required.

waitForAssertions

@Stability(Experimental)
@NotNull
public 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

Specified by:

waitForAssertions in interface IApiCall

Specified by:

waitForAssertions in class ApiCallBase

Parameters:

options -

waitForAssertions

@Stability(Experimental)
@NotNull
public IApiCall 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

Specified by:

waitForAssertions in interface IApiCall

Specified by:

waitForAssertions in class ApiCallBase

getApiCallResource

@Stability(Experimental)
@NotNull
protected CustomResource getApiCallResource()

Specified by:

getApiCallResource in class ApiCallBase

getProvider

@Stability(Experimental)
@NotNull
public AssertionsProvider getProvider()

(experimental) access the AssertionsProvider.

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

Specified by:

getProvider in interface IApiCall

Specified by:

getProvider in class ApiCallBase

getWaiterProvider

@Stability(Experimental)
@Nullable
public AssertionsProvider getWaiterProvider()

(experimental) access the AssertionsProvider for the waiter state machine.

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

Example:

 AwsApiCall apiCall;
 apiCall.waiterProvider.addToRolePolicy(Map.of(
         "Effect", "Allow",
         "Action", List.of("s3:GetObject"),
         "Resource", List.of("*")));
 

setWaiterProvider

@Stability(Experimental)
public void setWaiterProvider(@Nullable
 AssertionsProvider value)

(experimental) access the AssertionsProvider for the waiter state machine.

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

Example:

 AwsApiCall apiCall;
 apiCall.waiterProvider.addToRolePolicy(Map.of(
         "Effect", "Allow",
         "Action", List.of("s3:GetObject"),
         "Resource", List.of("*")));