You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ECS::Types::Volume

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Volume as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "String",
  host: {
    source_path: "String",
  },
  docker_volume_configuration: {
    scope: "task", # accepts task, shared
    autoprovision: false,
    driver: "String",
    driver_opts: {
      "String" => "String",
    },
    labels: {
      "String" => "String",
    },
  },
}

A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

Instance Attribute Summary collapse

Instance Attribute Details

#docker_volume_configurationTypes::DockerVolumeConfiguration

This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

Returns:

#hostTypes::HostVolumeProperties

This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host 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 is not guaranteed to persist after the containers associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

Returns:

#nameString

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

Returns:

  • (String)

    The name of the volume.