Package software.amazon.awscdk

Class DockerIgnoreStrategy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.IgnoreStrategy
software.amazon.awscdk.DockerIgnoreStrategy
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:09:57.356Z") @Stability(Stable) public class DockerIgnoreStrategy extends IgnoreStrategy
Ignores file paths based on the .dockerignore specification.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 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
    Description
     
    DockerIgnoreStrategy(String absoluteRootPath, List<String> patterns)
     
    protected
    DockerIgnoreStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    DockerIgnoreStrategy(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(String pattern)
    Adds another pattern.
    Boolean
    completelyIgnores(String absoluteDirectoryPath)
    Determines whether a given directory path should be ignored and have all of its children ignored.
    Boolean
    ignores(String absoluteFilePath)
    Determines whether a given file path should be ignored or not.

    Methods inherited from class software.amazon.awscdk.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 Details

    • DockerIgnoreStrategy

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

    • DockerIgnoreStrategy

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

    • DockerIgnoreStrategy

      @Stability(Stable) public DockerIgnoreStrategy(@NotNull String absoluteRootPath, @NotNull List<String> patterns)
      Parameters:
      absoluteRootPath - This parameter is required.
      patterns - This parameter is required.

  • Method Details

    • add

      @Stability(Stable) public void add(@NotNull String pattern)
      Adds another pattern.

      Specified by:
      add in class IgnoreStrategy
      Parameters:
      pattern - This parameter is required.

    • completelyIgnores

      @Stability(Stable) @NotNull public Boolean completelyIgnores(@NotNull String absoluteDirectoryPath)
      Determines whether a given directory path should be ignored and have all of its children ignored.

      Overrides:
      completelyIgnores in class IgnoreStrategy
      Parameters:
      absoluteDirectoryPath - absolute directory path to be assessed against the pattern. This parameter is required.
      Returns:
      true if the directory and all of its children should be ignored

    • ignores

      @Stability(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