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

#include <DockerVolumeConfiguration.h>

Public Member Functions

 DockerVolumeConfiguration ()
 
 DockerVolumeConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
DockerVolumeConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ScopeGetScope () const
 
bool ScopeHasBeenSet () const
 
void SetScope (const Scope &value)
 
void SetScope (Scope &&value)
 
DockerVolumeConfigurationWithScope (const Scope &value)
 
DockerVolumeConfigurationWithScope (Scope &&value)
 
bool GetAutoprovision () const
 
bool AutoprovisionHasBeenSet () const
 
void SetAutoprovision (bool value)
 
DockerVolumeConfigurationWithAutoprovision (bool value)
 
const Aws::StringGetDriver () const
 
bool DriverHasBeenSet () const
 
void SetDriver (const Aws::String &value)
 
void SetDriver (Aws::String &&value)
 
void SetDriver (const char *value)
 
DockerVolumeConfigurationWithDriver (const Aws::String &value)
 
DockerVolumeConfigurationWithDriver (Aws::String &&value)
 
DockerVolumeConfigurationWithDriver (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetDriverOpts () const
 
bool DriverOptsHasBeenSet () const
 
void SetDriverOpts (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetDriverOpts (Aws::Map< Aws::String, Aws::String > &&value)
 
DockerVolumeConfigurationWithDriverOpts (const Aws::Map< Aws::String, Aws::String > &value)
 
DockerVolumeConfigurationWithDriverOpts (Aws::Map< Aws::String, Aws::String > &&value)
 
DockerVolumeConfigurationAddDriverOpts (const Aws::String &key, const Aws::String &value)
 
DockerVolumeConfigurationAddDriverOpts (Aws::String &&key, const Aws::String &value)
 
DockerVolumeConfigurationAddDriverOpts (const Aws::String &key, Aws::String &&value)
 
DockerVolumeConfigurationAddDriverOpts (Aws::String &&key, Aws::String &&value)
 
DockerVolumeConfigurationAddDriverOpts (const char *key, Aws::String &&value)
 
DockerVolumeConfigurationAddDriverOpts (Aws::String &&key, const char *value)
 
DockerVolumeConfigurationAddDriverOpts (const char *key, const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetLabels () const
 
bool LabelsHasBeenSet () const
 
void SetLabels (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetLabels (Aws::Map< Aws::String, Aws::String > &&value)
 
DockerVolumeConfigurationWithLabels (const Aws::Map< Aws::String, Aws::String > &value)
 
DockerVolumeConfigurationWithLabels (Aws::Map< Aws::String, Aws::String > &&value)
 
DockerVolumeConfigurationAddLabels (const Aws::String &key, const Aws::String &value)
 
DockerVolumeConfigurationAddLabels (Aws::String &&key, const Aws::String &value)
 
DockerVolumeConfigurationAddLabels (const Aws::String &key, Aws::String &&value)
 
DockerVolumeConfigurationAddLabels (Aws::String &&key, Aws::String &&value)
 
DockerVolumeConfigurationAddLabels (const char *key, Aws::String &&value)
 
DockerVolumeConfigurationAddLabels (Aws::String &&key, const char *value)
 
DockerVolumeConfigurationAddLabels (const char *key, const char *value)
 

Detailed Description

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 a host instead.

See Also:

AWS API Reference

Definition at line 36 of file DockerVolumeConfiguration.h.

Constructor & Destructor Documentation

◆ DockerVolumeConfiguration() [1/2]

Aws::ECS::Model::DockerVolumeConfiguration::DockerVolumeConfiguration ( )

◆ DockerVolumeConfiguration() [2/2]

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

Member Function Documentation

◆ AddDriverOpts() [1/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddDriverOpts ( const Aws::String key,
const Aws::String value 
)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 350 of file DockerVolumeConfiguration.h.

◆ AddDriverOpts() [2/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddDriverOpts ( Aws::String &&  key,
const Aws::String value 
)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 362 of file DockerVolumeConfiguration.h.

◆ AddDriverOpts() [3/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddDriverOpts ( const Aws::String key,
Aws::String &&  value 
)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 374 of file DockerVolumeConfiguration.h.

◆ AddDriverOpts() [4/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddDriverOpts ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 386 of file DockerVolumeConfiguration.h.

◆ AddDriverOpts() [5/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddDriverOpts ( const char *  key,
Aws::String &&  value 
)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 398 of file DockerVolumeConfiguration.h.

◆ AddDriverOpts() [6/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddDriverOpts ( Aws::String &&  key,
const char *  value 
)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 410 of file DockerVolumeConfiguration.h.

◆ AddDriverOpts() [7/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddDriverOpts ( const char *  key,
const char *  value 
)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 422 of file DockerVolumeConfiguration.h.

◆ AddLabels() [1/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddLabels ( const Aws::String key,
const Aws::String value 
)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 507 of file DockerVolumeConfiguration.h.

◆ AddLabels() [2/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddLabels ( Aws::String &&  key,
const Aws::String value 
)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 519 of file DockerVolumeConfiguration.h.

◆ AddLabels() [3/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddLabels ( const Aws::String key,
Aws::String &&  value 
)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 531 of file DockerVolumeConfiguration.h.

◆ AddLabels() [4/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddLabels ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 543 of file DockerVolumeConfiguration.h.

◆ AddLabels() [5/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddLabels ( const char *  key,
Aws::String &&  value 
)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 555 of file DockerVolumeConfiguration.h.

◆ AddLabels() [6/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddLabels ( Aws::String &&  key,
const char *  value 
)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 567 of file DockerVolumeConfiguration.h.

◆ AddLabels() [7/7]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::AddLabels ( const char *  key,
const char *  value 
)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 579 of file DockerVolumeConfiguration.h.

◆ AutoprovisionHasBeenSet()

bool Aws::ECS::Model::DockerVolumeConfiguration::AutoprovisionHasBeenSet ( ) const
inline

If this value is true, the Docker volume is created if it does not already exist.

This field is only used if the scope is shared.

Definition at line 106 of file DockerVolumeConfiguration.h.

◆ DriverHasBeenSet()

bool Aws::ECS::Model::DockerVolumeConfiguration::DriverHasBeenSet ( ) const
inline

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

Definition at line 157 of file DockerVolumeConfiguration.h.

◆ DriverOptsHasBeenSet()

bool Aws::ECS::Model::DockerVolumeConfiguration::DriverOptsHasBeenSet ( ) const
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 290 of file DockerVolumeConfiguration.h.

◆ GetAutoprovision()

bool Aws::ECS::Model::DockerVolumeConfiguration::GetAutoprovision ( ) const
inline

If this value is true, the Docker volume is created if it does not already exist.

This field is only used if the scope is shared.

Definition at line 99 of file DockerVolumeConfiguration.h.

◆ GetDriver()

const Aws::String& Aws::ECS::Model::DockerVolumeConfiguration::GetDriver ( ) const
inline

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

Definition at line 139 of file DockerVolumeConfiguration.h.

◆ GetDriverOpts()

const Aws::Map<Aws::String, Aws::String>& Aws::ECS::Model::DockerVolumeConfiguration::GetDriverOpts ( ) const
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 278 of file DockerVolumeConfiguration.h.

◆ GetLabels()

const Aws::Map<Aws::String, Aws::String>& Aws::ECS::Model::DockerVolumeConfiguration::GetLabels ( ) const
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 435 of file DockerVolumeConfiguration.h.

◆ GetScope()

const Scope& Aws::ECS::Model::DockerVolumeConfiguration::GetScope ( ) const
inline

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

Definition at line 51 of file DockerVolumeConfiguration.h.

◆ Jsonize()

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

◆ LabelsHasBeenSet()

bool Aws::ECS::Model::DockerVolumeConfiguration::LabelsHasBeenSet ( ) const
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 447 of file DockerVolumeConfiguration.h.

◆ operator=()

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

◆ ScopeHasBeenSet()

bool Aws::ECS::Model::DockerVolumeConfiguration::ScopeHasBeenSet ( ) const
inline

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

Definition at line 59 of file DockerVolumeConfiguration.h.

◆ SetAutoprovision()

void Aws::ECS::Model::DockerVolumeConfiguration::SetAutoprovision ( bool  value)
inline

If this value is true, the Docker volume is created if it does not already exist.

This field is only used if the scope is shared.

Definition at line 113 of file DockerVolumeConfiguration.h.

◆ SetDriver() [1/3]

void Aws::ECS::Model::DockerVolumeConfiguration::SetDriver ( const Aws::String value)
inline

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

Definition at line 175 of file DockerVolumeConfiguration.h.

◆ SetDriver() [2/3]

void Aws::ECS::Model::DockerVolumeConfiguration::SetDriver ( Aws::String &&  value)
inline

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

Definition at line 193 of file DockerVolumeConfiguration.h.

◆ SetDriver() [3/3]

void Aws::ECS::Model::DockerVolumeConfiguration::SetDriver ( const char *  value)
inline

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

Definition at line 211 of file DockerVolumeConfiguration.h.

◆ SetDriverOpts() [1/2]

void Aws::ECS::Model::DockerVolumeConfiguration::SetDriverOpts ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 302 of file DockerVolumeConfiguration.h.

◆ SetDriverOpts() [2/2]

void Aws::ECS::Model::DockerVolumeConfiguration::SetDriverOpts ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 314 of file DockerVolumeConfiguration.h.

◆ SetLabels() [1/2]

void Aws::ECS::Model::DockerVolumeConfiguration::SetLabels ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 459 of file DockerVolumeConfiguration.h.

◆ SetLabels() [2/2]

void Aws::ECS::Model::DockerVolumeConfiguration::SetLabels ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 471 of file DockerVolumeConfiguration.h.

◆ SetScope() [1/2]

void Aws::ECS::Model::DockerVolumeConfiguration::SetScope ( const Scope value)
inline

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

Definition at line 67 of file DockerVolumeConfiguration.h.

◆ SetScope() [2/2]

void Aws::ECS::Model::DockerVolumeConfiguration::SetScope ( Scope &&  value)
inline

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

Definition at line 75 of file DockerVolumeConfiguration.h.

◆ WithAutoprovision()

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::WithAutoprovision ( bool  value)
inline

If this value is true, the Docker volume is created if it does not already exist.

This field is only used if the scope is shared.

Definition at line 120 of file DockerVolumeConfiguration.h.

◆ WithDriver() [1/3]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::WithDriver ( const Aws::String value)
inline

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

Definition at line 229 of file DockerVolumeConfiguration.h.

◆ WithDriver() [2/3]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::WithDriver ( Aws::String &&  value)
inline

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

Definition at line 247 of file DockerVolumeConfiguration.h.

◆ WithDriver() [3/3]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::WithDriver ( const char *  value)
inline

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

Definition at line 265 of file DockerVolumeConfiguration.h.

◆ WithDriverOpts() [1/2]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::WithDriverOpts ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 326 of file DockerVolumeConfiguration.h.

◆ WithDriverOpts() [2/2]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::WithDriverOpts ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

Definition at line 338 of file DockerVolumeConfiguration.h.

◆ WithLabels() [1/2]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::WithLabels ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 483 of file DockerVolumeConfiguration.h.

◆ WithLabels() [2/2]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::WithLabels ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

Definition at line 495 of file DockerVolumeConfiguration.h.

◆ WithScope() [1/2]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::WithScope ( const Scope value)
inline

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

Definition at line 83 of file DockerVolumeConfiguration.h.

◆ WithScope() [2/2]

DockerVolumeConfiguration& Aws::ECS::Model::DockerVolumeConfiguration::WithScope ( Scope &&  value)
inline

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

Definition at line 91 of file DockerVolumeConfiguration.h.


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