@aws-cdk_integ-tests-alpha.AssertionRequest

interface AssertionRequest ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.IntegTests.Alpha.AssertionRequest
Gogithub.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#AssertionRequest
Javasoftware.amazon.awscdk.integtests.alpha.AssertionRequest
Pythonaws_cdk.integ_tests_alpha.AssertionRequest
TypeScript (source)@aws-cdk/integ-tests-alpha ยป 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_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

NameTypeDescription
actual๐Ÿ”นanyThe actual value received.
expected๐Ÿ”นanyThe expected value to assert.
failDeployment?๐Ÿ”นbooleanSet 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.