aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
111 lines (110 loc) • 3.18 kB
TypeScript
/**
* Determines how symlinks are followed.
*/
export declare enum SymlinkFollowMode {
/**
* Never follow symlinks.
*/
NEVER = "never",
/**
* Materialize all symlinks, whether they are internal or external to the source directory.
*/
ALWAYS = "always",
/**
* Only follows symlinks that are external to the source directory.
*/
EXTERNAL = "external",
/**
* Forbids source from having any symlinks pointing outside of the source
* tree.
*
* This is the safest mode of operation as it ensures that copy operations
* won't materialize files from the user's file system. Internal symlinks are
* not followed.
*
* If the copy operation runs into an external symlink, it will fail.
*/
BLOCK_EXTERNAL = "internal-only"
}
/**
* Determines the ignore behavior to use.
*/
export declare enum IgnoreMode {
/**
* Ignores file paths based on simple glob patterns.
*
* This is the default for file assets.
*
* It is also the default for Docker image assets, unless the '@aws-cdk/aws-ecr-assets:dockerIgnoreSupport'
* context flag is set.
*/
GLOB = "glob",
/**
* Ignores file paths based on the [`.gitignore specification`](https://git-scm.com/docs/gitignore).
*/
GIT = "git",
/**
* Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
*
* This is the default for Docker image assets if the '@aws-cdk/aws-ecr-assets:dockerIgnoreSupport'
* context flag is set.
*/
DOCKER = "docker"
}
interface FileOptions {
/**
* File paths matching the patterns will be excluded. See `ignoreMode` to set the matching behavior.
* Has no effect on Assets bundled using the `bundling` property.
*
* @default - nothing is excluded
*/
readonly exclude?: string[];
/**
* The ignore behavior to use for `exclude` patterns.
*
* @default IgnoreMode.GLOB
*/
readonly ignoreMode?: IgnoreMode;
}
/**
* Options applied when copying directories
*/
export interface CopyOptions extends FileOptions {
/**
* A strategy for how to handle symlinks.
*
* @default SymlinkFollowMode.NEVER
*/
readonly follow?: SymlinkFollowMode;
}
/**
* Options applied when copying directories into the staging location.
*/
export interface FileCopyOptions extends FileOptions {
/**
* A strategy for how to handle symlinks.
*
* @default SymlinkFollowMode.NEVER
*/
readonly followSymlinks?: SymlinkFollowMode;
}
interface ExtraHashOptions {
/**
* Extra information to encode into the fingerprint (e.g. build instructions
* and other inputs)
*
* @default - hash is only based on source content
*/
readonly extraHash?: string;
}
/**
* Options related to calculating source hash.
*/
export interface FingerprintOptions extends CopyOptions, ExtraHashOptions {
}
/**
* Options related to calculating source hash.
*/
export interface FileFingerprintOptions extends FileCopyOptions, ExtraHashOptions {
}
export {};