Package software.amazon.awscdk.services.batch

Interface EksVolumeOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

EmptyDirVolumeOptions, HostPathVolumeOptions, SecretPathVolumeOptions

All Known Implementing Classes:

EksVolumeOptions.Jsii$Proxy, EmptyDirVolumeOptions.Jsii$Proxy, HostPathVolumeOptions.Jsii$Proxy, SecretPathVolumeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:03.387Z")
@Stability(Stable)
public interface EksVolumeOptions
extends software.amazon.jsii.JsiiSerializable

Options to configure an EksVolume.

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.*;
 EksVolumeOptions eksVolumeOptions = EksVolumeOptions.builder()
         .name("name")
         // the properties below are optional
         .mountPath("mountPath")
         .readonly(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EksVolumeOptions.Builder	builder()
default String	getMountPath()	The path on the container where the volume is mounted.
String	getName()	The name of this volume.
default Boolean	getReadonly()	If specified, the container has readonly access to the volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of this volume.

The name must be a valid DNS subdomain name.

See Also:

• https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names

getMountPath

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

The path on the container where the volume is mounted.

Default: - the volume is not mounted

getReadonly

@Stability(Stable)
@Nullable
default Boolean getReadonly()

If specified, the container has readonly access to the volume.

Otherwise, the container has read/write access.

Default: false

builder

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

Returns:

a EksVolumeOptions.Builder of EksVolumeOptions