interface AssertionRequest
Language | Type name |
---|---|
.NET | Amazon.CDK.IntegTests.AssertionRequest |
Java | software.amazon.awscdk.integtests.AssertionRequest |
Python | aws_cdk.integ_tests.AssertionRequest |
TypeScript (source) | @aws-cdk/integ-tests » AssertionRequest |
A request to make an assertion that the actual value matches the expected.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as integ_tests from '@aws-cdk/integ-tests';
declare const actual: any;
declare const expected: any;
const assertionRequest: integ_tests.AssertionRequest = {
actual: actual,
expected: expected,
// the properties below are optional
failDeployment: false,
};
Properties
Name | Type | Description |
---|---|---|
actual | any | The actual value received. |
expected | any | The expected value to assert. |
fail | boolean | Set this to true if a failed assertion should result in a CloudFormation deployment failure. |
actual
Type:
any
The actual value received.
expected
Type:
any
The expected value to assert.
failDeployment?
Type:
boolean
(optional, default: false)
Set this to true if a failed assertion should result in a CloudFormation deployment failure.
This is only necessary if assertions are being
executed outside of integ-runner
.