Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Batch.Types.Volume

Description

Synopsis

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

Documentation

data Volume Source #

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

See: newVolume smart constructor.

Constructors

Volume'

Fields

name :: Maybe Text
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
efsVolumeConfiguration :: Maybe EFSVolumeConfiguration
This parameter is specified when you are 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 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.

Instances

Instances details

Eq Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods (==) :: Volume -> Volume -> Bool # (/=) :: Volume -> Volume -> Bool #
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 #
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 #
NFData Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods rnf :: Volume -> () #
Hashable Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods hashWithSalt :: Int -> Volume -> Int # hash :: Volume -> Int #
ToJSON Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods toJSON :: Volume -> Value # toEncoding :: Volume -> Encoding # toJSONList :: [Volume] -> Value # toEncodingList :: [Volume] -> Encoding #
FromJSON Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume Methods parseJSON :: Value -> Parser Volume # parseJSONList :: Value -> Parser [Volume] #
type Rep Volume Source #
Instance details Defined in Amazonka.Batch.Types.Volume type Rep Volume = D1 ('MetaData "Volume" "Amazonka.Batch.Types.Volume" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "Volume'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "efsVolumeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSVolumeConfiguration)) :: S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Host)))))

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:name:Volume', volume_name - The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

$sel:efsVolumeConfiguration:Volume', volume_efsVolumeConfiguration - This parameter is specified when you are 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 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.

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

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. 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 are 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 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.