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>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionautoprovision(Boolean autoprovision) autoprovision(IResolvable autoprovision) build()Builds the configured instance.driverOpts(Map<String, String> driverOpts) driverOpts(IResolvable driverOpts) labels(IResolvable labels) Sets the value ofCfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getScope()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
autoprovision
@Stability(Stable) public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder autoprovision(Boolean autoprovision) - Parameters:
autoprovision- If this value istrue, the Docker volume is created if it doesn't already exist.This field is only used if the
scopeisshared.- Returns:
this
-
autoprovision
@Stability(Stable) public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder autoprovision(IResolvable autoprovision) - Parameters:
autoprovision- If this value istrue, the Docker volume is created if it doesn't already exist.This field is only used if the
scopeisshared.- Returns:
this
-
driver
@Stability(Stable) public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder driver(String driver) - 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, usedocker plugin lsto 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 toDriverin the docker container create command and thexxdriveroption to docker volume create.- Returns:
this
-
driverOpts
@Stability(Stable) public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder driverOpts(Map<String, String> driverOpts) - Parameters:
driverOpts- A map of Docker driver-specific options passed through. This parameter maps toDriverOptsin the docker create-volume command and thexxoptoption to docker volume create.- Returns:
this
-
driverOpts
@Stability(Stable) public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder driverOpts(IResolvable driverOpts) - Parameters:
driverOpts- A map of Docker driver-specific options passed through. This parameter maps toDriverOptsin the docker create-volume command and thexxoptoption to docker volume create.- Returns:
this
-
labels
@Stability(Stable) public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder labels(Map<String, String> labels) - Parameters:
labels- Custom metadata to add to your Docker volume. This parameter maps toLabelsin the docker container create command and thexxlabeloption to docker volume create.- Returns:
this
-
labels
@Stability(Stable) public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder labels(IResolvable labels) - Parameters:
labels- Custom metadata to add to your Docker volume. This parameter maps toLabelsin the docker container create command and thexxlabeloption to docker volume create.- Returns:
this
-
scope
@Stability(Stable) public CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.Builder scope(String scope) Sets the value ofCfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty.getScope()- Parameters:
scope- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to ataskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty>- Returns:
- a new instance of
CfnTaskDefinitionPropsMixin.DockerVolumeConfigurationProperty - Throws:
NullPointerException- if any required attribute was not provided
-