class AwsApiCall (construct) 🔹

Language	Type name
.NET	Amazon.CDK.IntegTests.AwsApiCall
Java	software.amazon.awscdk.integtests.AwsApiCall
Python	aws_cdk.integ_tests.AwsApiCall
TypeScript (source)	@aws-cdk/integ-tests » AwsApiCall

Implements IConstruct, IConstruct, IDependable, IAwsApiCall

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

Example

declare const myAppStack: Stack;

new AwsApiCall(myAppStack, 'GetObject', {
  service: 'S3',
  api: 'getObject',
});

Initializer

new AwsApiCall(scope: Construct, id: string, props: AwsApiCallProps)

Parameters

• scope Construct
• id string
• props AwsApiCallProps

Construct Props

Name	Type	Description
api🔹	string	The api call to make, i.e. getBucketLifecycle.
service🔹	string	The AWS service, i.e. S3.
parameters?🔹	any	Any parameters to pass to the api call.

---

api🔹

Type: string

The api call to make, i.e. getBucketLifecycle.

---

service🔹

Type: string

The AWS service, i.e. S3.

---

parameters?🔹

Type: any (optional, default: no parameters)

Any parameters to pass to the api call.

Properties

Name	Type	Description
node🔹	ConstructNode	The construct tree node associated with this construct.
provider🔹	AssertionsProvider

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

---

provider🔹

Type: AssertionsProvider

Methods

Name	Description
assertAtPath(path, expected)🔹	Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.
expect(expected)🔹	Assert that the ExpectedResult is equal to the result of the AwsApiCall.
getAtt(attributeName)🔹	Returns the value of an attribute of the custom resource of an arbitrary type.
getAttString(attributeName)🔹	Returns the value of an attribute of the custom resource of type string.
toString()🔹	Returns a string representation of this construct.

---

assertAtPath(path, expected)🔹

public assertAtPath(path: string, expected: ExpectedResult): void

Parameters

• path string
• expected ExpectedResult

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

---

expect(expected)🔹

public expect(expected: ExpectedResult): void

Parameters

• expected ExpectedResult

Assert that the ExpectedResult is equal to the result of the AwsApiCall.

---

getAtt(attributeName)🔹

public getAtt(attributeName: string): Reference

Parameters

• attributeName string

Returns

• Reference

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.

---

getAttString(attributeName)🔹

public getAttString(attributeName: string): string

Parameters

• attributeName string

Returns

• string

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.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.