Amazonka.Batch.Types.MountPoint

Documentation

data MountPoint

Details for 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.

• 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.

• sourceVolume :: Maybe Text

  The name of the volume to mount.

Instances

FromJSON MountPoint

Defined in Amazonka.Batch.Types.MountPoint

Methods

parseJSON :: Value -> Parser MountPoint

parseJSONList :: Value -> Parser [MountPoint]

ToJSON MountPoint

Defined in Amazonka.Batch.Types.MountPoint

Methods

toJSON :: MountPoint -> Value

toEncoding :: MountPoint -> Encoding

toJSONList :: [MountPoint] -> Value

toEncodingList :: [MountPoint] -> Encoding

Generic MountPoint

Defined in Amazonka.Batch.Types.MountPoint

Associated Types

type Rep MountPoint :: Type -> Type

Methods

from :: MountPoint -> Rep MountPoint x

to :: Rep MountPoint x -> MountPoint

Read MountPoint

Defined in Amazonka.Batch.Types.MountPoint

Methods

readsPrec :: Int -> ReadS MountPoint

readList :: ReadS [MountPoint]

readPrec :: ReadPrec MountPoint

readListPrec :: ReadPrec [MountPoint]

Show MountPoint

Defined in Amazonka.Batch.Types.MountPoint

Methods

showsPrec :: Int -> MountPoint -> ShowS

show :: MountPoint -> String

showList :: [MountPoint] -> ShowS

NFData MountPoint

Defined in Amazonka.Batch.Types.MountPoint

Methods

rnf :: MountPoint -> ()

Eq MountPoint

Defined in Amazonka.Batch.Types.MountPoint

Methods

(==) :: MountPoint -> MountPoint -> Bool

(/=) :: MountPoint -> MountPoint -> Bool

Hashable MountPoint

Defined in Amazonka.Batch.Types.MountPoint

Methods

hashWithSalt :: Int -> MountPoint -> Int

hash :: MountPoint -> Int

type Rep MountPoint

Defined in Amazonka.Batch.Types.MountPoint

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

newMountPoint :: MountPoint

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: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.

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

mountPoint_containerPath :: Lens' MountPoint (Maybe Text)

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

mountPoint_readOnly :: Lens' MountPoint (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.

mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text)

The name of the volume to mount.