Package software.amazon.awscdk.services.batch

Interface CfnJobDefinition.EksContainerVolumeMountProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.EksContainerVolumeMountProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

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

The volume mounts for a container for an Amazon EKS job.

For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation .

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.*;
 EksContainerVolumeMountProperty eksContainerVolumeMountProperty = EksContainerVolumeMountProperty.builder()
         .mountPath("mountPath")
         .name("name")
         .readOnly(false)
         .subPath("subPath")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobDefinition.EksContainerVolumeMountProperty.Builder	builder()
default String	getMountPath()	The path on the container where the volume is mounted.
default String	getName()	The name the volume mount.
default Object	getReadOnly()	If this value is true , the container has read-only access to the volume.
default String	getSubPath()	A sub-path inside the referenced volume instead of its root.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMountPath

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

The path on the container where the volume is mounted.

See Also:

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

getName

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

The name the volume mount.

This must match the name of one of the volumes in the pod.

See Also:

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

getReadOnly

@Stability(Stable)
@Nullable
default Object getReadOnly()

If this value is true , the container has read-only access to the volume.

Otherwise, the container can write to the volume. The default value is false .

Returns union: either Boolean or IResolvable

See Also:

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

getSubPath

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

A sub-path inside the referenced volume instead of its root.

See Also:

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

builder

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

Returns:

a CfnJobDefinition.EksContainerVolumeMountProperty.Builder of CfnJobDefinition.EksContainerVolumeMountProperty