Package software.amazon.awscdk.services.lambda.nodejs

Interface BundlingOptions

All Superinterfaces:
DockerRunOptions, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
BundlingOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:04.032Z") @Stability(Stable) public interface BundlingOptions extends software.amazon.jsii.JsiiSerializable, DockerRunOptions
Bundling options.

Example: 

 NodejsFunction.Builder.create(this, "my-handler")
         .bundling(BundlingOptions.builder()
                 .dockerImage(DockerImage.fromBuild("/path/to/Dockerfile"))
                 .build())
         .build();

  • Method Details

    • getAssetHash

      @Stability(Stable) @Nullable default String getAssetHash()
      Specify a custom hash for this asset.

      For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

      NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated.

      Default: - asset hash is calculated based on the bundled output

    • getBanner

      @Stability(Stable) @Nullable default String getBanner()
      Use this to insert an arbitrary string at the beginning of generated JavaScript files.

      This is similar to footer which inserts at the end instead of the beginning.

      This is commonly used to insert comments:

      Default: - no comments are passed

    • getBuildArgs

      @Stability(Stable) @Nullable default Map<String,String> getBuildArgs()
      Build arguments to pass when building the bundling image.

      Default: - no build arguments are passed

    • getBundleAwsSDK

      @Stability(Stable) @Nullable default Boolean getBundleAwsSDK()
      Includes AWS SDK in the bundle asset.

      Default: - false if `true` the `aws-sdk` will be included in the asset bundle and not be resolved to the Lambda provided sdk.

    • getBundlingFileAccess

      @Stability(Stable) @Nullable default BundlingFileAccess getBundlingFileAccess()
      Which option to use to copy the source files to the docker container and output files back.

      Default: - BundlingFileAccess.BIND_MOUNT

    • getCharset

      @Stability(Stable) @Nullable default Charset getCharset()
      The charset to use for esbuild's output.

      By default esbuild's output is ASCII-only. Any non-ASCII characters are escaped using backslash escape sequences. Using escape sequences makes the generated output slightly bigger, and also makes it harder to read. If you would like for esbuild to print the original characters without using escape sequences, use Charset.UTF8.

      Default: Charset.ASCII

      See Also:

    • getCommandHooks

      @Stability(Stable) @Nullable default ICommandHooks getCommandHooks()
      Command hooks.

      Default: - do not run additional commands

    • getDefine

      @Stability(Stable) @Nullable default Map<String,String> getDefine()
      Replace global identifiers with constant expressions.

      For example, { 'process.env.DEBUG': 'true' }.

      Another example, { 'process.env.API_KEY': JSON.stringify('xxx-xxxx-xxx') }.

      Default: - no replacements are made

    • getDockerImage

      @Stability(Stable) @Nullable default DockerImage getDockerImage()
      A custom bundling Docker image.

      This image should have esbuild installed globally. If you plan to use nodeModules it should also have npm, yarn or pnpm depending on the lock file you're using.

      See https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-lambda-nodejs/lib/Dockerfile for the default image provided by aws-cdk-lib/aws-lambda-nodejs.

      Default: - use the Docker image provided by aws-cdk-lib/aws-lambda-nodejs

    • getEsbuildArgs

      @Stability(Stable) @Nullable default Map<String,Object> getEsbuildArgs()
      Build arguments to pass into esbuild.

      For example, to add the --log-limit flag: 

       new NodejsFunction(scope, id, {
   ...
   bundling: {
     esbuildArgs: {
       "--log-limit": "0",
     }
   }
 });

      Default: - no additional esbuild arguments are passed

    • getEsbuildVersion

      @Stability(Stable) @Nullable default String getEsbuildVersion()
      The version of esbuild to use when running in a Docker container.

      Default: - latest v0

    • getExternalModules

      @Stability(Stable) @Nullable default List<String> getExternalModules()
      A list of modules that should be considered as externals (already available in the runtime).

      Default: - no replacements are made

    • getFooter

      @Stability(Stable) @Nullable default String getFooter()
      Use this to insert an arbitrary string at the end of generated JavaScript files.

      This is similar to banner which inserts at the beginning instead of the end.

      This is commonly used to insert comments

      Default: - no comments are passed

    • getForceDockerBundling

      @Stability(Stable) @Nullable default Boolean getForceDockerBundling()
      Force bundling in a Docker container even if local bundling is possible.

      This is useful if your function relies on node modules that should be installed (nodeModules) in a Lambda compatible environment.

      Default: false

    • getFormat

      @Stability(Stable) @Nullable default OutputFormat getFormat()
      Output format for the generated JavaScript files.

      Default: OutputFormat.CJS

    • getInject

      @Stability(Stable) @Nullable default List<String> getInject()
      This option allows you to automatically replace a global variable with an import from another file.

      Default: - no code is injected

      See Also:

    • getKeepNames

      @Stability(Stable) @Nullable default Boolean getKeepNames()
      Whether to preserve the original name values even in minified code.

      In JavaScript the name property on functions and classes defaults to a nearby identifier in the source code.

      However, minification renames symbols to reduce code size and bundling sometimes need to rename symbols to avoid collisions. That changes value of the name property for many of these cases. This is usually fine because the name property is normally only used for debugging. However, some frameworks rely on the name property for registration and binding purposes. If this is the case, you can enable this option to preserve the original name values even in minified code.

      Default: false

    • getLoader

      @Stability(Stable) @Nullable default Map<String,String> getLoader()
      Use loaders to change how a given input file is interpreted.

      Configuring a loader for a given file type lets you load that file type with an import statement or a require call.

      For example, { '.png': 'dataurl' }.

      Default: - use esbuild default loaders

      See Also:

    • getLogLevel

      @Stability(Stable) @Nullable default LogLevel getLogLevel()
      Log level for esbuild.

      This is also propagated to the package manager and applies to its specific install command.

      Default: LogLevel.WARNING

    • getMainFields

      @Stability(Stable) @Nullable default List<String> getMainFields()
      How to determine the entry point for modules.

      Try ['module', 'main'] to default to ES module versions.

      Default: []

    • getMetafile

      @Stability(Stable) @Nullable default Boolean getMetafile()
      This option tells esbuild to write out a JSON file relative to output directory with metadata about the build.

      The metadata in this JSON file follows this schema (specified using TypeScript syntax): 

       {
   outputs: {
     [path: string]: {
       bytes: number
       inputs: {
         [path: string]: { bytesInOutput: number }
       }
       imports: { path: string }[]
       exports: string[]
     }
   }
 }

      This data can then be analyzed by other tools. For example, bundle buddy can consume esbuild's metadata format and generates a treemap visualization of the modules in your bundle and how much space each one takes up.

      Default: false

      See Also:

    • getMinify

      @Stability(Stable) @Nullable default Boolean getMinify()
      Whether to minify files when bundling.

      Default: false

    • getNodeModules

      @Stability(Stable) @Nullable default List<String> getNodeModules()
      A list of modules that should be installed instead of bundled.

      Modules are installed in a Lambda compatible environment only when bundling runs in Docker.

      Default: - all modules are bundled

    • getPreCompilation

      @Stability(Stable) @Nullable default Boolean getPreCompilation()
      Run compilation using tsc before running file through bundling step.

      This usually is not required unless you are using new experimental features that are only supported by typescript's tsc compiler. One example of such feature is emitDecoratorMetadata.

      Default: false

    • getSourceMap

      @Stability(Stable) @Nullable default Boolean getSourceMap()
      Whether to include source maps when bundling.

      Default: false

    • getSourceMapMode

      @Stability(Stable) @Nullable default SourceMapMode getSourceMapMode()
      Source map mode to be used when bundling.

      Default: SourceMapMode.DEFAULT

      See Also:

    • getSourcesContent

      @Stability(Stable) @Nullable default Boolean getSourcesContent()
      Whether to include original source code in source maps when bundling.

      Default: true

      See Also:

    • getTarget

      @Stability(Stable) @Nullable default String getTarget()
      Target environment for the generated JavaScript code.

      Default: - the node version of the runtime

      See Also:

    • getTsconfig

      @Stability(Stable) @Nullable default String getTsconfig()
      Normally the esbuild automatically discovers tsconfig.json files and reads their contents during a build.

      However, you can also configure a custom tsconfig.json file to use instead.

      This is similar to entry path, you need to provide path to your custom tsconfig.json.

      This can be useful if you need to do multiple builds of the same code with different settings.

      For example, { 'tsconfig': 'path/custom.tsconfig.json' }.

      Default: - automatically discovered by `esbuild`

    • builder

      @Stability(Stable) static BundlingOptions.Builder builder()
      Returns:
      a BundlingOptions.Builder of BundlingOptions