Volume

class aws_cdk.aws_ecs.Volume(*, name, configured_at_launch=None, docker_volume_configuration=None, efs_volume_configuration=None, host=None)

Bases: object

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.

Parameters:

name (str) – 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.
configured_at_launch (Optional[bool]) – Indicates if the volume should be configured at launch. Default: false
docker_volume_configuration (Union[DockerVolumeConfiguration, Dict[str, Any], None]) – 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.
efs_volume_configuration (Union[EfsVolumeConfiguration, Dict[str, Any], None]) – 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
host (Union[Host, Dict[str, Any], None]) – 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.

ExampleMetadata:

infused

Example:

# container: ecs.ContainerDefinition
# cluster: ecs.Cluster
# task_definition: ecs.TaskDefinition


volume_from_snapshot = ecs.ServiceManagedVolume(self, "EBSVolume",
    name="nginx-vol",
    managed_eBSVolume=ecs.ServiceManagedEBSVolumeConfiguration(
        snap_shot_id="snap-066877671789bd71b",
        volume_type=ec2.EbsDeviceVolumeType.GP3,
        file_system_type=ecs.FileSystemType.XFS
    )
)

volume_from_snapshot.mount_in(container,
    container_path="/var/lib",
    read_only=False
)
task_definition.add_volume(volume_from_snapshot)
service = ecs.FargateService(self, "FargateService",
    cluster=cluster,
    task_definition=task_definition
)

service.add_volume(volume_from_snapshot)

Attributes

configured_at_launch

Indicates if the volume should be configured at launch.

Default:: false

docker_volume_configuration

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.

efs_volume_configuration

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

host

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.

name

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.