com.amazonaws.services.ecs.model

Class Volume

java.lang.Object

com.amazonaws.services.ecs.model.Volume

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Volume
extends Object
implements Serializable, Cloneable, StructuredPojo

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Volume()

Method Summary

Modifier and Type	Method and Description
Volume	clone()
boolean	equals(Object obj)
DockerVolumeConfiguration	getDockerVolumeConfiguration() This parameter is specified when you use Docker volumes.
EFSVolumeConfiguration	getEfsVolumeConfiguration() This parameter is specified when you use an Amazon Elastic File System file system for task storage.
FSxWindowsFileServerVolumeConfiguration	getFsxWindowsFileServerVolumeConfiguration() This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
HostVolumeProperties	getHost() This parameter is specified when you use bind mount host volumes.
String	getName() The name of the volume.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDockerVolumeConfiguration(DockerVolumeConfiguration dockerVolumeConfiguration) This parameter is specified when you use Docker volumes.
void	setEfsVolumeConfiguration(EFSVolumeConfiguration efsVolumeConfiguration) This parameter is specified when you use an Amazon Elastic File System file system for task storage.
void	setFsxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfiguration fsxWindowsFileServerVolumeConfiguration) This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
void	setHost(HostVolumeProperties host) This parameter is specified when you use bind mount host volumes.
void	setName(String name) The name of the volume.
String	toString() Returns a string representation of this object.
Volume	withDockerVolumeConfiguration(DockerVolumeConfiguration dockerVolumeConfiguration) This parameter is specified when you use Docker volumes.
Volume	withEfsVolumeConfiguration(EFSVolumeConfiguration efsVolumeConfiguration) This parameter is specified when you use an Amazon Elastic File System file system for task storage.
Volume	withFsxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfiguration fsxWindowsFileServerVolumeConfiguration) This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
Volume	withHost(HostVolumeProperties host) This parameter is specified when you use bind mount host volumes.
Volume	withName(String name) The name of the volume.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Volume

public Volume()

Method Detail

setName

public void setName(String 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.

Parameters:

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.

getName

public String getName()

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:

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.

withName

public Volume withName(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHost

public void setHost(HostVolumeProperties host)

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:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

Parameters:

host - 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:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

getHost

public HostVolumeProperties getHost()

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:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

Returns:

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:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

withHost

public Volume withHost(HostVolumeProperties host)

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:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

Parameters:

host - 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:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDockerVolumeConfiguration

public void setDockerVolumeConfiguration(DockerVolumeConfiguration 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.

Docker volumes aren't supported by tasks run on Fargate.

Parameters:

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.

Docker volumes aren't supported by tasks run on Fargate.

getDockerVolumeConfiguration

public DockerVolumeConfiguration getDockerVolumeConfiguration()

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.

Docker volumes aren't supported by tasks run on Fargate.

Returns:

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.

Docker volumes aren't supported by tasks run on Fargate.

withDockerVolumeConfiguration

public Volume withDockerVolumeConfiguration(DockerVolumeConfiguration 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.

Docker volumes aren't supported by tasks run on Fargate.

Parameters:

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.

Docker volumes aren't supported by tasks run on Fargate.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEfsVolumeConfiguration

public void setEfsVolumeConfiguration(EFSVolumeConfiguration efsVolumeConfiguration)

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

Parameters:

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

getEfsVolumeConfiguration

public EFSVolumeConfiguration getEfsVolumeConfiguration()

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

Returns:

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

withEfsVolumeConfiguration

public Volume withEfsVolumeConfiguration(EFSVolumeConfiguration efsVolumeConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setFsxWindowsFileServerVolumeConfiguration

public void setFsxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfiguration fsxWindowsFileServerVolumeConfiguration)

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

Parameters:

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

getFsxWindowsFileServerVolumeConfiguration

public FSxWindowsFileServerVolumeConfiguration getFsxWindowsFileServerVolumeConfiguration()

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

Returns:

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

withFsxWindowsFileServerVolumeConfiguration

public Volume withFsxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfiguration fsxWindowsFileServerVolumeConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Volume clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.