Package software.amazon.awscdk.services.ecs

Class DockerVolumeConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.DockerVolumeConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerVolumeConfiguration>

Enclosing interface:

DockerVolumeConfiguration

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

A builder for DockerVolumeConfiguration

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DockerVolumeConfiguration.Builder	autoprovision(Boolean autoprovision)	Sets the value of DockerVolumeConfiguration.getAutoprovision()
DockerVolumeConfiguration	build()	Builds the configured instance.
DockerVolumeConfiguration.Builder	driver(String driver)	Sets the value of DockerVolumeConfiguration.getDriver()
DockerVolumeConfiguration.Builder	driverOpts(Map<String,String> driverOpts)	Sets the value of DockerVolumeConfiguration.getDriverOpts()
DockerVolumeConfiguration.Builder	labels(Map<String,String> labels)	Sets the value of DockerVolumeConfiguration.getLabels()
DockerVolumeConfiguration.Builder	scope(Scope scope)	Sets the value of DockerVolumeConfiguration.getScope()

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

driver

@Stability(Stable)
public DockerVolumeConfiguration.Builder driver(String driver)

Sets the value of DockerVolumeConfiguration.getDriver()

Parameters:

driver - The Docker volume driver to use. This parameter is required.

Returns:

this

scope

@Stability(Stable)
public DockerVolumeConfiguration.Builder scope(Scope scope)

Sets the value of DockerVolumeConfiguration.getScope()

Parameters:

scope - The scope for the Docker volume that determines its lifecycle. This parameter is required.

Returns:

this

autoprovision

@Stability(Stable)
public DockerVolumeConfiguration.Builder autoprovision(Boolean autoprovision)

Sets the value of DockerVolumeConfiguration.getAutoprovision()

Parameters:

autoprovision - Specifies whether the Docker volume should be created if it does not already exist. If true is specified, the Docker volume will be created for you.

Returns:

this

driverOpts

@Stability(Stable)
public DockerVolumeConfiguration.Builder driverOpts(Map<String,String> driverOpts)

Sets the value of DockerVolumeConfiguration.getDriverOpts()

Parameters:

driverOpts - A map of Docker driver-specific options passed through.

Returns:

this

labels

@Stability(Stable)
public DockerVolumeConfiguration.Builder labels(Map<String,String> labels)

Sets the value of DockerVolumeConfiguration.getLabels()

Parameters:

labels - Custom metadata to add to your Docker volume.

Returns:

this

build

@Stability(Stable)
public DockerVolumeConfiguration build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DockerVolumeConfiguration

Throws:

NullPointerException - if any required attribute was not provided