Class CfnTaskDefinition.VolumeProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTaskDefinition.VolumeProperty>
- Enclosing interface:
- CfnTaskDefinition.VolumeProperty
CfnTaskDefinition.VolumeProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.dockerVolumeConfiguration
(IResolvable dockerVolumeConfiguration) Sets the value ofCfnTaskDefinition.VolumeProperty.getDockerVolumeConfiguration()
dockerVolumeConfiguration
(CfnTaskDefinition.DockerVolumeConfigurationProperty dockerVolumeConfiguration) Sets the value ofCfnTaskDefinition.VolumeProperty.getDockerVolumeConfiguration()
efsVolumeConfiguration
(IResolvable efsVolumeConfiguration) Sets the value ofCfnTaskDefinition.VolumeProperty.getEfsVolumeConfiguration()
efsVolumeConfiguration
(CfnTaskDefinition.EFSVolumeConfigurationProperty efsVolumeConfiguration) Sets the value ofCfnTaskDefinition.VolumeProperty.getEfsVolumeConfiguration()
host
(IResolvable host) Sets the value ofCfnTaskDefinition.VolumeProperty.getHost()
Sets the value ofCfnTaskDefinition.VolumeProperty.getHost()
Sets the value ofCfnTaskDefinition.VolumeProperty.getName()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
dockerVolumeConfiguration
@Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder dockerVolumeConfiguration(IResolvable dockerVolumeConfiguration) Sets the value ofCfnTaskDefinition.VolumeProperty.getDockerVolumeConfiguration()
- Parameters:
dockerVolumeConfiguration
- This parameter is specified when you use Docker volumes. Windows containers only support the use of thelocal
driver. To use bind mounts, specify thehost
parameter instead.Docker volumes aren't supported by tasks run on AWS Fargate .
- Returns:
this
-
dockerVolumeConfiguration
@Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder dockerVolumeConfiguration(CfnTaskDefinition.DockerVolumeConfigurationProperty dockerVolumeConfiguration) Sets the value ofCfnTaskDefinition.VolumeProperty.getDockerVolumeConfiguration()
- Parameters:
dockerVolumeConfiguration
- This parameter is specified when you use Docker volumes. Windows containers only support the use of thelocal
driver. To use bind mounts, specify thehost
parameter instead.Docker volumes aren't supported by tasks run on AWS Fargate .
- Returns:
this
-
efsVolumeConfiguration
@Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder efsVolumeConfiguration(IResolvable efsVolumeConfiguration) Sets the value ofCfnTaskDefinition.VolumeProperty.getEfsVolumeConfiguration()
- Parameters:
efsVolumeConfiguration
- This parameter is specified when you use an Amazon Elastic File System file system for task storage.- Returns:
this
-
efsVolumeConfiguration
@Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder efsVolumeConfiguration(CfnTaskDefinition.EFSVolumeConfigurationProperty efsVolumeConfiguration) Sets the value ofCfnTaskDefinition.VolumeProperty.getEfsVolumeConfiguration()
- Parameters:
efsVolumeConfiguration
- This parameter is specified when you use an Amazon Elastic File System file system for task storage.- Returns:
this
-
host
Sets the value ofCfnTaskDefinition.VolumeProperty.getHost()
- Parameters:
host
- This parameter is specified when you use bind mount host volumes. The contents of thehost
parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehost
parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\path
andD:\:D:\
, but notD:\my\path:C:\my\path
orD:\:C:\my\path
.- Returns:
this
-
host
@Stability(Stable) public CfnTaskDefinition.VolumeProperty.Builder host(CfnTaskDefinition.HostVolumePropertiesProperty host) Sets the value ofCfnTaskDefinition.VolumeProperty.getHost()
- Parameters:
host
- This parameter is specified when you use bind mount host volumes. The contents of thehost
parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehost
parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\path
andD:\:D:\
, but notD:\my\path:C:\my\path
orD:\:C:\my\path
.- Returns:
this
-
name
Sets the value ofCfnTaskDefinition.VolumeProperty.getName()
- Parameters:
name
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in thesourceVolume
parameter of container definitionmountPoints
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnTaskDefinition.VolumeProperty>
- Returns:
- a new instance of
CfnTaskDefinition.VolumeProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-