Package software.amazon.awscdk

Interface CopyOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AssetStagingProps, FingerprintOptions

All Known Implementing Classes:

AssetStagingProps.Jsii$Proxy, CopyOptions.Jsii$Proxy, FingerprintOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-04T09:06:16.246Z")
@Stability(Stable)
public interface CopyOptions
extends software.amazon.jsii.JsiiSerializable

Options applied when copying directories.

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CopyOptions.Builder	builder()
default List<String>	getExclude()	File paths matching the patterns will be excluded.
default SymlinkFollowMode	getFollow()	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

getFollow

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

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 CopyOptions.Builder builder()

Returns:

a CopyOptions.Builder of CopyOptions