Package software.amazon.awscdk

Class BundlingOptions.Builder

java.lang.Object

software.amazon.awscdk.BundlingOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BundlingOptions>

Enclosing interface:

BundlingOptions

@Stability(Stable)
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	build()	Builds the configured instance.
BundlingOptions.Builder	bundlingFileAccess(BundlingFileAccess bundlingFileAccess)	Sets the value of BundlingOptions.getBundlingFileAccess()
BundlingOptions.Builder	command(List<String> command)	Sets the value of BundlingOptions.getCommand()
BundlingOptions.Builder	entrypoint(List<String> entrypoint)	Sets the value of BundlingOptions.getEntrypoint()
BundlingOptions.Builder	environment(Map<String,String> environment)	Sets the value of BundlingOptions.getEnvironment()
BundlingOptions.Builder	image(DockerImage image)	Sets the value of BundlingOptions.getImage()
BundlingOptions.Builder	local(ILocalBundling local)	Sets the value of BundlingOptions.getLocal()
BundlingOptions.Builder	network(String network)	Sets the value of BundlingOptions.getNetwork()
BundlingOptions.Builder	outputType(BundlingOutput outputType)	Sets the value of BundlingOptions.getOutputType()
BundlingOptions.Builder	platform(String platform)	Sets the value of BundlingOptions.getPlatform()
BundlingOptions.Builder	securityOpt(String securityOpt)	Sets the value of BundlingOptions.getSecurityOpt()
BundlingOptions.Builder	user(String user)	Sets the value of BundlingOptions.getUser()
BundlingOptions.Builder	volumes(List<? extends DockerVolume> volumes)	Sets the value of BundlingOptions.getVolumes()
BundlingOptions.Builder	volumesFrom(List<String> volumesFrom)	Sets the value of BundlingOptions.getVolumesFrom()
BundlingOptions.Builder	workingDirectory(String workingDirectory)	Sets the value of BundlingOptions.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

image

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

Sets the value of BundlingOptions.getImage()

Parameters:

image - The Docker image where the command will run. This parameter is required.

Returns:

this

bundlingFileAccess

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

Sets the value of BundlingOptions.getBundlingFileAccess()

Parameters:

bundlingFileAccess - The access mechanism used to make source files available to the bundling container and to return the bundling output back to the host.

Returns:

this

command

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

Sets the value of BundlingOptions.getCommand()

Parameters:

command - The command to run in the Docker container. Example value: ['npm', 'install']

Returns:

this

entrypoint

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

Sets the value of BundlingOptions.getEntrypoint()

Parameters:

entrypoint - The entrypoint to run in the Docker container. Example value: ['/bin/sh', '-c']

Returns:

this

environment

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

Sets the value of BundlingOptions.getEnvironment()

Parameters:

environment - The environment variables to pass to the Docker container.

Returns:

this

local

@Stability(Stable)
public BundlingOptions.Builder local(ILocalBundling local)

Sets the value of BundlingOptions.getLocal()

Parameters:

local - Local bundling provider. The provider implements a method tryBundle() which should return true if local bundling was performed. If false is returned, docker bundling will be done.

Returns:

this

network

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

Sets the value of BundlingOptions.getNetwork()

Parameters:

network - Docker Networking options.

Returns:

this

outputType

@Stability(Stable)
public BundlingOptions.Builder outputType(BundlingOutput outputType)

Sets the value of BundlingOptions.getOutputType()

Parameters:

outputType - The type of output that this bundling operation is producing.

Returns:

this

platform

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

Sets the value of BundlingOptions.getPlatform()

Parameters:

platform - Platform to build for. Requires Docker Buildx. Specify this property to build images on a specific platform.

Returns:

this

securityOpt

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

Sets the value of BundlingOptions.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 BundlingOptions.getUser()

Parameters:

user - The user to use when running the Docker container. user | user:group | uid | uid:gid | user:gid | uid:group

Returns:

this

volumes

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

Sets the value of BundlingOptions.getVolumes()

Parameters:

volumes - Additional Docker volumes to mount.

Returns:

this

volumesFrom

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

Sets the value of BundlingOptions.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 BundlingOptions.getWorkingDirectory()

Parameters:

workingDirectory - Working directory inside the Docker container.

Returns:

this

build

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