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

#include <HostVolumeProperties.h>

Public Member Functions

 HostVolumeProperties ()
 
 HostVolumeProperties (Aws::Utils::Json::JsonView jsonValue)
 
HostVolumePropertiesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetSourcePath () const
 
bool SourcePathHasBeenSet () const
 
void SetSourcePath (const Aws::String &value)
 
void SetSourcePath (Aws::String &&value)
 
void SetSourcePath (const char *value)
 
HostVolumePropertiesWithSourcePath (const Aws::String &value)
 
HostVolumePropertiesWithSourcePath (Aws::String &&value)
 
HostVolumePropertiesWithSourcePath (const char *value)
 

Detailed Description

Details on a container instance bind mount host volume.

See Also:

AWS API Reference

Definition at line 32 of file HostVolumeProperties.h.

Constructor & Destructor Documentation

◆ HostVolumeProperties() [1/2]

Aws::ECS::Model::HostVolumeProperties::HostVolumeProperties ( )

◆ HostVolumeProperties() [2/2]

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

Member Function Documentation

◆ GetSourcePath()

const Aws::String& Aws::ECS::Model::HostVolumeProperties::GetSourcePath ( ) const
inline

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

Definition at line 53 of file HostVolumeProperties.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetSourcePath() [1/3]

void Aws::ECS::Model::HostVolumeProperties::SetSourcePath ( const Aws::String value)
inline

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

Definition at line 81 of file HostVolumeProperties.h.

◆ SetSourcePath() [2/3]

void Aws::ECS::Model::HostVolumeProperties::SetSourcePath ( Aws::String &&  value)
inline

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

Definition at line 95 of file HostVolumeProperties.h.

◆ SetSourcePath() [3/3]

void Aws::ECS::Model::HostVolumeProperties::SetSourcePath ( const char *  value)
inline

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

Definition at line 109 of file HostVolumeProperties.h.

◆ SourcePathHasBeenSet()

bool Aws::ECS::Model::HostVolumeProperties::SourcePathHasBeenSet ( ) const
inline

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

Definition at line 67 of file HostVolumeProperties.h.

◆ WithSourcePath() [1/3]

HostVolumeProperties& Aws::ECS::Model::HostVolumeProperties::WithSourcePath ( const Aws::String value)
inline

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

Definition at line 123 of file HostVolumeProperties.h.

◆ WithSourcePath() [2/3]

HostVolumeProperties& Aws::ECS::Model::HostVolumeProperties::WithSourcePath ( Aws::String &&  value)
inline

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

Definition at line 137 of file HostVolumeProperties.h.

◆ WithSourcePath() [3/3]

HostVolumeProperties& Aws::ECS::Model::HostVolumeProperties::WithSourcePath ( const char *  value)
inline

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

Definition at line 151 of file HostVolumeProperties.h.


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