Package software.amazon.awscdk.services.batch

Interface CfnJobDefinition.VolumesHostProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.VolumesHostProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(Stable)
public static interface CfnJobDefinition.VolumesHostProperty
extends software.amazon.jsii.JsiiSerializable

Determine whether your data volume persists on the host container instance and where it's stored.

If this 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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 VolumesHostProperty volumesHostProperty = VolumesHostProperty.builder()
         .sourcePath("sourcePath")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumeshost.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJobDefinition.VolumesHostProperty.Builder	A builder for CfnJobDefinition.VolumesHostProperty
static final class	CfnJobDefinition.VolumesHostProperty.Jsii$Proxy	An implementation for CfnJobDefinition.VolumesHostProperty

Method Summary

Modifier and Type	Method	Description
static CfnJobDefinition.VolumesHostProperty.Builder	builder()
default String	getSourcePath()	The path on the host container instance that's presented to the container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSourcePath

@Stability(Stable)
@Nullable
default String getSourcePath()

The path on the host container instance that's presented to the container.

If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumeshost.html#cfn-batch-jobdefinition-volumeshost-sourcepath

builder

@Stability(Stable)
static CfnJobDefinition.VolumesHostProperty.Builder builder()

Returns:

a CfnJobDefinition.VolumesHostProperty.Builder of CfnJobDefinition.VolumesHostProperty