@aws-cdk/cloud-assembly-schema/lib/assets/file-asset.d.ts

Schema for the protocol between CDK framework and CDK CLI

import type { AwsDestination } from './aws-destination';
/**
 * A file asset
 */
export interface FileAsset {
    /**
     * A display name for this asset
     *
     * @default - The identifier will be used as the display name
     */
    readonly displayName?: string;
    /**
     * Source description for file assets
     */
    readonly source: FileSource;
    /**
     * Destinations for this file asset
     */
    readonly destinations: {
        [id: string]: FileDestination;
    };
}
/**
 * Packaging strategy for file assets
 */
export declare enum FileAssetPackaging {
    /**
     * Upload the given path as a file
     */
    FILE = "file",
    /**
     * The given path is a directory, zip it and upload
     */
    ZIP_DIRECTORY = "zip"
}
/**
 * Describe the source of a file asset
 */
export interface FileSource {
    /**
     * External command which will produce the file asset to upload.
     *
     * @default - Exactly one of `executable` and `path` is required.
     */
    readonly executable?: string[];
    /**
     * The filesystem object to upload
     *
     * This path is relative to the asset manifest location.
     *
     * @default - Exactly one of `executable` and `path` is required.
     */
    readonly path?: string;
    /**
     * Packaging method
     *
     * Only allowed when `path` is specified.
     *
     * @default FILE
     */
    readonly packaging?: FileAssetPackaging;
}
/**
 * Where in S3 a file asset needs to be published
 */
export interface FileDestination extends AwsDestination {
    /**
     * The name of the bucket
     */
    readonly bucketName: string;
    /**
     * The destination object key
     */
    readonly objectKey: string;
}