software.amazon.awscdk.core

Class DockerIgnoreStrategy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.IgnoreStrategy

software.amazon.awscdk.core.DockerIgnoreStrategy

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-03-01T02:28:55.785Z")
 @Stability(value=Stable)
public class DockerIgnoreStrategy
extends IgnoreStrategy

Ignores file paths based on the [`.dockerignore specification`](https://docs.docker.com/engine/reference/builder/#dockerignore-file).

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 DockerIgnoreStrategy dockerIgnoreStrategy = new DockerIgnoreStrategy("absoluteRootPath", List.of("patterns"));
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DockerIgnoreStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DockerIgnoreStrategy(software.amazon.jsii.JsiiObjectRef objRef)
	DockerIgnoreStrategy(String absoluteRootPath, List<String> patterns)

Method Summary

Modifier and Type	Method and Description
void	add(String pattern) Adds another pattern.
Boolean	ignores(String absoluteFilePath) Determines whether a given file path should be ignored or not.

Methods inherited from class software.amazon.awscdk.core.IgnoreStrategy

docker, fromCopyOptions, git, glob

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

DockerIgnoreStrategy

protected DockerIgnoreStrategy(software.amazon.jsii.JsiiObjectRef objRef)

DockerIgnoreStrategy

protected DockerIgnoreStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DockerIgnoreStrategy

@Stability(value=Stable)
public DockerIgnoreStrategy(@NotNull
                                                     String absoluteRootPath,
                                                     @NotNull
                                                     List<String> patterns)

Parameters:

absoluteRootPath - This parameter is required.

patterns - This parameter is required.

Method Detail

add

@Stability(value=Stable)
public void add(@NotNull
                                         String pattern)

Adds another pattern.

Specified by:

add in class IgnoreStrategy

Parameters:

pattern - This parameter is required.

ignores

@Stability(value=Stable)
 @NotNull
public Boolean ignores(@NotNull
                                                          String absoluteFilePath)

Determines whether a given file path should be ignored or not.

Specified by:

ignores in class IgnoreStrategy

Parameters:

absoluteFilePath - absolute file path to be assessed against the pattern. This parameter is required.

Returns:

`true` if the file should be ignored