Package software.amazon.awscdk.services.batch

Interface CfnJobDefinition.EksVolumeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.EksVolumeProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

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

Specifies an Amazon EKS volume for a job definition.

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.*;
 EksVolumeProperty eksVolumeProperty = EksVolumeProperty.builder()
         .name("name")
         // the properties below are optional
         .emptyDir(EmptyDirProperty.builder()
                 .medium("medium")
                 .sizeLimit("sizeLimit")
                 .build())
         .hostPath(HostPathProperty.builder()
                 .path("path")
                 .build())
         .persistentVolumeClaim(EksPersistentVolumeClaimProperty.builder()
                 .claimName("claimName")
                 // the properties below are optional
                 .readOnly(false)
                 .build())
         .secret(EksSecretProperty.builder()
                 .secretName("secretName")
                 // the properties below are optional
                 .optional(false)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobDefinition.EksVolumeProperty.Builder	builder()
default Object	getEmptyDir()	Specifies the configuration of a Kubernetes emptyDir volume.
default Object	getHostPath()	Specifies the configuration of a Kubernetes hostPath volume.
String	getName()	The name of the volume.
default Object	getPersistentVolumeClaim()	Specifies the configuration of a Kubernetes persistentVolumeClaim bounded to a persistentVolume .
default Object	getSecret()	Specifies the configuration of a Kubernetes secret volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the volume.

The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation .

See Also:

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

getEmptyDir

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

Specifies the configuration of a Kubernetes emptyDir volume.

For more information, see emptyDir in the Kubernetes documentation .

Returns union: either IResolvable or CfnJobDefinition.EmptyDirProperty

See Also:

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

getHostPath

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

Specifies the configuration of a Kubernetes hostPath volume.

For more information, see hostPath in the Kubernetes documentation .

Returns union: either IResolvable or CfnJobDefinition.HostPathProperty

See Also:

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

getPersistentVolumeClaim

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

Specifies the configuration of a Kubernetes persistentVolumeClaim bounded to a persistentVolume .

For more information, see Persistent Volume Claims in the Kubernetes documentation .

Returns union: either IResolvable or CfnJobDefinition.EksPersistentVolumeClaimProperty

See Also:

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

getSecret

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

Specifies the configuration of a Kubernetes secret volume.

For more information, see secret in the Kubernetes documentation .

Returns union: either IResolvable or CfnJobDefinition.EksSecretProperty

See Also:

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

builder

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

Returns:

a CfnJobDefinition.EksVolumeProperty.Builder of CfnJobDefinition.EksVolumeProperty