AWS::Batch::JobDefinition Volumes

A list of volumes that are associated with the job.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "EfsVolumeConfiguration" : EfsVolumeConfiguration,
  "Host" : VolumesHost,
  "Name" : String
}

YAML

  EfsVolumeConfiguration: 
    EfsVolumeConfiguration
  Host: 
    VolumesHost
  Name: String

Properties

EfsVolumeConfiguration

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.

Required: No

Type: EfsVolumeConfiguration

Update requires: No interruption

Host

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.

Note

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

Required: No

Type: VolumesHost

Update requires: No interruption

Name

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.

Required: No

Type: String

Update requires: No interruption