aws-cdk-lib.DockerIgnoreStrategy

class DockerIgnoreStrategy

LanguageType name
.NETAmazon.CDK.DockerIgnoreStrategy
Gogithub.com/aws/aws-cdk-go/awscdk/v2#DockerIgnoreStrategy
Javasoftware.amazon.awscdk.DockerIgnoreStrategy
Pythonaws_cdk.DockerIgnoreStrategy
TypeScript (source)aws-cdk-lib » 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 * as cdk from 'aws-cdk-lib';
const dockerIgnoreStrategy = new cdk.DockerIgnoreStrategy('absoluteRootPath', ['patterns']);

Initializer

new DockerIgnoreStrategy(absoluteRootPath: string, patterns: string[])

Parameters

  • absoluteRootPath string
  • patterns string[]

Methods

NameDescription
add(pattern)Adds another pattern.
ignores(absoluteFilePath)Determines whether a given file path should be ignored or not.

add(pattern)

public add(pattern: string): void

Parameters

  • pattern string

Adds another pattern.


ignores(absoluteFilePath)

public ignores(absoluteFilePath: string): boolean

Parameters

  • absoluteFilePath string — absolute file path to be assessed against the pattern.

Returns

  • boolean

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