interface IDeployAssert 🔹

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

Interface that allows for registering a list of assertions that should be performed on a construct.

This is only necessary when writing integration tests.

Methods

Name	Description
awsApiCall(service, api, parameters?)🔹	Query AWS using JavaScript SDK V2 API calls.
expect(id, expected, actual)🔹	Assert that the ExpectedResult is equal to the ActualResult.
invokeFunction(props)🔹	Invoke a lambda function and return the response which can be asserted.

---

awsApiCall(service, api, parameters?)🔹

public awsApiCall(service: string, api: string, parameters?: any): IAwsApiCall

Parameters

• service string
• api string
• parameters any

Returns

• IAwsApiCall

Query AWS using JavaScript SDK V2 API calls.

This can be used to either trigger an action or to return a result that can then be asserted against an expected value Example

declare const app: App;
declare const integ: IntegTest;
integ.assertions.awsApiCall('SQS', 'sendMessage', {
  QueueUrl: 'url',
  MessageBody: 'hello',
});
const message = integ.assertions.awsApiCall('SQS', 'receiveMessage', {
  QueueUrl: 'url',
});
message.expect(ExpectedResult.objectLike({
  Messages: [{ Body: 'hello' }],
}));

---

expect(id, expected, actual)🔹

public expect(id: string, expected: ExpectedResult, actual: ActualResult): void

Parameters

• id string
• expected ExpectedResult
• actual ActualResult

Assert that the ExpectedResult is equal to the ActualResult. Example

declare const integ: IntegTest;
declare const apiCall: AwsApiCall;
integ.assertions.expect(
  'invoke',
  ExpectedResult.objectLike({ Payload: 'OK' }),
  ActualResult.fromAwsApiCall(apiCall, 'Body'),
);

---

invokeFunction(props)🔹

public invokeFunction(props: LambdaInvokeFunctionProps): IAwsApiCall

Parameters

• props LambdaInvokeFunctionProps

Returns

• IAwsApiCall

Invoke a lambda function and return the response which can be asserted. Example

declare const app: App;
declare const integ: IntegTest;
const invoke = integ.assertions.invokeFunction({
  functionName: 'my-function',
});
invoke.expect(ExpectedResult.objectLike({
  Payload: '200',
}));