aws-cdk-lib.FileFingerprintOptions

interface FileFingerprintOptions

LanguageType name
.NETAmazon.CDK.FileFingerprintOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2#FileFingerprintOptions
Javasoftware.amazon.awscdk.FileFingerprintOptions
Pythonaws_cdk.FileFingerprintOptions
TypeScript (source)aws-cdk-lib » FileFingerprintOptions

Options related to calculating source hash.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const fileFingerprintOptions: cdk.FileFingerprintOptions = {
  exclude: ['exclude'],
  extraHash: 'extraHash',
  followSymlinks: cdk.SymlinkFollowMode.NEVER,
  ignoreMode: cdk.IgnoreMode.GLOB,
};

Properties

NameTypeDescription
exclude?string[]File paths matching the patterns will be excluded.
extraHash?stringExtra information to encode into the fingerprint (e.g. build instructions and other inputs).
followSymlinks?SymlinkFollowModeA strategy for how to handle symlinks.
ignoreMode?IgnoreModeThe ignore behavior to use for exclude patterns.

exclude?

Type: string[] (optional, default: nothing is excluded)

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.


extraHash?

Type: string (optional, default: hash is only based on source content)

Extra information to encode into the fingerprint (e.g. build instructions and other inputs).


followSymlinks?

Type: SymlinkFollowMode (optional, default: SymlinkFollowMode.NEVER)

A strategy for how to handle symlinks.


ignoreMode?

Type: IgnoreMode (optional, default: IgnoreMode.GLOB)

The ignore behavior to use for exclude patterns.