@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/interfaces.d.ts

Schema for the protocol between CDK framework and CDK CLI

/**
 * Interoperable representation of a deployable cloud application.
 *
 * The external and interoperable contract for a Cloud Assembly is
 * a directory containing a valid Cloud Assembly.
 *
 * Implementations should use the directory to load the Cloud Assembly from disk.
 * It is recommended that implementations validate loaded manifest files using
 * the provided functionality from this package.
 * Within an implementation, it may be prudent to keep (parts of) the Cloud Assembly
 * in memory during execution and use an implementation-specific contract.
 * However when an implementation is providing an external contract,
 * this interface should be used.
 */
export interface ICloudAssembly {
    /**
     * The directory of the cloud assembly.
     *
     * This directory will be used to read the Cloud Assembly from.
     * Its contents (in particular `manifest.json`) must comply with the schema defined in this package.
     */
    readonly directory: string;
}