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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

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
    },
  },
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#docker_volume_configurationTypes::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>

12197
12198
12199
12200
12201
12202
12203
12204
12205
# File 'lib/aws-sdk-ecs/types.rb', line 12197

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_configurationTypes::EFSVolumeConfiguration

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


12197
12198
12199
12200
12201
12202
12203
12204
12205
# File 'lib/aws-sdk-ecs/types.rb', line 12197

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_configurationTypes::FSxWindowsFileServerVolumeConfiguration

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


12197
12198
12199
12200
12201
12202
12203
12204
12205
# File 'lib/aws-sdk-ecs/types.rb', line 12197

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

#hostTypes::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`.


12197
12198
12199
12200
12201
12202
12203
12204
12205
# File 'lib/aws-sdk-ecs/types.rb', line 12197

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

#nameString

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)

12197
12198
12199
12200
12201
12202
12203
12204
12205
# File 'lib/aws-sdk-ecs/types.rb', line 12197

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