Package software.amazon.awscdk

Interface FileCopyOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AssetImageCodeProps, AssetImageProps, AssetOptions, AssetProps, CustomCommandOptions, DockerImageAssetOptions, DockerImageAssetProps, FileFingerprintOptions, InitFileAssetOptions, InitSourceAssetOptions

All Known Implementing Classes:

AssetImageCodeProps.Jsii$Proxy, AssetImageProps.Jsii$Proxy, AssetOptions.Jsii$Proxy, AssetProps.Jsii$Proxy, CustomCommandOptions.Jsii$Proxy, DockerImageAssetOptions.Jsii$Proxy, DockerImageAssetProps.Jsii$Proxy, FileCopyOptions.Jsii$Proxy, FileFingerprintOptions.Jsii$Proxy, InitFileAssetOptions.Jsii$Proxy, InitSourceAssetOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:57.377Z")
@Stability(Stable)
public interface FileCopyOptions
extends software.amazon.jsii.JsiiSerializable

Options applied when copying directories into the staging location.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 FileCopyOptions fileCopyOptions = FileCopyOptions.builder()
         .exclude(List.of("exclude"))
         .followSymlinks(SymlinkFollowMode.NEVER)
         .ignoreMode(IgnoreMode.GLOB)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FileCopyOptions.Builder	A builder for FileCopyOptions
static final class	FileCopyOptions.Jsii$Proxy	An implementation for FileCopyOptions

Method Summary

Modifier and Type	Method	Description
static FileCopyOptions.Builder	builder()
default List<String>	getExclude()	File paths matching the patterns will be excluded.
default SymlinkFollowMode	getFollowSymlinks()	A strategy for how to handle symlinks.
default IgnoreMode	getIgnoreMode()	The ignore behavior to use for exclude patterns.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExclude

@Stability(Stable)
@Nullable
default List<String> getExclude()

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

getFollowSymlinks

@Stability(Stable)
@Nullable
default SymlinkFollowMode getFollowSymlinks()

A strategy for how to handle symlinks.

Default: SymlinkFollowMode.NEVER

getIgnoreMode

@Stability(Stable)
@Nullable
default IgnoreMode getIgnoreMode()

The ignore behavior to use for exclude patterns.

Default: IgnoreMode.GLOB

builder

@Stability(Stable)
static FileCopyOptions.Builder builder()

Returns:

a FileCopyOptions.Builder of FileCopyOptions