class Aws::ECS::Types::Volume
A data volume 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
@note When making an API call, you may pass Volume
data as a 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", }, }, efs_volume_configuration: { file_system_id: "String", # required root_directory: "String", transit_encryption: "ENABLED", # accepts ENABLED, DISABLED transit_encryption_port: 1, authorization_config: { access_point_id: "String", iam: "ENABLED", # accepts ENABLED, DISABLED }, }, fsx_windows_file_server_volume_configuration: { file_system_id: "String", # required root_directory: "String", # required authorization_config: { # required credentials_parameter: "String", # required domain: "String", # required }, }, }
@!attribute [rw] name
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`. @return [String]
@!attribute [rw] host
This parameter is specified when you are using 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 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`. @return [Types::HostVolumeProperties]
@!attribute [rw] docker_volume_configuration
This parameter is specified when you are using 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 are not supported by tasks run on Fargate. </note> @return [Types::DockerVolumeConfiguration]
@!attribute [rw] efs_volume_configuration
This parameter is specified when you are using an Amazon Elastic File System file system for task storage. @return [Types::EFSVolumeConfiguration]
@!attribute [rw] fsx_windows_file_server_volume_configuration
This parameter is specified when you are using Amazon FSx for Windows File Server file system for task storage. @return [Types::FSxWindowsFileServerVolumeConfiguration]
@see docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Volume AWS API Documentation
Constants
- SENSITIVE