Package software.amazon.awscdk

Enum BundlingOutput

java.lang.Object

java.lang.Enum<BundlingOutput>

software.amazon.awscdk.BundlingOutput

All Implemented Interfaces:

Serializable, Comparable<BundlingOutput>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-11T23:26:27.390Z")
@Stability(Stable)
public enum BundlingOutput
extends Enum<BundlingOutput>

The type of output that a bundling operation is producing.

Example:

 import software.amazon.awscdk.*;
 Asset asset = Asset.Builder.create(this, "BundledAsset")
         .path("/path/to/asset")
         .bundling(BundlingOptions.builder()
                 .image(DockerImage.fromRegistry("alpine"))
                 .command(List.of("command-that-produces-an-archive.sh"))
                 .outputType(BundlingOutput.NOT_ARCHIVED)
                 .build())
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARCHIVED	The bundling output directory includes a single .zip or .jar file which will be used as the final bundle.
AUTO_DISCOVER	If the bundling output directory contains a single archive file (zip or jar) it will be used as the bundle output as-is.
NOT_ARCHIVED	The bundling output directory contains one or more files which will be archived and uploaded as a .zip file to S3.
SINGLE_FILE	The bundling output directory includes a single file which will be used as the final bundle.

Method Summary

Modifier and Type	Method	Description
static BundlingOutput	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BundlingOutput[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARCHIVED

@Stability(Stable)
public static final BundlingOutput ARCHIVED

The bundling output directory includes a single .zip or .jar file which will be used as the final bundle. If the output directory does not include exactly a single archive, bundling will fail.

NOT_ARCHIVED

@Stability(Stable)
public static final BundlingOutput NOT_ARCHIVED

The bundling output directory contains one or more files which will be archived and uploaded as a .zip file to S3.

AUTO_DISCOVER

@Stability(Stable)
public static final BundlingOutput AUTO_DISCOVER

If the bundling output directory contains a single archive file (zip or jar) it will be used as the bundle output as-is.

Otherwise, all the files in the bundling output directory will be zipped.

SINGLE_FILE

@Stability(Stable)
public static final BundlingOutput SINGLE_FILE

The bundling output directory includes a single file which will be used as the final bundle.

If the output directory does not include exactly a single file, bundling will fail.

Similar to ARCHIVED but for non-archive files

Method Details

values

public static BundlingOutput[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BundlingOutput valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null