Class CfnJobDefinition.VolumesProperty.Builder
java.lang.Object
software.amazon.awscdk.services.batch.CfnJobDefinition.VolumesProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnJobDefinition.VolumesProperty>
- Enclosing interface:
- CfnJobDefinition.VolumesProperty
@Stability(Stable)
public static final class CfnJobDefinition.VolumesProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnJobDefinition.VolumesProperty>
A builder for
CfnJobDefinition.VolumesProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.efsVolumeConfiguration
(IResolvable efsVolumeConfiguration) Sets the value ofCfnJobDefinition.VolumesProperty.getEfsVolumeConfiguration()
efsVolumeConfiguration
(CfnJobDefinition.EfsVolumeConfigurationProperty efsVolumeConfiguration) Sets the value ofCfnJobDefinition.VolumesProperty.getEfsVolumeConfiguration()
host
(IResolvable host) Sets the value ofCfnJobDefinition.VolumesProperty.getHost()
Sets the value ofCfnJobDefinition.VolumesProperty.getHost()
Sets the value ofCfnJobDefinition.VolumesProperty.getName()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
efsVolumeConfiguration
@Stability(Stable) public CfnJobDefinition.VolumesProperty.Builder efsVolumeConfiguration(IResolvable efsVolumeConfiguration) Sets the value ofCfnJobDefinition.VolumesProperty.getEfsVolumeConfiguration()
- Parameters:
efsVolumeConfiguration
- This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the AWS Batch User Guide .- Returns:
this
-
efsVolumeConfiguration
@Stability(Stable) public CfnJobDefinition.VolumesProperty.Builder efsVolumeConfiguration(CfnJobDefinition.EfsVolumeConfigurationProperty efsVolumeConfiguration) Sets the value ofCfnJobDefinition.VolumesProperty.getEfsVolumeConfiguration()
- Parameters:
efsVolumeConfiguration
- This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the AWS Batch User Guide .- Returns:
this
-
host
Sets the value ofCfnJobDefinition.VolumesProperty.getHost()
- Parameters:
host
- The contents of thehost
parameter determine whether your data volume persists on the host container instance and where it's stored. If the host 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.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
- Returns:
this
-
host
@Stability(Stable) public CfnJobDefinition.VolumesProperty.Builder host(CfnJobDefinition.VolumesHostProperty host) Sets the value ofCfnJobDefinition.VolumesProperty.getHost()
- Parameters:
host
- The contents of thehost
parameter determine whether your data volume persists on the host container instance and where it's stored. If the host 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.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
- Returns:
this
-
name
Sets the value ofCfnJobDefinition.VolumesProperty.getName()
- Parameters:
name
- The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). 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<CfnJobDefinition.VolumesProperty>
- Returns:
- a new instance of
CfnJobDefinition.VolumesProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-