class AwsApiCall (construct) 🔹

Language	Type name
.NET	Amazon.CDK.IntegTests.Alpha.AwsApiCall
Go	github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#AwsApiCall
Java	software.amazon.awscdk.integtests.alpha.AwsApiCall
Python	aws_cdk.integ_tests_alpha.AwsApiCall
TypeScript (source)	@aws-cdk/integ-tests-alpha » AwsApiCall

Implements IConstruct, IDependable, IApiCall

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

Example

declare const stack: Stack;

new AwsApiCall(stack, 'MyAssertion', {
  service: 'SQS',
  api: 'receiveMessage',
  parameters: {
    QueueUrl: 'url',
  },
});

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.
outputPaths?🔹	string[]	Restrict the data returned by the API call to specific paths in the API response.
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.

---

outputPaths?🔹

Type: string[] (optional, default: return all data)

Restrict the data returned by the API call to specific paths in the API response.

Use this to limit the data returned by the custom resource if working with API calls that could potentially result in custom response objects exceeding the hard limit of 4096 bytes.

---

parameters?🔹

Type: any (optional, default: no parameters)

Any parameters to pass to the api call.

Properties

Name	Type	Description
apiCallResource🔹	CustomResource
node🔹	Node	The tree node.
provider🔹	AssertionsProvider	access the AssertionsProvider.
waiterProvider?🔹	AssertionsProvider	access the AssertionsProvider for the waiter state machine.

---

apiCallResource🔹

Type: CustomResource

---

node🔹

Type: Node

The tree node.

---

provider🔹

Type: AssertionsProvider

access the AssertionsProvider.

This can be used to add additional IAM policies the the provider role policy

---

waiterProvider?🔹

Type: AssertionsProvider (optional)

access the AssertionsProvider for the waiter state machine.

This can be used to add additional IAM policies the the provider role policy Example

declare const apiCall: AwsApiCall;
apiCall.waiterProvider?.addToRolePolicy({
  Effect: 'Allow',
  Action: ['s3:GetObject'],
  Resource: ['*'],
});

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.
next(next)🔹	Allows you to chain IApiCalls. This adds an explicit dependency betweent the two resources.
toString()🔹	Returns a string representation of this construct.
waitForAssertions(options?)🔹	Wait for the IApiCall to return the expected response.

---

assertAtPath(path, expected)🔹

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

Parameters

• path string
• expected ExpectedResult

Returns

• IApiCall

Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.

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

---

expect(expected)🔹

public expect(expected: ExpectedResult): IApiCall

Parameters

• expected ExpectedResult

Returns

• IApiCall

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.

---

next(next)🔹

public next(next: IApiCall): IApiCall

Parameters

• next IApiCall

Returns

• IApiCall

Allows you to chain IApiCalls. This adds an explicit dependency betweent the two resources.

Returns the IApiCall provided as next

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

waitForAssertions(options?)🔹

public waitForAssertions(options?: WaiterStateMachineOptions): IApiCall

Parameters

• options WaiterStateMachineOptions

Returns

• IApiCall

Wait for the IApiCall to return the expected response.

If no expected response is specified then it will wait for the IApiCall to return a success