@aws-cdk/integ-tests-alpha.AssertionRequest

Experimental

@aws-cdk/integ-tests-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AssertionRequest Struct

A request to make an assertion that the actual value matches the expected.

Stability

Experimental

Source

lib/assertions/providers/lambda-handler/types.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as integ_tests_alpha from '@aws-cdk/integ-tests-alpha';

declare const actual: any;
declare const expected: any;
const assertionRequest: integ_tests_alpha.AssertionRequest = {
  actual: actual,
  expected: expected,

  // the properties below are optional
  failDeployment: false,
};

Properties

actualanyactualAnyactualObjectActualobjectActualinterface{}required#

The actual value received.

expectedanyexpectedAnyexpectedObjectExpectedobjectExpectedinterface{}required#

The expected value to assert.

failDeployment?optionalbooleanfail_deployment?optionalboolfailDeployment?optionalBooleanFailDeployment?optionalboolFailDeployment?optional*bool= 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.