Package software.amazon.awscdk.services.batch

Interface HostVolumeOptions

All Superinterfaces:

EcsVolumeOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HostVolumeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:35.269Z")
@Stability(Stable)
public interface HostVolumeOptions
extends software.amazon.jsii.JsiiSerializable, EcsVolumeOptions

Options for configuring an ECS HostVolume.

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.*;
 HostVolumeOptions hostVolumeOptions = HostVolumeOptions.builder()
         .containerPath("containerPath")
         .name("name")
         // the properties below are optional
         .hostPath("hostPath")
         .readonly(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HostVolumeOptions.Builder	builder()
default String	getHostPath()	The path on the host machine this container will have access to.

Methods inherited from interface software.amazon.awscdk.services.batch.EcsVolumeOptions

getContainerPath, getName, getReadonly

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHostPath

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

The path on the host machine this container will have access to.

Default: - Docker will choose the host path. The data may not persist after the containers that use it stop running.

builder

@Stability(Stable)
static HostVolumeOptions.Builder builder()

Returns:

a HostVolumeOptions.Builder of HostVolumeOptions