Skip to content
v2.277.0

CopyOptions Struct ​

Options applied when copying directories.

Example ​

ts
// 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 copyOptions: cdk.CopyOptions = {
  exclude: ['exclude'],
  follow: cdk.SymlinkFollowMode.NEVER,
  ignoreMode: cdk.IgnoreMode.GLOB,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

copy_options = cdk.CopyOptions(
    exclude=["exclude"],
    follow=cdk.SymlinkFollowMode.NEVER,
    ignore_mode=cdk.IgnoreMode.GLOB
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;

var copyOptions = new CopyOptions {
    Exclude = new [] { "exclude" },
    Follow = SymlinkFollowMode.NEVER,
    IgnoreMode = IgnoreMode.GLOB
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

copyOptions := &CopyOptions{
	Exclude: []*string{
		jsii.String("exclude"),
	},
	Follow: cdk.SymlinkFollowMode_NEVER,
	IgnoreMode: cdk.IgnoreMode_GLOB,
}

Properties ​

excludeoptionalstring[]excludeoptionaltyping.List[str]excludeoptionalList<String>Excludeoptionalstring[]Excludeoptional*[]*string#
File paths matching the patterns will be excluded.

Default: nothing is excluded

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

followoptionalSymlinkFollowModefollowoptionalSymlinkFollowModefollowoptionalSymlinkFollowModeFollowoptionalSymlinkFollowModeFollowoptionalSymlinkFollowMode= SymlinkFollowMode.NEVER#
A strategy for how to handle symlinks.
ignoreModeoptionalIgnoreModeignore_modeoptionalIgnoreModeignoreModeoptionalIgnoreModeIgnoreModeoptionalIgnoreModeIgnoreModeoptionalIgnoreMode= IgnoreMode.GLOB#
The ignore behavior to use for `exclude` patterns.