Skip to content

Volume

Source code in docs_src/capo_batch/types/volume.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class Volume(TypedDict, closed=True):
    host: NotRequired["capo_batch.types.host.Host"]
    """<p>The contents of the <code>host</code> 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.</p> <note> <p>This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.</p> </note>"""
    name: NotRequired["capo_batch.types.string.String"]
    """<p>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 <code>sourceVolume</code> parameter of container definition <code>mountPoints</code>.</p>"""
    efs_volume_configuration: NotRequired[
        "capo_batch.types.efs_volume_configuration.EFSVolumeConfiguration"
    ]
    """<p>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 <code>platformVersion</code> of at least <code>1.4.0</code>.</p>"""
    s3files_volume_configuration: NotRequired[
        "capo_batch.types.s3_files_volume_configuration.S3FilesVolumeConfiguration"
    ]
    """<p>This parameter is specified when you're using an S3Files file system for job storage.</p>"""

efs_volume_configuration instance-attribute 

efs_volume_configuration: NotRequired[EFSVolumeConfiguration]

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.

host instance-attribute 

host: NotRequired[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.

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

name instance-attribute 

name: NotRequired[String]

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.

s3files_volume_configuration instance-attribute 

s3files_volume_configuration: NotRequired[S3FilesVolumeConfiguration]

This parameter is specified when you're using an S3Files file system for job storage.