aws-cdk-lib.assertions.MatchFailure

MatchFailure Struct

Match failure details.

Source

assertions/lib/matcher.ts

Type last changed

v2.58.0 · 29 Dec 2022

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { assertions } from 'aws-cdk-lib';

declare const matcher: assertions.Matcher;
const matchFailure: assertions.MatchFailure = {
  matcher: matcher,
  message: 'message',
  path: ['path'],

  // the properties below are optional
  cost: 123,
};

Properties

costnumbercostint | floatcostNumberCostdoubleCost*float64= 1#

The cost of this particular mismatch.

matcherMatchermatcherMatchermatcherMatcherMatcherMatcherMatcherMatcherrequired#

The matcher that had the failure.

messagestringmessagestrmessageStringMessagestringMessage*stringrequired#

Failure message.

pathstring[]pathtyping.List[str]pathList<String>Pathstring[]Path*[]*stringrequired#

The relative path in the target where the failure occurred.

If the failure occurred at root of the match tree, set the path to an empty list. If it occurs in the 5th index of an array nested within the 'foo' key of an object, set the path as ['/foo', '[5]'].