software.amazon.awscdk.services.batch

Interface CfnJobDefinition.VolumesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.VolumesProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(value=Stable)
public static interface CfnJobDefinition.VolumesProperty
extends software.amazon.jsii.JsiiSerializable

A list of volumes associated with the job.

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.*;
 VolumesProperty volumesProperty = VolumesProperty.builder()
         .efsVolumeConfiguration(EfsVolumeConfigurationProperty.builder()
                 .fileSystemId("fileSystemId")
                 // the properties below are optional
                 .authorizationConfig(AuthorizationConfigProperty.builder()
                         .accessPointId("accessPointId")
                         .iam("iam")
                         .build())
                 .rootDirectory("rootDirectory")
                 .transitEncryption("transitEncryption")
                 .transitEncryptionPort(123)
                 .build())
         .host(VolumesHostProperty.builder()
                 .sourcePath("sourcePath")
                 .build())
         .name("name")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnJobDefinition.VolumesProperty.Builder	builder()
default Object	getEfsVolumeConfiguration() This is used when you're using an Amazon Elastic File System file system for job storage.
default Object	getHost() The contents of the `host` parameter determine whether your data volume persists on the host container instance and where it is stored.
default String	getName() The name of the volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEfsVolumeConfiguration

@Stability(value=Stable)
 @Nullable
default Object getEfsVolumeConfiguration()

This is used when you're using an Amazon Elastic File System file system for job storage.

For more information, see Amazon EFS Volumes in the AWS Batch User Guide .

getHost

@Stability(value=Stable)
 @Nullable
default Object getHost()

The contents of the `host` parameter determine whether your data volume persists on the host container instance and where it is stored.

If the host 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 associated with it stop running.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

getName

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

The name of the volume.

It can be up to 255 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints .

builder

@Stability(value=Stable)
static CfnJobDefinition.VolumesProperty.Builder builder()

Returns:

a CfnJobDefinition.VolumesProperty.Builder of CfnJobDefinition.VolumesProperty