AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::Volume Class Reference

#include <Volume.h>

Public Member Functions

 Volume ()
 
 Volume (Aws::Utils::Json::JsonView jsonValue)
 
Volumeoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
VolumeWithName (const Aws::String &value)
 
VolumeWithName (Aws::String &&value)
 
VolumeWithName (const char *value)
 
const HostVolumePropertiesGetHost () const
 
bool HostHasBeenSet () const
 
void SetHost (const HostVolumeProperties &value)
 
void SetHost (HostVolumeProperties &&value)
 
VolumeWithHost (const HostVolumeProperties &value)
 
VolumeWithHost (HostVolumeProperties &&value)
 
const DockerVolumeConfigurationGetDockerVolumeConfiguration () const
 
bool DockerVolumeConfigurationHasBeenSet () const
 
void SetDockerVolumeConfiguration (const DockerVolumeConfiguration &value)
 
void SetDockerVolumeConfiguration (DockerVolumeConfiguration &&value)
 
VolumeWithDockerVolumeConfiguration (const DockerVolumeConfiguration &value)
 
VolumeWithDockerVolumeConfiguration (DockerVolumeConfiguration &&value)
 
const EFSVolumeConfigurationGetEfsVolumeConfiguration () const
 
bool EfsVolumeConfigurationHasBeenSet () const
 
void SetEfsVolumeConfiguration (const EFSVolumeConfiguration &value)
 
void SetEfsVolumeConfiguration (EFSVolumeConfiguration &&value)
 
VolumeWithEfsVolumeConfiguration (const EFSVolumeConfiguration &value)
 
VolumeWithEfsVolumeConfiguration (EFSVolumeConfiguration &&value)
 
const FSxWindowsFileServerVolumeConfigurationGetFsxWindowsFileServerVolumeConfiguration () const
 
bool FsxWindowsFileServerVolumeConfigurationHasBeenSet () const
 
void SetFsxWindowsFileServerVolumeConfiguration (const FSxWindowsFileServerVolumeConfiguration &value)
 
void SetFsxWindowsFileServerVolumeConfiguration (FSxWindowsFileServerVolumeConfiguration &&value)
 
VolumeWithFsxWindowsFileServerVolumeConfiguration (const FSxWindowsFileServerVolumeConfiguration &value)
 
