Class FileFingerprintOptions

Options related to calculating source hash.

Inheritance

object

FileFingerprintOptions

Implements

IFileFingerprintOptions

IFileCopyOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class FileFingerprintOptions : IFileFingerprintOptions, IFileCopyOptions

Syntax (vb)

Public Class FileFingerprintOptions Implements IFileFingerprintOptions, IFileCopyOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;

            var fileFingerprintOptions = new FileFingerprintOptions {
                Exclude = new [] { "exclude" },
                ExtraHash = "extraHash",
                FollowSymlinks = SymlinkFollowMode.NEVER,
                IgnoreMode = IgnoreMode.GLOB
            };

Synopsis

Constructors

FileFingerprintOptions()

Options related to calculating source hash.

Properties

Exclude	File paths matching the patterns will be excluded.
ExtraHash	Extra information to encode into the fingerprint (e.g. build instructions and other inputs).
FollowSymlinks	A strategy for how to handle symlinks.
IgnoreMode	The ignore behavior to use for `exclude` patterns.

Constructors

FileFingerprintOptions()

Options related to calculating source hash.

public FileFingerprintOptions()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;

            var fileFingerprintOptions = new FileFingerprintOptions {
                Exclude = new [] { "exclude" },
                ExtraHash = "extraHash",
                FollowSymlinks = SymlinkFollowMode.NEVER,
                IgnoreMode = IgnoreMode.GLOB
            };

Properties

Exclude

File paths matching the patterns will be excluded.

public string[]? Exclude { get; set; }

Property Value

string[]

Remarks

See ignoreMode to set the matching behavior. Has no effect on Assets bundled using the bundling property.

Default: - nothing is excluded

ExtraHash

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

public string? ExtraHash { get; set; }

Property Value

string

Remarks

Default: - hash is only based on source content

FollowSymlinks

A strategy for how to handle symlinks.

public SymlinkFollowMode? FollowSymlinks { get; set; }

Property Value

SymlinkFollowMode?

Remarks

Default: SymlinkFollowMode.NEVER

IgnoreMode

The ignore behavior to use for exclude patterns.

public IgnoreMode? IgnoreMode { get; set; }

Property Value

IgnoreMode?

Remarks

Default: IgnoreMode.GLOB

Implements

IFileFingerprintOptions

IFileCopyOptions