Package software.amazon.awscdk

Enum SymlinkFollowMode

java.lang.Object

java.lang.Enum<SymlinkFollowMode>

software.amazon.awscdk.SymlinkFollowMode

All Implemented Interfaces:

Serializable, Comparable<SymlinkFollowMode>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-13T16:55:01.923Z")
@Stability(Stable)
public enum SymlinkFollowMode
extends Enum<SymlinkFollowMode>

Determines how symlinks are followed.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Copy all the files the symlinks point to (always follow).
BLOCK_EXTERNAL	Forbids source from having any symlinks pointing outside of the source tree.
EXTERNAL	Materialize symlinks pointing outside, leave symlinks pointing inside.
NEVER	Copy symlinks themselves (do not follow, preserve the symlink contents).

Method Summary

Modifier and Type	Method	Description
static SymlinkFollowMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SymlinkFollowMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NEVER

@Stability(Stable)
public static final SymlinkFollowMode NEVER

Copy symlinks themselves (do not follow, preserve the symlink contents).

If any of the symlinks point outside the source directory and the Cloud Assembly gets moved to a different computer, the asset may end up pointing to files that don't exist on that other computer.

ALWAYS

@Stability(Stable)
public static final SymlinkFollowMode ALWAYS

Copy all the files the symlinks point to (always follow).

This reads target files even if the symlinks point outside the source directory. Uses more disk space but is guaranteed to end up with a complete asset directory.

EXTERNAL

@Stability(Stable)
public static final SymlinkFollowMode EXTERNAL

Materialize symlinks pointing outside, leave symlinks pointing inside.

If the symlink points to a file outside the source, copy the target file. Otherwise copy the symlink itself.

This produces a complete asset bundle, while saving space.

BLOCK_EXTERNAL

@Stability(Stable)
public static final SymlinkFollowMode BLOCK_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.

Method Details

values

public static SymlinkFollowMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SymlinkFollowMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null