@aws-cdk_integ-tests-alpha.EqualsAssertion

class EqualsAssertion (construct) ๐Ÿ”น

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

Implements IConstruct, IDependable

Construct that creates a CustomResource to assert that two values are equal.

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 equalsAssertion = new integ_tests_alpha.EqualsAssertion(this, 'MyEqualsAssertion', {
  actual: actualResult,
  expected: expectedResult,

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

Initializer

new EqualsAssertion(scope: Construct, id: string, props: EqualsAssertionProps)

Parameters

  • scope Construct
  • id string
  • props EqualsAssertionProps

Construct Props

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.

Properties

NameTypeDescription
node๐Ÿ”นNodeThe tree node.
result๐Ÿ”นstringThe result of the assertion.

node๐Ÿ”น

Type: Node

The tree node.


result๐Ÿ”น

Type: string

The result of the assertion.

Methods

NameDescription
toString()๐Ÿ”นReturns a string representation of this construct.

toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.