Package software.amazon.awscdk.cfnpropertymixins.services.ecs

Class CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ecs.CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty

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

A builder for CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder	autoprovision(Boolean autoprovision)	Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getAutoprovision()
CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder	autoprovision(IResolvable autoprovision)	Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getAutoprovision()
CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty	build()	Builds the configured instance.
CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder	driver(String driver)	Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getDriver()
CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder	driverOpts(Map<String,String> driverOpts)	Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getDriverOpts()
CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder	driverOpts(IResolvable driverOpts)	Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getDriverOpts()
CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder	labels(Map<String,String> labels)	Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getLabels()
CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder	labels(IResolvable labels)	Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getLabels()
CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder	scope(String scope)	Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.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

autoprovision

@Stability(Stable)
public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder autoprovision(Boolean autoprovision)

Sets the value of CfnTaskDefinitionPropsMixin.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(Stable)
public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder autoprovision(IResolvable autoprovision)

Sets the value of CfnTaskDefinitionPropsMixin.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(Stable)
public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder driver(String driver)

Sets the value of CfnTaskDefinitionPropsMixin.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. This parameter maps to Driver in the docker container create command and the xxdriver option to docker volume create.

Returns:

this

driverOpts

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

Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getDriverOpts()

Parameters:

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

Returns:

this

driverOpts

@Stability(Stable)
public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder driverOpts(IResolvable driverOpts)

Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getDriverOpts()

Parameters:

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

Returns:

this

labels

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

Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getLabels()

Parameters:

labels - Custom metadata to add to your Docker volume. This parameter maps to Labels in the docker container create command and the xxlabel option to docker volume create.

Returns:

this

labels

@Stability(Stable)
public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder labels(IResolvable labels)

Sets the value of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getLabels()

Parameters:

labels - Custom metadata to add to your Docker volume. This parameter maps to Labels in the docker container create command and the xxlabel option to docker volume create.

Returns:

this

scope

@Stability(Stable)
public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder scope(String scope)

Sets the value of CfnTaskDefinitionPropsMixin.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(Stable)
public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided