libZSservicesZSamazonka-batchZSamazonka-batch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Batch.Types.MountPoint

Description

 
Synopsis

Documentation

data MountPoint Source #

Details on a Docker volume mount point that's used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

See: newMountPoint smart constructor.

Constructors

MountPoint' 

Fields

  • containerPath :: Maybe Text

    The path on the container where the host volume is mounted.

  • sourceVolume :: Maybe Text

    The name of the volume to mount.

  • readOnly :: Maybe Bool

    If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.

Instances

Instances details
Eq MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

Read MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

Show MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

Generic MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

Associated Types

type Rep MountPoint :: Type -> Type #

NFData MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

Methods

rnf :: MountPoint -> () #

Hashable MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

ToJSON MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

FromJSON MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

type Rep MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

type Rep MountPoint = D1 ('MetaData "MountPoint" "Amazonka.Batch.Types.MountPoint" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "MountPoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sourceVolume") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "readOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newMountPoint :: MountPoint Source #

Create a value of MountPoint 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:containerPath:MountPoint', mountPoint_containerPath - The path on the container where the host volume is mounted.

$sel:sourceVolume:MountPoint', mountPoint_sourceVolume - The name of the volume to mount.

$sel:readOnly:MountPoint', mountPoint_readOnly - If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.

mountPoint_containerPath :: Lens' MountPoint (Maybe Text) Source #

The path on the container where the host volume is mounted.

mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text) Source #

The name of the volume to mount.

mountPoint_readOnly :: Lens' MountPoint (Maybe Bool) Source #

If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.