@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:40.872Z") public class AwsApiCall extends Construct implements IAwsApiCall
Example:
Stack myAppStack; AwsApiCall.Builder.create(myAppStack, "GetObject") .service("S3") .api("getObject") .build();
Modifier and Type | Class and Description |
---|---|
static class |
AwsApiCall.Builder
(experimental) A fluent builder for
AwsApiCall . |
IAwsApiCall.Jsii$Default, IAwsApiCall.Jsii$Proxy
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) |
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) |
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getNode
protected AwsApiCall(software.amazon.jsii.JsiiObjectRef objRef)
protected AwsApiCall(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public AwsApiCall(software.constructs.Construct scope, java.lang.String id, AwsApiCallProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public void assertAtPath(java.lang.String path, ExpectedResult expected)
For example the SQS.receiveMessage api response would look like:
If you wanted to assert the value of Body
you could do
assertAtPath
in interface IAwsApiCall
path
- This parameter is required.expected
- This parameter is required.public void expect(ExpectedResult expected)
expect
in interface IAwsApiCall
expected
- This parameter is required.public Reference getAtt(java.lang.String attributeName)
Attributes are returned from the custom resource provider through the
Data
map where the key is the attribute name.
getAtt
in interface IAwsApiCall
attributeName
- This parameter is required.public java.lang.String getAttString(java.lang.String attributeName)
Attributes are returned from the custom resource provider through the
Data
map where the key is the attribute name.
getAttString
in interface IAwsApiCall
attributeName
- This parameter is required.protected AssertionsProvider getProvider()
protected void setProvider(AssertionsProvider value)