Package software.amazon.awscdk.services.lambda.python.alpha

Class BundlingOptions.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.python.alpha.BundlingOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BundlingOptions>

Enclosing interface:

BundlingOptions

@Stability(Experimental)
public static final class BundlingOptions.Builder
extends Object
implements software.amazon.jsii.Builder<BundlingOptions>

A builder for BundlingOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BundlingOptions.Builder	assetExcludes(List<String> assetExcludes)	Sets the value of BundlingOptions.getAssetExcludes()
BundlingOptions.Builder	assetHash(String assetHash)	Sets the value of BundlingOptions.getAssetHash()
BundlingOptions.Builder	assetHashType(AssetHashType assetHashType)	Sets the value of BundlingOptions.getAssetHashType()
BundlingOptions	build()	Builds the configured instance.
BundlingOptions.Builder	buildArgs(Map<String,String> buildArgs)	Sets the value of BundlingOptions.getBuildArgs()
BundlingOptions.Builder	bundlingFileAccess(BundlingFileAccess bundlingFileAccess)	Sets the value of BundlingOptions.getBundlingFileAccess()
BundlingOptions.Builder	command(List<String> command)	Sets the value of DockerRunOptions.getCommand()
BundlingOptions.Builder	commandHooks(ICommandHooks commandHooks)	Sets the value of BundlingOptions.getCommandHooks()
BundlingOptions.Builder	entrypoint(List<String> entrypoint)	Sets the value of DockerRunOptions.getEntrypoint()
BundlingOptions.Builder	environment(Map<String,String> environment)	Sets the value of DockerRunOptions.getEnvironment()
BundlingOptions.Builder	image(DockerImage image)	Sets the value of BundlingOptions.getImage()
BundlingOptions.Builder	network(String network)	Sets the value of DockerRunOptions.getNetwork()
BundlingOptions.Builder	outputPathSuffix(String outputPathSuffix)	Sets the value of BundlingOptions.getOutputPathSuffix()
BundlingOptions.Builder	platform(String platform)	Sets the value of DockerRunOptions.getPlatform()
BundlingOptions.Builder	poetryIncludeHashes(Boolean poetryIncludeHashes)	Sets the value of BundlingOptions.getPoetryIncludeHashes()
BundlingOptions.Builder	poetryWithoutUrls(Boolean poetryWithoutUrls)	Sets the value of BundlingOptions.getPoetryWithoutUrls()
BundlingOptions.Builder	securityOpt(String securityOpt)	Sets the value of DockerRunOptions.getSecurityOpt()
BundlingOptions.Builder	user(String user)	Sets the value of DockerRunOptions.getUser()
BundlingOptions.Builder	volumes(List<? extends DockerVolume> volumes)	Sets the value of DockerRunOptions.getVolumes()
BundlingOptions.Builder	volumesFrom(List<String> volumesFrom)	Sets the value of DockerRunOptions.getVolumesFrom()
BundlingOptions.Builder	workingDirectory(String workingDirectory)	Sets the value of DockerRunOptions.getWorkingDirectory()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

assetExcludes

@Stability(Experimental)
public BundlingOptions.Builder assetExcludes(List<String> assetExcludes)

Sets the value of BundlingOptions.getAssetExcludes()

Parameters:

assetExcludes - List of file patterns to exclude when copying assets from source for bundling.

Returns:

this

assetHash

@Stability(Experimental)
public BundlingOptions.Builder assetHash(String assetHash)

Sets the value of BundlingOptions.getAssetHash()

Parameters:

assetHash - Specify a custom hash for this asset. If assetHashType is set it must be set to AssetHashType.CUSTOM. 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.

Returns:

this

assetHashType

@Stability(Experimental)
public BundlingOptions.Builder assetHashType(AssetHashType assetHashType)

Sets the value of BundlingOptions.getAssetHashType()

Parameters:

assetHashType - Determines how asset hash is calculated. Assets will get rebuild and uploaded only if their hash has changed. If asset hash is set to SOURCE (default), then only changes to the source directory will cause the asset to rebuild. This means, for example, that in order to pick up a new dependency version, a change must be made to the source tree. Ideally, this can be implemented by including a dependency lockfile in your source tree or using fixed dependencies.

If the asset hash is set to OUTPUT, the hash is calculated after bundling. This means that any change in the output will cause the asset to be invalidated and uploaded. Bear in mind that pip adds timestamps to dependencies it installs, which implies that in this mode Python bundles will always get rebuild and uploaded. Normally this is an anti-pattern since build

Returns:

this

buildArgs

@Stability(Experimental)
public BundlingOptions.Builder buildArgs(Map<String,String> buildArgs)

