software.amazon.awscdk.integtests

Class AwsApiCall

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.integtests.AwsApiCall

All Implemented Interfaces:

IConstruct, IDependable, IAwsApiCall

Direct Known Subclasses:

LambdaInvokeFunction

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.872Z")
public class AwsApiCall
extends Construct
implements IAwsApiCall

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

Example:

 Stack myAppStack;
 AwsApiCall.Builder.create(myAppStack, "GetObject")
         .service("S3")
         .api("getObject")
         .build();
 

Nested Class Summary

Nested Classes

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

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

IAwsApiCall.Jsii$Default, IAwsApiCall.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	assertAtPath(java.lang.String path, ExpectedResult expected) (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.
void	expect(ExpectedResult expected) (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall.
Reference	getAtt(java.lang.String attributeName) (experimental) Returns the value of an attribute of the custom resource of an arbitrary type.
java.lang.String	getAttString(java.lang.String attributeName) (experimental) Returns the value of an attribute of the custom resource of type string.
protected AssertionsProvider	getProvider()
protected void	setProvider(AssertionsProvider value)

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

AwsApiCall

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

AwsApiCall

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

AwsApiCall

public AwsApiCall(software.constructs.Construct scope,
                  java.lang.String id,
                  AwsApiCallProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

assertAtPath

public void assertAtPath(java.lang.String path,
                         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

Specified by:

assertAtPath in interface IAwsApiCall

Parameters:

path - This parameter is required.

expected - This parameter is required.

expect

public void expect(ExpectedResult expected)

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

Specified by:

expect in interface IAwsApiCall

Parameters:

expected - This parameter is required.

getAtt

public Reference getAtt(java.lang.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 - 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

public java.lang.String getAttString(java.lang.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 - This parameter is required.

Returns:

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

getProvider

protected AssertionsProvider getProvider()

setProvider

protected void setProvider(AssertionsProvider value)