Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Batch.Types.Volume

Description

Synopsis

data Volume = Volume' {
- efsVolumeConfiguration :: Maybe EFSVolumeConfiguration
- host :: Maybe Host
- name :: Maybe Text
}
newVolume :: Volume
volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration)
volume_host :: Lens' Volume (Maybe Host)
volume_name :: Lens' Volume (Maybe Text)

Documentation

data Volume Source #

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

See: newVolume smart constructor.

Constructors

Volume'

Fields

efsVolumeConfiguration :: Maybe 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 :: Maybe 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 :: Maybe Text
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.

Instances

Instances details

FromJSON Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods parseJSON :: Value -> Parser Volume # parseJSONList :: Value -> Parser [Volume] #
ToJSON Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods toJSON :: Volume -> Value # toEncoding :: Volume -> Encoding # toJSONList :: [Volume] -> Value # toEncodingList :: [Volume] -> Encoding #
Generic Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Associated Types type Rep Volume :: Type -> Type # Methods from :: Volume -> Rep Volume x # to :: Rep Volume x -> Volume #
Read Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods readsPrec :: Int -> ReadS Volume # readList :: ReadS [Volume] # readPrec :: ReadPrec Volume # readListPrec :: ReadPrec [Volume] #
Show Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods showsPrec :: Int -> Volume -> ShowS # show :: Volume -> String # showList :: [Volume] -> ShowS #
NFData Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods rnf :: Volume -> () #
Eq Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods (==) :: Volume -> Volume -> Bool # (/=) :: Volume -> Volume -> Bool #
Hashable Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods hashWithSalt :: Int -> Volume -> Int # hash :: Volume -> Int #
type Rep Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume type Rep Volume = D1 ('MetaData "Volume" "Amazonka.Batch.Types.Volume" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Volume'" 'PrefixI 'True) (S1 ('MetaSel ('Just "efsVolumeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSVolumeConfiguration)) :: (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Host)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newVolume :: Volume Source #

Create a value of Volume with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:efsVolumeConfiguration:Volume', volume_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.

$sel:host:Volume', volume_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.

$sel:name:Volume', volume_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.

volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration) Source #

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.

volume_host :: Lens' Volume (Maybe Host) Source #

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.

volume_name :: Lens' Volume (Maybe Text) Source #

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.