Sets the value of BundlingOptions.getBuildArgs()

Parameters:

buildArgs - Optional build arguments to pass to the default container. This can be used to customize the index URLs used for installing dependencies. This is not used if a custom image is provided.

Returns:

this

bundlingFileAccess

@Stability(Experimental)
public BundlingOptions.Builder bundlingFileAccess(BundlingFileAccess bundlingFileAccess)

Sets the value of BundlingOptions.getBundlingFileAccess()

Parameters:

bundlingFileAccess - Which option to use to copy the source files to the docker container and output files back.

Returns:

this

commandHooks

@Stability(Experimental)
public BundlingOptions.Builder commandHooks(ICommandHooks commandHooks)

Sets the value of BundlingOptions.getCommandHooks()

Parameters:

commandHooks - Command hooks.

Returns:

this

image

@Stability(Experimental)
public BundlingOptions.Builder image(DockerImage image)

Sets the value of BundlingOptions.getImage()

Parameters:

image - Docker image to use for bundling. If no options are provided, the default bundling image will be used. Dependencies will be installed using the default packaging commands and copied over from into the Lambda asset.

Returns:

this

outputPathSuffix

@Stability(Experimental)
public BundlingOptions.Builder outputPathSuffix(String outputPathSuffix)

Sets the value of BundlingOptions.getOutputPathSuffix()

Parameters:

outputPathSuffix - Output path suffix: the suffix for the directory into which the bundled output is written.

Returns:

this

poetryIncludeHashes

@Stability(Experimental)
public BundlingOptions.Builder poetryIncludeHashes(Boolean poetryIncludeHashes)

Sets the value of BundlingOptions.getPoetryIncludeHashes()

Parameters:

poetryIncludeHashes - Whether to export Poetry dependencies with hashes. Note that this can cause builds to fail if not all dependencies export with a hash.

Returns:

this

poetryWithoutUrls

@Stability(Experimental)
public BundlingOptions.Builder poetryWithoutUrls(Boolean poetryWithoutUrls)

Sets the value of BundlingOptions.getPoetryWithoutUrls()

Parameters:

poetryWithoutUrls - Whether to export Poetry dependencies with source repository urls.

Returns:

this

command

@Stability(Stable)
public BundlingOptions.Builder command(List<String> command)

Sets the value of DockerRunOptions.getCommand()

Parameters:

command - The command to run in the container.

Returns:

this

entrypoint

@Stability(Stable)
public BundlingOptions.Builder entrypoint(List<String> entrypoint)

Sets the value of DockerRunOptions.getEntrypoint()

Parameters:

entrypoint - The entrypoint to run in the container.

Returns:

this

environment

@Stability(Stable)
public BundlingOptions.Builder environment(Map<String,String> environment)

Sets the value of DockerRunOptions.getEnvironment()

Parameters:

environment - The environment variables to pass to the container.

Returns:

this

network

@Stability(Stable)
public BundlingOptions.Builder network(String network)

Sets the value of DockerRunOptions.getNetwork()

Parameters:

network - Docker Networking options.

Returns:

this

platform

@Stability(Stable)
public BundlingOptions.Builder platform(String platform)

Sets the value of DockerRunOptions.getPlatform()

Parameters:

platform - Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+. Example value: linux/amd64

Returns:

this

securityOpt

@Stability(Stable)
public BundlingOptions.Builder securityOpt(String securityOpt)

Sets the value of DockerRunOptions.getSecurityOpt()

Parameters:

securityOpt - Security configuration when running the docker container.

Returns:

this

user

@Stability(Stable)
public BundlingOptions.Builder user(String user)

Sets the value of DockerRunOptions.getUser()

Parameters:

user - The user to use when running the container.

Returns:

this

volumes

@Stability(Stable)
public BundlingOptions.Builder volumes(List<? extends DockerVolume> volumes)

Sets the value of DockerRunOptions.getVolumes()

Parameters:

volumes - Docker volumes to mount.

Returns:

this

volumesFrom

@Stability(Stable)
public BundlingOptions.Builder volumesFrom(List<String> volumesFrom)

Sets the value of DockerRunOptions.getVolumesFrom()

Parameters:

volumesFrom - Where to mount the specified volumes from.

Returns:

this

workingDirectory

@Stability(Stable)
public BundlingOptions.Builder workingDirectory(String workingDirectory)

Sets the value of DockerRunOptions.getWorkingDirectory()

Parameters:

workingDirectory - Working directory inside the container.

Returns:

this

build

@Stability(Experimental)
public BundlingOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BundlingOptions>

Returns:

a new instance of BundlingOptions

Throws:

NullPointerException - if any required attribute was not provided