Manifest

class aws_cdk.cloud_assembly_schema.Manifest(*args: Any, **kwargs)

Bases: object

Protocol utility class.

Static Methods

classmethod load(file_path)

(deprecated) Deprecated.

Parameters:

file_path (str) –

Deprecated:

use loadAssemblyManifest()

Stability:

deprecated

Return type:

AssemblyManifest

classmethod load_assembly_manifest(file_path, *, skip_enum_check=None, skip_version_check=None, topo_sort=None)

Load and validates the cloud assembly manifest from file.

Parameters:

  • file_path (str) –

    • path to the manifest file.

  • skip_enum_check (Optional[bool]) – 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

  • skip_version_check (Optional[bool]) – 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

  • topo_sort (Optional[bool]) – Topologically sort all artifacts. This parameter is only respected by the constructor of CloudAssembly. The property lives here for backwards compatibility reasons. Default: true

Return type:

AssemblyManifest

classmethod load_asset_manifest(file_path)

Load and validates the asset manifest from file.

Parameters:

file_path (str) –

  • path to the manifest file.

Return type:

AssetManifest

classmethod load_integ_manifest(file_path)

Load and validates the integ manifest from file.

Parameters:

file_path (str) –

  • path to the manifest file.

Return type:

IntegManifest

classmethod save(manifest, file_path)

(deprecated) Deprecated.

Parameters:
Deprecated:

use saveAssemblyManifest()

Stability:

deprecated

Return type:

None

classmethod save_assembly_manifest(manifest, file_path)

Validates and saves the cloud assembly manifest to file.

Parameters:

  • manifest (Union[AssemblyManifest, Dict[str, Any]]) –

    • manifest.

  • file_path (str) –

    • output file path.

Return type:

None

classmethod save_asset_manifest(manifest, file_path)

Validates and saves the asset manifest to file.

Parameters:

  • manifest (Union[AssetManifest, Dict[str, Any]]) –

    • manifest.

  • file_path (str) –

    • output file path.

Return type:

None

classmethod save_integ_manifest(manifest, file_path)

Validates and saves the integ manifest to file.

Parameters:

  • manifest (Union[IntegManifest, Dict[str, Any]]) –

    • manifest.

  • file_path (str) –

    • output file path.

Return type:

None

classmethod version()

Fetch the current schema version number.

Return type:

str