Package software.amazon.awscdk.cloud_assembly_schema

Interface LoadManifestOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LoadManifestOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:21.860Z")
@Stability(Stable)
public interface LoadManifestOptions
extends software.amazon.jsii.JsiiSerializable

Options for the loadManifest operation.

Example:

 // 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LoadManifestOptions.Builder	A builder for LoadManifestOptions
static final class	LoadManifestOptions.Jsii$Proxy	An implementation for LoadManifestOptions

Method Summary

Modifier and Type	Method	Description
static LoadManifestOptions.Builder	builder()
default Boolean	getSkipEnumCheck()	Skip enum checks.
default Boolean	getSkipVersionCheck()	Skip the version check.
default Boolean	getTopoSort()	Topologically sort all artifacts.
default Boolean	getValidateSchema()	Validate the file according to the declared JSON Schema.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSkipEnumCheck

@Stability(Stable)
@Nullable
default Boolean getSkipEnumCheck()

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.

Default: false

getSkipVersionCheck

@Stability(Stable)
@Nullable
default Boolean getSkipVersionCheck()

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.

Default: false

getTopoSort

@Stability(Stable)
@Nullable
default Boolean getTopoSort()

Topologically sort all artifacts.

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

Default: true

getValidateSchema

@Stability(Stable)
@Nullable
default Boolean getValidateSchema()

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: false, unless $TESTING_CDK is set to '1'

builder

@Stability(Stable)
static LoadManifestOptions.Builder builder()

Returns:

a LoadManifestOptions.Builder of LoadManifestOptions