Class IDeployAssert.Jsii$Proxy
- All Implemented Interfaces:
IDeployAssert,IDeployAssert.Jsii$Default,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
IDeployAssert
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.integtests.alpha.IDeployAssert
IDeployAssert.Jsii$Default, IDeployAssert.Jsii$Proxy -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal IApiCallawsApiCall(String service, String api) (experimental) Query AWS using JavaScript SDK API calls.final IApiCallawsApiCall(String service, String api, Object parameters) (experimental) Query AWS using JavaScript SDK API calls.final IApiCall(experimental) Query AWS using JavaScript SDK API calls.final voidexpect(String id, ExpectedResult expected, ActualResult actual) (experimental) Assert that the ExpectedResult is equal to the ActualResult.final IApiCallhttpApiCall(String url) (experimental) Make an HTTP call to the provided endpoint.final IApiCallhttpApiCall(String url, FetchOptions options) (experimental) Make an HTTP call to the provided endpoint.final IApiCall(experimental) Invoke a lambda function and return the response which can be asserted.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
awsApiCall
@Stability(Experimental) @NotNull public final 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
serviceis 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
apiis 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:
awsApiCallin interfaceIDeployAssert- Specified by:
awsApiCallin interfaceIDeployAssert.Jsii$Default- Parameters:
service- This parameter is required.api- This parameter is required.parameters-outputPaths-
- An AWS SDK for JavaScript v3 package name (
-
awsApiCall
@Stability(Experimental) @NotNull public final IApiCall awsApiCall(@NotNull String service, @NotNull String api, @Nullable Object parameters) (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
serviceis 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
apiis 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:
awsApiCallin interfaceIDeployAssert- Parameters:
service- This parameter is required.api- This parameter is required.parameters-
- An AWS SDK for JavaScript v3 package name (
-
awsApiCall
@Stability(Experimental) @NotNull public final IApiCall awsApiCall(@NotNull String service, @NotNull String api) (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
serviceis 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
apiis 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:
awsApiCallin interfaceIDeployAssert- Parameters:
service- This parameter is required.api- This parameter is required.
- An AWS SDK for JavaScript v3 package name (
-
expect
@Stability(Experimental) public final 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:
expectin interfaceIDeployAssert- Specified by:
expectin interfaceIDeployAssert.Jsii$Default- Parameters:
id- This parameter is required.expected- This parameter is required.actual- This parameter is required.
-
httpApiCall
@Stability(Experimental) @NotNull public final 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:
httpApiCallin interfaceIDeployAssert- Specified by:
httpApiCallin interfaceIDeployAssert.Jsii$Default- Parameters:
url- This parameter is required.options-
-
httpApiCall
(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:
httpApiCallin interfaceIDeployAssert- Parameters:
url- This parameter is required.
-
invokeFunction
@Stability(Experimental) @NotNull public final 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:
invokeFunctionin interfaceIDeployAssert- Specified by:
invokeFunctionin interfaceIDeployAssert.Jsii$Default- Parameters:
props- This parameter is required.
-