aws-cdk-lib.ValidationResults

class ValidationResults

LanguageType name
.NETAmazon.CDK.ValidationResults
Gogithub.com/aws/aws-cdk-go/awscdk/v2#ValidationResults
Javasoftware.amazon.awscdk.ValidationResults
Pythonaws_cdk.ValidationResults
TypeScript (source)aws-cdk-lib » ValidationResults

A collection of validation results.

Example

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

declare const validationResult: cdk.ValidationResult;
const validationResults = new cdk.ValidationResults(/* all optional props */ [validationResult]);

Initializer

new ValidationResults(results?: ValidationResult[])

Parameters

  • results ValidationResult[]

Properties

NameTypeDescription
isSuccessboolean
resultsValidationResult[]

isSuccess

Type: boolean


results

Type: ValidationResult[]

Methods

NameDescription
collect(result)
errorTreeList()
wrap(message)Wrap up all validation results into a single tree node.

collect(result)

public collect(result: ValidationResult): void

Parameters

  • result ValidationResult

errorTreeList()

public errorTreeList(): string

Returns

  • string

wrap(message)

public wrap(message: string): ValidationResult

Parameters

  • message string

Returns

  • ValidationResult

Wrap up all validation results into a single tree node.

If there are failures in the collection, add a message, otherwise return a success.