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

#include <ContainerOverride.h>

Public Member Functions

 ContainerOverride ()
 
 ContainerOverride (Aws::Utils::Json::JsonView jsonValue)
 
ContainerOverrideoperator= (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)
 
ContainerOverrideWithName (const Aws::String &value)
 
ContainerOverrideWithName (Aws::String &&value)
 
ContainerOverrideWithName (const char *value)
 
const Aws::Vector< Aws::String > & GetCommand () const
 
bool CommandHasBeenSet () const
 
void SetCommand (const Aws::Vector< Aws::String > &value)
 
void SetCommand (Aws::Vector< Aws::String > &&value)
 
ContainerOverrideWithCommand (const Aws::Vector< Aws::String > &value)
 
ContainerOverrideWithCommand (Aws::Vector< Aws::String > &&value)
 
ContainerOverrideAddCommand (const Aws::String &value)
 
ContainerOverrideAddCommand (Aws::String &&value)
 
ContainerOverrideAddCommand (const char *value)
 
const Aws::Vector< KeyValuePair > & GetEnvironment () const
 
bool EnvironmentHasBeenSet () const
 
void SetEnvironment (const Aws::Vector< KeyValuePair > &value)
 
void SetEnvironment (Aws::Vector< KeyValuePair > &&value)
 
ContainerOverrideWithEnvironment (const Aws::Vector< KeyValuePair > &value)
 
ContainerOverrideWithEnvironment (Aws::Vector< KeyValuePair > &&value)
 
ContainerOverrideAddEnvironment (const KeyValuePair &value)
 
ContainerOverrideAddEnvironment (KeyValuePair &&value)
 
const Aws::Vector< EnvironmentFile > & GetEnvironmentFiles () const
 
bool EnvironmentFilesHasBeenSet () const
 
void SetEnvironmentFiles (const Aws::Vector< EnvironmentFile > &value)
 
void SetEnvironmentFiles (Aws::Vector< EnvironmentFile > &&value)
 
ContainerOverrideWithEnvironmentFiles (const Aws::Vector< EnvironmentFile > &value)
 
ContainerOverrideWithEnvironmentFiles (Aws::Vector< EnvironmentFile > &&value)
 
ContainerOverrideAddEnvironmentFiles (const EnvironmentFile &value)
 
ContainerOverrideAddEnvironmentFiles (EnvironmentFile &&value)
 
int GetCpu () const
 
bool CpuHasBeenSet () const
 
void SetCpu (int value)
 
ContainerOverrideWithCpu (int value)
 
int GetMemory () const
 
bool MemoryHasBeenSet () const
 
void SetMemory (int value)
 
ContainerOverrideWithMemory (int value)
 
int GetMemoryReservation () const
 
bool MemoryReservationHasBeenSet () const
 
void SetMemoryReservation (int value)
 
ContainerOverrideWithMemoryReservation (int value)
 
const Aws::Vector< ResourceRequirement > & GetResourceRequirements () const
 
bool ResourceRequirementsHasBeenSet () const
 
void SetResourceRequirements (const Aws::Vector< ResourceRequirement > &value)
 
void SetResourceRequirements (Aws::Vector< ResourceRequirement > &&value)
 
ContainerOverrideWithResourceRequirements (const Aws::Vector< ResourceRequirement > &value)
 
ContainerOverrideWithResourceRequirements (Aws::Vector< ResourceRequirement > &&value)
 
ContainerOverrideAddResourceRequirements (const ResourceRequirement &value)
 
ContainerOverrideAddResourceRequirements (ResourceRequirement &&value)
 

Detailed Description

The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

See Also:

AWS API Reference

Definition at line 39 of file ContainerOverride.h.

Constructor & Destructor Documentation

◆ ContainerOverride() [1/2]

Aws::ECS::Model::ContainerOverride::ContainerOverride ( )

◆ ContainerOverride() [2/2]

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

Member Function Documentation

◆ AddCommand() [1/3]

ContainerOverride& Aws::ECS::Model::ContainerOverride::AddCommand ( const Aws::String value)
inline

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

Definition at line 144 of file ContainerOverride.h.

◆ AddCommand() [2/3]

ContainerOverride& Aws::ECS::Model::ContainerOverride::AddCommand ( Aws::String &&  value)
inline

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

Definition at line 151 of file ContainerOverride.h.

◆ AddCommand() [3/3]

ContainerOverride& Aws::ECS::Model::ContainerOverride::AddCommand ( const char *  value)
inline

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

Definition at line 158 of file ContainerOverride.h.

