software.amazon.awscdk.services.ecs

Class CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTaskDefinition.DockerVolumeConfigurationProperty>

Enclosing interface:

CfnTaskDefinition.DockerVolumeConfigurationProperty

@Stability(value=Stable)
public static final class CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTaskDefinition.DockerVolumeConfigurationProperty>

A builder for CfnTaskDefinition.DockerVolumeConfigurationProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

autoprovision

@Stability(value=Stable)
public CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder autoprovision(Boolean autoprovision)

Sets the value of CfnTaskDefinition.DockerVolumeConfigurationProperty.getAutoprovision()

Parameters:

autoprovision - If this value is `true` , the Docker volume is created if it doesn't already exist.

This field is only used if the scope is shared .

Returns:

this

autoprovision

@Stability(value=Stable)
public CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder autoprovision(IResolvable autoprovision)

Sets the value of CfnTaskDefinition.DockerVolumeConfigurationProperty.getAutoprovision()

Parameters:

autoprovision - If this value is `true` , the Docker volume is created if it doesn't already exist.

This field is only used if the scope is shared .

Returns:

this

driver

@Stability(value=Stable)
public CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder driver(String driver)

Sets the value of CfnTaskDefinition.DockerVolumeConfigurationProperty.getDriver()

Parameters:

driver - The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery . This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create .

Returns:

this

driverOpts

@Stability(value=Stable)
public CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder driverOpts(IResolvable driverOpts)

Sets the value of CfnTaskDefinition.DockerVolumeConfigurationProperty.getDriverOpts()

Parameters:

driverOpts - A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create .

Returns:

this

driverOpts

@Stability(value=Stable)
public CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder driverOpts(Map<String,String> driverOpts)

Sets the value of CfnTaskDefinition.DockerVolumeConfigurationProperty.getDriverOpts()

Parameters:

driverOpts - A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create .

Returns:

this

labels

@Stability(value=Stable)
public CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder labels(IResolvable labels)

Sets the value of CfnTaskDefinition.DockerVolumeConfigurationProperty.getLabels()

Parameters:

labels - Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create .

Returns:

this

labels

@Stability(value=Stable)
public CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder labels(Map<String,String> labels)

Sets the value of CfnTaskDefinition.DockerVolumeConfigurationProperty.getLabels()

Parameters:

labels - Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create .

Returns:

this

scope

@Stability(value=Stable)
public CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder scope(String scope)

Sets the value of CfnTaskDefinition.DockerVolumeConfigurationProperty.getScope()

Parameters:

scope - The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

Returns:

this

build

@Stability(value=Stable)
public CfnTaskDefinition.DockerVolumeConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnTaskDefinition.DockerVolumeConfigurationProperty>

Returns:

a new instance of CfnTaskDefinition.DockerVolumeConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided