Package software.amazon.awscdk.services.batch

Interface CfnJobDefinition.VolumeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.VolumeProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

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

A data volume that's used in a job's container properties.

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.*;
 VolumeProperty volumeProperty = VolumeProperty.builder()
         .efsVolumeConfiguration(EFSVolumeConfigurationProperty.builder()
                 .fileSystemId("fileSystemId")
                 // the properties below are optional
                 .authorizationConfig(EFSAuthorizationConfigProperty.builder()
                         .accessPointId("accessPointId")
                         .iam("iam")
                         .build())
                 .rootDirectory("rootDirectory")
                 .transitEncryption("transitEncryption")
                 .transitEncryptionPort(123)
                 .build())
         .host(HostProperty.builder()
                 .sourcePath("sourcePath")
                 .build())
         .name("name")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobDefinition.VolumeProperty.Builder	builder()
default Object	getEfsVolumeConfiguration()	This parameter is specified 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's stored.
default String	getName()	The name of the volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEfsVolumeConfiguration

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

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

Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0 .

See Also:

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

getHost

@Stability(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's 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 that are associated with it stop running.

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

See Also:

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

getName

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

The name of the volume.

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

See Also:

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

builder

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

Returns:

a CfnJobDefinition.VolumeProperty.Builder of CfnJobDefinition.VolumeProperty