◆ AddEnvironment() [1/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::AddEnvironment ( const KeyValuePair value)
inline

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

Definition at line 215 of file ContainerOverride.h.

◆ AddEnvironment() [2/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::AddEnvironment ( KeyValuePair &&  value)
inline

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

Definition at line 223 of file ContainerOverride.h.

◆ AddEnvironmentFiles() [1/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::AddEnvironmentFiles ( const EnvironmentFile value)
inline

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

Definition at line 266 of file ContainerOverride.h.

◆ AddEnvironmentFiles() [2/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::AddEnvironmentFiles ( EnvironmentFile &&  value)
inline

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

Definition at line 272 of file ContainerOverride.h.

◆ AddResourceRequirements() [1/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::AddResourceRequirements ( const ResourceRequirement value)
inline

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

Definition at line 413 of file ContainerOverride.h.

◆ AddResourceRequirements() [2/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::AddResourceRequirements ( ResourceRequirement &&  value)
inline

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

Definition at line 420 of file ContainerOverride.h.

◆ CommandHasBeenSet()

bool Aws::ECS::Model::ContainerOverride::CommandHasBeenSet ( ) const
inline

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

Definition at line 109 of file ContainerOverride.h.

◆ CpuHasBeenSet()

bool Aws::ECS::Model::ContainerOverride::CpuHasBeenSet ( ) const
inline

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

Definition at line 287 of file ContainerOverride.h.

◆ EnvironmentFilesHasBeenSet()

bool Aws::ECS::Model::ContainerOverride::EnvironmentFilesHasBeenSet ( ) const
inline

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

Definition at line 236 of file ContainerOverride.h.

◆ EnvironmentHasBeenSet()

bool Aws::ECS::Model::ContainerOverride::EnvironmentHasBeenSet ( ) const
inline

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

Definition at line 175 of file ContainerOverride.h.

◆ GetCommand()

const Aws::Vector<Aws::String>& Aws::ECS::Model::ContainerOverride::GetCommand ( ) const
inline

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

Definition at line 102 of file ContainerOverride.h.

◆ GetCpu()

int Aws::ECS::Model::ContainerOverride::GetCpu ( ) const
inline

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

Definition at line 280 of file ContainerOverride.h.

◆ GetEnvironment()

const Aws::Vector<KeyValuePair>& Aws::ECS::Model::ContainerOverride::GetEnvironment ( ) const
inline

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

Definition at line 167 of file ContainerOverride.h.

◆ GetEnvironmentFiles()

const Aws::Vector<EnvironmentFile>& Aws::ECS::Model::ContainerOverride::GetEnvironmentFiles ( ) const
inline

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

Definition at line 230 of file ContainerOverride.h.

◆ GetMemory()

int Aws::ECS::Model::ContainerOverride::GetMemory ( ) const
inline

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

Definition at line 310 of file ContainerOverride.h.

◆ GetMemoryReservation()

int Aws::ECS::Model::ContainerOverride::GetMemoryReservation ( ) const
inline

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

Definition at line 342 of file ContainerOverride.h.

◆ GetName()

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

The name of the container that receives the override. This parameter is required if any override is specified.

Definition at line 52 of file ContainerOverride.h.

◆ GetResourceRequirements()

const Aws::Vector<ResourceRequirement>& Aws::ECS::Model::ContainerOverride::GetResourceRequirements ( ) const
inline

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

Definition at line 371 of file ContainerOverride.h.

◆ Jsonize()

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

◆ MemoryHasBeenSet()

bool Aws::ECS::Model::ContainerOverride::MemoryHasBeenSet ( ) const
inline

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

Definition at line 318 of file ContainerOverride.h.

◆ MemoryReservationHasBeenSet()

bool Aws::ECS::Model::ContainerOverride::MemoryReservationHasBeenSet ( ) const
inline

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

Definition at line 349 of file ContainerOverride.h.

◆ NameHasBeenSet()

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

The name of the container that receives the override. This parameter is required if any override is specified.

Definition at line 58 of file ContainerOverride.h.

◆ operator=()

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

◆ ResourceRequirementsHasBeenSet()

bool Aws::ECS::Model::ContainerOverride::ResourceRequirementsHasBeenSet ( ) const
inline

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

Definition at line 378 of file ContainerOverride.h.

◆ SetCommand() [1/2]

void Aws::ECS::Model::ContainerOverride::SetCommand ( const Aws::Vector< Aws::String > &  value)
inline

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

Definition at line 116 of file ContainerOverride.h.

◆ SetCommand() [2/2]

void Aws::ECS::Model::ContainerOverride::SetCommand ( Aws::Vector< Aws::String > &&  value)
inline

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

Definition at line 123 of file ContainerOverride.h.

◆ SetCpu()

void Aws::ECS::Model::ContainerOverride::SetCpu ( int  value)
inline

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

Definition at line 294 of file ContainerOverride.h.

◆ SetEnvironment() [1/2]

void Aws::ECS::Model::ContainerOverride::SetEnvironment ( const Aws::Vector< KeyValuePair > &  value)
inline

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

Definition at line 183 of file ContainerOverride.h.

◆ SetEnvironment() [2/2]

void Aws::ECS::Model::ContainerOverride::SetEnvironment ( Aws::Vector< KeyValuePair > &&  value)
inline

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

Definition at line 191 of file ContainerOverride.h.

◆ SetEnvironmentFiles() [1/2]

void Aws::ECS::Model::ContainerOverride::SetEnvironmentFiles ( const Aws::Vector< EnvironmentFile > &  value)
inline

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

Definition at line 242 of file ContainerOverride.h.

◆ SetEnvironmentFiles() [2/2]

void Aws::ECS::Model::ContainerOverride::SetEnvironmentFiles ( Aws::Vector< EnvironmentFile > &&  value)
inline

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

Definition at line 248 of file ContainerOverride.h.

◆ SetMemory()

void Aws::ECS::Model::ContainerOverride::SetMemory ( int  value)
inline

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

Definition at line 326 of file ContainerOverride.h.

◆ SetMemoryReservation()

void Aws::ECS::Model::ContainerOverride::SetMemoryReservation ( int  value)
inline

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

Definition at line 356 of file ContainerOverride.h.

◆ SetName() [1/3]

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

The name of the container that receives the override. This parameter is required if any override is specified.

Definition at line 64 of file ContainerOverride.h.

◆ SetName() [2/3]

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

The name of the container that receives the override. This parameter is required if any override is specified.

Definition at line 70 of file ContainerOverride.h.

◆ SetName() [3/3]

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

The name of the container that receives the override. This parameter is required if any override is specified.

Definition at line 76 of file ContainerOverride.h.

◆ SetResourceRequirements() [1/2]

void Aws::ECS::Model::ContainerOverride::SetResourceRequirements ( const Aws::Vector< ResourceRequirement > &  value)
inline

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

Definition at line 385 of file ContainerOverride.h.

◆ SetResourceRequirements() [2/2]

void Aws::ECS::Model::ContainerOverride::SetResourceRequirements ( Aws::Vector< ResourceRequirement > &&  value)
inline

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

Definition at line 392 of file ContainerOverride.h.

◆ WithCommand() [1/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithCommand ( const Aws::Vector< Aws::String > &  value)
inline

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

Definition at line 130 of file ContainerOverride.h.

◆ WithCommand() [2/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithCommand ( Aws::Vector< Aws::String > &&  value)
inline

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

Definition at line 137 of file ContainerOverride.h.

◆ WithCpu()

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithCpu ( int  value)
inline

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

Definition at line 301 of file ContainerOverride.h.

◆ WithEnvironment() [1/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithEnvironment ( const Aws::Vector< KeyValuePair > &  value)
inline

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

Definition at line 199 of file ContainerOverride.h.

◆ WithEnvironment() [2/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithEnvironment ( Aws::Vector< KeyValuePair > &&  value)
inline

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

Definition at line 207 of file ContainerOverride.h.

◆ WithEnvironmentFiles() [1/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithEnvironmentFiles ( const Aws::Vector< EnvironmentFile > &  value)
inline

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

Definition at line 254 of file ContainerOverride.h.

◆ WithEnvironmentFiles() [2/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithEnvironmentFiles ( Aws::Vector< EnvironmentFile > &&  value)
inline

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

Definition at line 260 of file ContainerOverride.h.

◆ WithMemory()

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithMemory ( int  value)
inline

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

Definition at line 334 of file ContainerOverride.h.

◆ WithMemoryReservation()

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithMemoryReservation ( int  value)
inline

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

Definition at line 363 of file ContainerOverride.h.

◆ WithName() [1/3]

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

The name of the container that receives the override. This parameter is required if any override is specified.

Definition at line 82 of file ContainerOverride.h.

◆ WithName() [2/3]

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

The name of the container that receives the override. This parameter is required if any override is specified.

Definition at line 88 of file ContainerOverride.h.

◆ WithName() [3/3]

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

The name of the container that receives the override. This parameter is required if any override is specified.

Definition at line 94 of file ContainerOverride.h.

◆ WithResourceRequirements() [1/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithResourceRequirements ( const Aws::Vector< ResourceRequirement > &  value)
inline

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

Definition at line 399 of file ContainerOverride.h.

◆ WithResourceRequirements() [2/2]

ContainerOverride& Aws::ECS::Model::ContainerOverride::WithResourceRequirements ( Aws::Vector< ResourceRequirement > &&  value)
inline

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

Definition at line 406 of file ContainerOverride.h.


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