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

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::Volume

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

A data volume that's used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an `efsVolumeConfiguration`. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a `fsxWindowsFileServerVolumeConfiguration`. 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].

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #docker_volume_configuration ⇒ Types::DockerVolumeConfiguration

  This parameter is specified when you use Docker volumes.

• #efs_volume_configuration ⇒ Types::EFSVolumeConfiguration

  This parameter is specified when you use an Amazon Elastic File System file system for task storage.

• #fsx_windows_file_server_volume_configuration ⇒ Types::FSxWindowsFileServerVolumeConfiguration

  This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

• #host ⇒ Types::HostVolumeProperties

  This parameter is specified when you use bind mount host volumes.

• #name ⇒ String

  The name of the volume.

Instance Attribute Details

#docker_volume_configuration ⇒ Types::DockerVolumeConfiguration

This parameter is specified when you use Docker volumes.

Windows containers only support the use of the `local` driver. To use bind mounts, specify the `host` parameter instead.

<note markdown=“1”> Docker volumes aren't supported by tasks run on Fargate.

</note>

Returns:

• (Types::DockerVolumeConfiguration)

# File 'lib/aws-sdk-ecs/types.rb', line 11509

class Volume < Struct.new(
  :name,
  :host,
  :docker_volume_configuration,
  :efs_volume_configuration,
  :fsx_windows_file_server_volume_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#efs_volume_configuration ⇒ Types::EFSVolumeConfiguration

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

Returns:

• (Types::EFSVolumeConfiguration)

# File 'lib/aws-sdk-ecs/types.rb', line 11509

class Volume < Struct.new(
  :name,
  :host,
  :docker_volume_configuration,
  :efs_volume_configuration,
  :fsx_windows_file_server_volume_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#fsx_windows_file_server_volume_configuration ⇒ Types::FSxWindowsFileServerVolumeConfiguration

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

Returns:

• (Types::FSxWindowsFileServerVolumeConfiguration)

# File 'lib/aws-sdk-ecs/types.rb', line 11509

class Volume < Struct.new(
  :name,
  :host,
  :docker_volume_configuration,
  :efs_volume_configuration,
  :fsx_windows_file_server_volume_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#host ⇒ Types::HostVolumeProperties

This parameter is specified when you use bind mount host volumes. The contents of the `host` parameter determine whether your bind mount host volume persists on the host container instance and where it's 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 that are associated with it stop running.

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

Returns:

• (Types::HostVolumeProperties)

# File 'lib/aws-sdk-ecs/types.rb', line 11509

class Volume < Struct.new(
  :name,
  :host,
  :docker_volume_configuration,
  :efs_volume_configuration,
  :fsx_windows_file_server_volume_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 11509

class Volume < Struct.new(
  :name,
  :host,
  :docker_volume_configuration,
  :efs_volume_configuration,
  :fsx_windows_file_server_volume_configuration)
  SENSITIVE = []
  include Aws::Structure
end