Package software.amazon.awscdk.services.ecs

Interface Volume

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Volume.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.489Z")
@Stability(Stable)
public interface Volume
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 FargateTaskDefinition fargateTaskDefinition = FargateTaskDefinition.Builder.create(this, "TaskDef")
         .memoryLimitMiB(512)
         .cpu(256)
         .build();
 Map<String, Object> volume = Map.of(
         // Use an Elastic FileSystem
         "name", "mydatavolume",
         "efsVolumeConfiguration", Map.of(
                 "fileSystemId", "EFS"));
 void container = fargateTaskDefinition.addVolume(volume);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Volume.Builder	A builder for Volume
static final class	Volume.Jsii$Proxy	An implementation for Volume

Method Summary

Modifier and Type	Method	Description
static Volume.Builder	builder()
default DockerVolumeConfiguration	getDockerVolumeConfiguration()	This property is specified when you are using Docker volumes.
default EfsVolumeConfiguration	getEfsVolumeConfiguration()	This property is specified when you are using Amazon EFS.
default Host	getHost()	This property is specified when you are using bind mount host volumes.
String	getName()	The name of the volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

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.

getDockerVolumeConfiguration

@Stability(Stable)
@Nullable
default DockerVolumeConfiguration getDockerVolumeConfiguration()

This property 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.

getEfsVolumeConfiguration

@Stability(Stable)
@Nullable
default EfsVolumeConfiguration getEfsVolumeConfiguration()

This property is specified when you are using Amazon EFS.

When specifying Amazon EFS volumes in tasks using the Fargate launch type, Fargate creates a supervisor container that is responsible for managing the Amazon EFS volume. The supervisor container uses a small amount of the task's memory. The supervisor container is visible when querying the task metadata version 4 endpoint, but is not visible in CloudWatch Container Insights.

Default: No Elastic FileSystem is setup

getHost

@Stability(Stable)
@Nullable
default Host getHost()

This property 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.

builder

@Stability(Stable)
static Volume.Builder builder()

Returns:

a Volume.Builder of Volume