Skip to content
v2.274.0

LoadManifestOptions Struct ​

Options for the loadManifest operation.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';
const loadManifestOptions: cloud_assembly_schema.LoadManifestOptions = {
  skipEnumCheck: false,
  skipVersionCheck: false,
  topoSort: false,
  validateSchema: false,
};

Properties ​

skipEnumCheckbooleanskip_enum_checkboolskipEnumCheckBooleanSkipEnumCheckboolSkipEnumCheck*bool= false#
Skip enum checks.

This means you may read enum values you don't know about yet. Make sure to always check the values of enums you encounter in the manifest.

skipVersionCheckbooleanskip_version_checkboolskipVersionCheckBooleanSkipVersionCheckboolSkipVersionCheck*bool= false#
Skip the version check.

This means you may read a newer cloud assembly than the CX API is designed to support, and your application may not be aware of all features that in use in the Cloud Assembly.

topoSortbooleantopo_sortbooltopoSortBooleanTopoSortboolTopoSort*bool= true#
Topologically sort all artifacts.

This parameter is only respected by the constructor of CloudAssembly. The property lives here for backwards compatibility reasons.

validateSchemabooleanvalidate_schemaboolvalidateSchemaBooleanValidateSchemaboolValidateSchema*bool= false, unless $TESTING_CDK is se…#
Validate the file according to the declared JSON Schema.

Be aware that JSON Schema validation has a significant performance cost (about 10x over not validating).

default

Default: false, unless $TESTING_CDK is set to '1'