VolumeWithFsxWindowsFileServerVolumeConfiguration (FSxWindowsFileServerVolumeConfiguration &&value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 44 of file Volume.h.

Constructor & Destructor Documentation

◆ Volume() [1/2]

Aws::ECS::Model::Volume::Volume ( )

◆ Volume() [2/2]

Aws::ECS::Model::Volume::Volume ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DockerVolumeConfigurationHasBeenSet()

bool Aws::ECS::Model::Volume::DockerVolumeConfigurationHasBeenSet ( ) const
inline

This parameter 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 the host parameter instead.

Definition at line 223 of file Volume.h.

◆ EfsVolumeConfigurationHasBeenSet()

bool Aws::ECS::Model::Volume::EfsVolumeConfigurationHasBeenSet ( ) const
inline

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

Definition at line 268 of file Volume.h.

◆ FsxWindowsFileServerVolumeConfigurationHasBeenSet()

bool Aws::ECS::Model::Volume::FsxWindowsFileServerVolumeConfigurationHasBeenSet ( ) const
inline

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

Definition at line 305 of file Volume.h.

◆ GetDockerVolumeConfiguration()

const DockerVolumeConfiguration& Aws::ECS::Model::Volume::GetDockerVolumeConfiguration ( ) const
inline

This parameter 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 the host parameter instead.

Definition at line 215 of file Volume.h.

◆ GetEfsVolumeConfiguration()

const EFSVolumeConfiguration& Aws::ECS::Model::Volume::GetEfsVolumeConfiguration ( ) const
inline

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

Definition at line 262 of file Volume.h.

◆ GetFsxWindowsFileServerVolumeConfiguration()

const FSxWindowsFileServerVolumeConfiguration& Aws::ECS::Model::Volume::GetFsxWindowsFileServerVolumeConfiguration ( ) const
inline

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

Definition at line 299 of file Volume.h.

◆ GetHost()

const HostVolumeProperties& Aws::ECS::Model::Volume::GetHost ( ) const
inline

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

Definition at line 131 of file Volume.h.

◆ GetName()

const Aws::String& Aws::ECS::Model::Volume::GetName ( ) const
inline

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.

Definition at line 59 of file Volume.h.

◆ HostHasBeenSet()

bool Aws::ECS::Model::Volume::HostHasBeenSet ( ) const
inline

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

Definition at line 146 of file Volume.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::Volume::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::ECS::Model::Volume::NameHasBeenSet ( ) const
inline

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.

Definition at line 67 of file Volume.h.

◆ operator=()

Volume& Aws::ECS::Model::Volume::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetDockerVolumeConfiguration() [1/2]

void Aws::ECS::Model::Volume::SetDockerVolumeConfiguration ( const DockerVolumeConfiguration value)
inline

This parameter 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 the host parameter instead.

Definition at line 231 of file Volume.h.

◆ SetDockerVolumeConfiguration() [2/2]

void Aws::ECS::Model::Volume::SetDockerVolumeConfiguration ( DockerVolumeConfiguration &&  value)
inline

This parameter 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 the host parameter instead.

Definition at line 239 of file Volume.h.

◆ SetEfsVolumeConfiguration() [1/2]

void Aws::ECS::Model::Volume::SetEfsVolumeConfiguration ( const EFSVolumeConfiguration value)
inline

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

Definition at line 274 of file Volume.h.

◆ SetEfsVolumeConfiguration() [2/2]

void Aws::ECS::Model::Volume::SetEfsVolumeConfiguration ( EFSVolumeConfiguration &&  value)
inline

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

Definition at line 280 of file Volume.h.

◆ SetFsxWindowsFileServerVolumeConfiguration() [1/2]

void Aws::ECS::Model::Volume::SetFsxWindowsFileServerVolumeConfiguration ( const FSxWindowsFileServerVolumeConfiguration value)
inline

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

Definition at line 311 of file Volume.h.

◆ SetFsxWindowsFileServerVolumeConfiguration() [2/2]

void Aws::ECS::Model::Volume::SetFsxWindowsFileServerVolumeConfiguration ( FSxWindowsFileServerVolumeConfiguration &&  value)
inline

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

Definition at line 317 of file Volume.h.

◆ SetHost() [1/2]

void Aws::ECS::Model::Volume::SetHost ( const HostVolumeProperties value)
inline

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

Definition at line 161 of file Volume.h.

◆ SetHost() [2/2]

void Aws::ECS::Model::Volume::SetHost ( HostVolumeProperties &&  value)
inline

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

Definition at line 176 of file Volume.h.

◆ SetName() [1/3]

void Aws::ECS::Model::Volume::SetName ( const Aws::String value)
inline

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.

Definition at line 75 of file Volume.h.

◆ SetName() [2/3]

void Aws::ECS::Model::Volume::SetName ( Aws::String &&  value)
inline

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.

Definition at line 83 of file Volume.h.

◆ SetName() [3/3]

void Aws::ECS::Model::Volume::SetName ( const char *  value)
inline

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.

Definition at line 91 of file Volume.h.

◆ WithDockerVolumeConfiguration() [1/2]

Volume& Aws::ECS::Model::Volume::WithDockerVolumeConfiguration ( const DockerVolumeConfiguration value)
inline

This parameter 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 the host parameter instead.

Definition at line 247 of file Volume.h.

◆ WithDockerVolumeConfiguration() [2/2]

Volume& Aws::ECS::Model::Volume::WithDockerVolumeConfiguration ( DockerVolumeConfiguration &&  value)
inline

This parameter 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 the host parameter instead.

Definition at line 255 of file Volume.h.

◆ WithEfsVolumeConfiguration() [1/2]

Volume& Aws::ECS::Model::Volume::WithEfsVolumeConfiguration ( const EFSVolumeConfiguration value)
inline

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

Definition at line 286 of file Volume.h.

◆ WithEfsVolumeConfiguration() [2/2]

Volume& Aws::ECS::Model::Volume::WithEfsVolumeConfiguration ( EFSVolumeConfiguration &&  value)
inline

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

Definition at line 292 of file Volume.h.

◆ WithFsxWindowsFileServerVolumeConfiguration() [1/2]

Volume& Aws::ECS::Model::Volume::WithFsxWindowsFileServerVolumeConfiguration ( const FSxWindowsFileServerVolumeConfiguration value)
inline

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

Definition at line 323 of file Volume.h.

◆ WithFsxWindowsFileServerVolumeConfiguration() [2/2]

Volume& Aws::ECS::Model::Volume::WithFsxWindowsFileServerVolumeConfiguration ( FSxWindowsFileServerVolumeConfiguration &&  value)
inline

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

Definition at line 329 of file Volume.h.

◆ WithHost() [1/2]

Volume& Aws::ECS::Model::Volume::WithHost ( const HostVolumeProperties value)
inline

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

Definition at line 191 of file Volume.h.

◆ WithHost() [2/2]

Volume& Aws::ECS::Model::Volume::WithHost ( HostVolumeProperties &&  value)
inline

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

Definition at line 206 of file Volume.h.

◆ WithName() [1/3]

Volume& Aws::ECS::Model::Volume::WithName ( const Aws::String value)
inline

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.

Definition at line 99 of file Volume.h.

◆ WithName() [2/3]

Volume& Aws::ECS::Model::Volume::WithName ( Aws::String &&  value)
inline

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.

Definition at line 107 of file Volume.h.

◆ WithName() [3/3]

Volume& Aws::ECS::Model::Volume::WithName ( const char *  value)
inline

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.

Definition at line 115 of file Volume.h.


The documentation for this class was generated from the following file: