LoadManifestOptions Struct
Options for the loadManifest operation.
| Source | lib/manifest.ts |
|---|---|
| Type last changed |
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,
};
python
from aws_cdk.cloud_assembly_schema import LoadManifestOptions
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import cloud_assembly_schema
load_manifest_options = LoadManifestOptions(
skip_enum_check=False,
skip_version_check=False,
topo_sort=False,
validate_schema=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cloud_assembly_schema.*;
LoadManifestOptions loadManifestOptions = LoadManifestOptions.builder()
.skipEnumCheck(false)
.skipVersionCheck(false)
.topoSort(false)
.validateSchema(false)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Cloud_assembly_schema;
var loadManifestOptions = new LoadManifestOptions {
SkipEnumCheck = false,
SkipVersionCheck = false,
TopoSort = false,
ValidateSchema = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
loadManifestOptions := &LoadManifestOptions{
SkipEnumCheck: jsii.Boolean(false),
SkipVersionCheck: jsii.Boolean(false),
TopoSort: jsii.Boolean(false),
ValidateSchema: jsii.Boolean(false),
}
Properties
skipEnumCheckoptionalbooleanskip_enum_checkoptionalboolskipEnumCheckoptionalBooleanSkipEnumCheckoptionalboolSkipEnumCheckoptional*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.
skipVersionCheckoptionalbooleanskip_version_checkoptionalboolskipVersionCheckoptionalBooleanSkipVersionCheckoptionalboolSkipVersionCheckoptional*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.
topoSortoptionalbooleantopo_sortoptionalbooltopoSortoptionalBooleanTopoSortoptionalboolTopoSortoptional*bool = true #Topologically sort all artifacts.
This parameter is only respected by the constructor of CloudAssembly. The property lives here for backwards compatibility reasons.
validateSchemaoptionalbooleanvalidate_schemaoptionalboolvalidateSchemaoptionalBooleanValidateSchemaoptionalboolValidateSchemaoptional*bool #Validate the file according to the declared JSON Schema.
Default: false, unless $TESTING_CDK is set to '1'
Be aware that JSON Schema validation has a significant performance cost (about 10x over not validating).