Class AwsApiCall
(experimental) Construct that creates a custom resource that will perform a query using the AWS SDK.
Inherited Members
Namespace: Amazon.CDK.IntegTests
Assembly: Amazon.CDK.IntegTests.dll
Syntax (csharp)
public class AwsApiCall : Construct, IAwsApiCall, IConstruct, IDependable
Syntax (vb)
Public Class AwsApiCall
Inherits Construct
Implements IAwsApiCall, IConstruct, IDependable
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
Stack myAppStack;
new AwsApiCall(myAppStack, "GetObject", new AwsApiCallProps {
Service = "S3",
Api = "getObject"
});
Synopsis
Constructors
AwsApiCall(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
AwsApiCall(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
AwsApiCall(Construct, String, IAwsApiCallProps) |
Properties
Provider |
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. |
Constructors
AwsApiCall(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected AwsApiCall(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
AwsApiCall(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected AwsApiCall(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
AwsApiCall(Construct, String, IAwsApiCallProps)
public AwsApiCall(Construct scope, string id, IAwsApiCallProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IAwsApiCallProps
Remarks
Stability: Experimental
Properties
Provider
protected virtual AssertionsProvider Provider { get; set; }
Property Value
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 virtual void AssertAtPath(string path, ExpectedResult expected)
Parameters
- path System.String
- expected ExpectedResult
Remarks
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 void Expect(ExpectedResult expected)
Parameters
- expected ExpectedResult
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