Class ApiCallBase
(experimental) Base class for an ApiCall.
Namespace: Amazon.CDK.IntegTests.Alpha
Assembly: Amazon.CDK.IntegTests.Alpha.dll
Syntax (csharp)
public abstract class ApiCallBase : Construct, IApiCall
Syntax (vb)
Public MustInherit Class ApiCallBase
Inherits Construct
Implements IApiCall
Remarks
Stability: Experimental
Synopsis
Constructors
ApiCallBase(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
ApiCallBase(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
ApiCallBase(Construct, String) |
Properties
ApiCallResource | |
ExpectedResult | |
FlattenResponse | |
OutputPaths | |
Provider | (experimental) access the AssertionsProvider. |
StateMachineArn |
Methods
AssertAtPath(String, ExpectedResult) | (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path. |
Expect(ExpectedResult) | (experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall. |
GetAtt(String) | (experimental) Returns the value of an attribute of the custom resource of an arbitrary type. |
GetAttString(String) | (experimental) Returns the value of an attribute of the custom resource of type string. |
Next(IApiCall) | (experimental) Allows you to chain IApiCalls. This adds an explicit dependency betweent the two resources. |
WaitForAssertions(IWaiterStateMachineOptions) | (experimental) Wait for the IApiCall to return the expected response. |
Constructors
ApiCallBase(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected ApiCallBase(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
ApiCallBase(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected ApiCallBase(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
ApiCallBase(Construct, String)
protected ApiCallBase(Construct scope, string id)
Parameters
- scope Constructs.Construct
- id System.String
Remarks
Stability: Experimental
Properties
ApiCallResource
protected abstract CustomResource ApiCallResource { get; }
Property Value
Remarks
Stability: Experimental
ExpectedResult
protected virtual string ExpectedResult { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
FlattenResponse
protected virtual string FlattenResponse { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
OutputPaths
protected virtual string[] OutputPaths { get; set; }
Property Value
System.String[]
Remarks
Stability: Experimental
Provider
(experimental) access the AssertionsProvider.
public abstract AssertionsProvider Provider { get; }
Property Value
Remarks
This can be used to add additional IAM policies the the provider role policy
Stability: Experimental
StateMachineArn
protected virtual string StateMachineArn { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
Methods
AssertAtPath(String, ExpectedResult)
(experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.
public abstract IApiCall AssertAtPath(string path, ExpectedResult expected)
Parameters
- path System.String
- expected ExpectedResult
Returns
Remarks
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
Stability: Experimental
Expect(ExpectedResult)
(experimental) Assert that the ExpectedResult is equal to the result of the AwsApiCall.
public virtual IApiCall Expect(ExpectedResult expected)
Parameters
- expected ExpectedResult
Returns
Remarks
Stability: Experimental
GetAtt(String)
(experimental) Returns the value of an attribute of the custom resource of an arbitrary type.
public virtual Reference GetAtt(string attributeName)
Parameters
- attributeName System.String
Returns
Remarks
Attributes are returned from the custom resource provider through the
Data
map where the key is the attribute name.
Stability: Experimental
GetAttString(String)
(experimental) Returns the value of an attribute of the custom resource of type string.
public virtual string GetAttString(string attributeName)
Parameters
- attributeName System.String
Returns
System.String
Remarks
Attributes are returned from the custom resource provider through the
Data
map where the key is the attribute name.
Stability: Experimental
Next(IApiCall)
(experimental) Allows you to chain IApiCalls. This adds an explicit dependency betweent the two resources.
public virtual IApiCall Next(IApiCall next)
Parameters
- next IApiCall
Returns
Remarks
Returns the IApiCall provided as next
Stability: Experimental
WaitForAssertions(IWaiterStateMachineOptions)
(experimental) Wait for the IApiCall to return the expected response.
public abstract IApiCall WaitForAssertions(IWaiterStateMachineOptions options = null)
Parameters
- options IWaiterStateMachineOptions
Returns
Remarks
If no expected response is specified then it will wait for the IApiCall to return a success
Stability: Experimental