@aws-cdk_integ-tests-alpha.EqualsAssertionProps

interface EqualsAssertionProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.IntegTests.Alpha.EqualsAssertionProps
Gogithub.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#EqualsAssertionProps
Javasoftware.amazon.awscdk.integtests.alpha.EqualsAssertionProps
Pythonaws_cdk.integ_tests_alpha.EqualsAssertionProps
TypeScript (source)@aws-cdk/integ-tests-alpha ยป EqualsAssertionProps

Options for an EqualsAssertion.

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 actualResult: integ_tests_alpha.ActualResult;
declare const expectedResult: integ_tests_alpha.ExpectedResult;
const equalsAssertionProps: integ_tests_alpha.EqualsAssertionProps = {
  actual: actualResult,
  expected: expectedResult,

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

Properties

NameTypeDescription
actual๐Ÿ”นActualResultThe actual results to compare.
expected๐Ÿ”นExpectedResultThe expected result to assert.
failDeployment?๐Ÿ”นbooleanSet this to true if a failed assertion should result in a CloudFormation deployment failure.

actual๐Ÿ”น

Type: ActualResult

The actual results to compare.


expected๐Ÿ”น

Type: ExpectedResult

The expected result 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.