amazonka-ecs-2.0: Amazon EC2 Container Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ECS.Types.HostVolumeProperties

Description

 
Synopsis

Documentation

data HostVolumeProperties Source #

Details on a container instance bind mount host volume.

See: newHostVolumeProperties smart constructor.

Constructors

HostVolumeProperties' 

Fields

  • sourcePath :: Maybe Text

    When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

    If you're using the Fargate launch type, the sourcePath parameter is not supported.

Instances

Instances details
FromJSON HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

ToJSON HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

Generic HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

Associated Types

type Rep HostVolumeProperties :: Type -> Type #

Read HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

Show HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

NFData HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

Methods

rnf :: HostVolumeProperties -> () #

Eq HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

Hashable HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

type Rep HostVolumeProperties Source # 
Instance details

Defined in Amazonka.ECS.Types.HostVolumeProperties

type Rep HostVolumeProperties = D1 ('MetaData "HostVolumeProperties" "Amazonka.ECS.Types.HostVolumeProperties" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "HostVolumeProperties'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourcePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newHostVolumeProperties :: HostVolumeProperties Source #

Create a value of HostVolumeProperties 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:sourcePath:HostVolumeProperties', hostVolumeProperties_sourcePath - When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you're using the Fargate launch type, the sourcePath parameter is not supported.

hostVolumeProperties_sourcePath :: Lens' HostVolumeProperties (Maybe Text) Source #

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you're using the Fargate launch type, the sourcePath parameter is not supported.