AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | List of all members
Aws::Batch::Model::ContainerOverrides Class Reference

#include <ContainerOverrides.h>

Public Member Functions

 ContainerOverrides ()
 
 ContainerOverrides (Aws::Utils::Json::JsonView jsonValue)
 
ContainerOverridesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetVcpus () const
 
bool VcpusHasBeenSet () const
 
void SetVcpus (int value)
 
ContainerOverridesWithVcpus (int value)
 
int GetMemory () const
 
bool MemoryHasBeenSet () const
 
void SetMemory (int value)
 
ContainerOverridesWithMemory (int 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)
 
ContainerOverridesWithCommand (const Aws::Vector< Aws::String > &value)
 
ContainerOverridesWithCommand (Aws::Vector< Aws::String > &&value)
 
ContainerOverridesAddCommand (const Aws::String &value)
 
ContainerOverridesAddCommand (Aws::String &&value)
 
ContainerOverridesAddCommand (const char *value)
 
const Aws::StringGetInstanceType () const
 
bool InstanceTypeHasBeenSet () const
 
void SetInstanceType (const Aws::String &value)
 
void SetInstanceType (Aws::String &&value)
 
void SetInstanceType (const char *value)
 
ContainerOverridesWithInstanceType (const Aws::String &value)
 
ContainerOverridesWithInstanceType (Aws::String &&value)
 
ContainerOverridesWithInstanceType (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)
 
ContainerOverridesWithEnvironment (const Aws::Vector< KeyValuePair > &value)
 
ContainerOverridesWithEnvironment (Aws::Vector< KeyValuePair > &&value)
 
ContainerOverridesAddEnvironment (const KeyValuePair &value)
 
ContainerOverridesAddEnvironment (KeyValuePair &&value)
 
const Aws::Vector< ResourceRequirement > & GetResourceRequirements () const
 
bool ResourceRequirementsHasBeenSet () const
 
void SetResourceRequirements (const Aws::Vector< ResourceRequirement > &value)
 
void SetResourceRequirements (Aws::Vector< ResourceRequirement > &&value)
 
ContainerOverridesWithResourceRequirements (const Aws::Vector< ResourceRequirement > &value)
 
ContainerOverridesWithResourceRequirements (Aws::Vector< ResourceRequirement > &&value)
 
ContainerOverridesAddResourceRequirements (const ResourceRequirement &value)
 
ContainerOverridesAddResourceRequirements (ResourceRequirement &&value)
 

Detailed Description

The overrides that should be sent to a container.

See Also:

AWS API Reference

Definition at line 35 of file ContainerOverrides.h.

Constructor & Destructor Documentation

◆ ContainerOverrides() [1/2]

Aws::Batch::Model::ContainerOverrides::ContainerOverrides ( )

◆ ContainerOverrides() [2/2]

Aws::Batch::Model::ContainerOverrides::ContainerOverrides ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddCommand() [1/3]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::AddCommand ( const Aws::String value)
inline

The command to send to the container that overrides the default command from the Docker image or the job definition.

Definition at line 134 of file ContainerOverrides.h.

◆ AddCommand() [2/3]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::AddCommand ( Aws::String &&  value)
inline

The command to send to the container that overrides the default command from the Docker image or the job definition.

Definition at line 140 of file ContainerOverrides.h.

◆ AddCommand() [3/3]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::AddCommand ( const char *  value)
inline

The command to send to the container that overrides the default command from the Docker image or the job definition.

Definition at line 146 of file ContainerOverrides.h.

◆ AddEnvironment() [1/2]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::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 job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Definition at line 266 of file ContainerOverrides.h.

◆ AddEnvironment() [2/2]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::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 job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Definition at line 276 of file ContainerOverrides.h.

◆ AddResourceRequirements() [1/2]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::AddResourceRequirements ( const ResourceRequirement value)
inline

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

Definition at line 326 of file ContainerOverrides.h.

◆ AddResourceRequirements() [2/2]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::AddResourceRequirements ( ResourceRequirement &&  value)
inline

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

Definition at line 333 of file ContainerOverrides.h.

◆ CommandHasBeenSet()

bool Aws::Batch::Model::ContainerOverrides::CommandHasBeenSet ( ) const
inline

The command to send to the container that overrides the default command from the Docker image or the job definition.

Definition at line 104 of file ContainerOverrides.h.

◆ EnvironmentHasBeenSet()

bool Aws::Batch::Model::ContainerOverrides::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 job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Definition at line 216 of file ContainerOverrides.h.

◆ GetCommand()

const Aws::Vector<Aws::String>& Aws::Batch::Model::ContainerOverrides::GetCommand ( ) const
inline

The command to send to the container that overrides the default command from the Docker image or the job definition.

Definition at line 98 of file ContainerOverrides.h.

◆ GetEnvironment()

const Aws::Vector<KeyValuePair>& Aws::Batch::Model::ContainerOverrides::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 job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Definition at line 206 of file ContainerOverrides.h.

◆ GetInstanceType()

const Aws::String& Aws::Batch::Model::ContainerOverrides::GetInstanceType ( ) const
inline

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

Definition at line 153 of file ContainerOverrides.h.

◆ GetMemory()

int Aws::Batch::Model::ContainerOverrides::GetMemory ( ) const
inline

The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.

Definition at line 73 of file ContainerOverrides.h.

◆ GetResourceRequirements()

const Aws::Vector<ResourceRequirement>& Aws::Batch::Model::ContainerOverrides::GetResourceRequirements ( ) const
inline

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

Definition at line 284 of file ContainerOverrides.h.

◆ GetVcpus()

int Aws::Batch::Model::ContainerOverrides::GetVcpus ( ) const
inline

The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.

Definition at line 48 of file ContainerOverrides.h.

◆ InstanceTypeHasBeenSet()

bool Aws::Batch::Model::ContainerOverrides::InstanceTypeHasBeenSet ( ) const
inline

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

Definition at line 159 of file ContainerOverrides.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Batch::Model::ContainerOverrides::Jsonize ( ) const

◆ MemoryHasBeenSet()

bool Aws::Batch::Model::ContainerOverrides::MemoryHasBeenSet ( ) const
inline

The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.

Definition at line 79 of file ContainerOverrides.h.

◆ operator=()

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ResourceRequirementsHasBeenSet()

bool Aws::Batch::Model::ContainerOverrides::ResourceRequirementsHasBeenSet ( ) const
inline

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

Definition at line 291 of file ContainerOverrides.h.

◆ SetCommand() [1/2]

void Aws::Batch::Model::ContainerOverrides::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 job definition.

Definition at line 110 of file ContainerOverrides.h.

◆ SetCommand() [2/2]

void Aws::Batch::Model::ContainerOverrides::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 job definition.

Definition at line 116 of file ContainerOverrides.h.

◆ SetEnvironment() [1/2]

void Aws::Batch::Model::ContainerOverrides::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 job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Definition at line 226 of file ContainerOverrides.h.

◆ SetEnvironment() [2/2]

void Aws::Batch::Model::ContainerOverrides::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 job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Definition at line 236 of file ContainerOverrides.h.

◆ SetInstanceType() [1/3]

void Aws::Batch::Model::ContainerOverrides::SetInstanceType ( const Aws::String value)
inline

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

Definition at line 165 of file ContainerOverrides.h.

◆ SetInstanceType() [2/3]

void Aws::Batch::Model::ContainerOverrides::SetInstanceType ( Aws::String &&  value)
inline

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

Definition at line 171 of file ContainerOverrides.h.

◆ SetInstanceType() [3/3]

void Aws::Batch::Model::ContainerOverrides::SetInstanceType ( const char *  value)
inline

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

Definition at line 177 of file ContainerOverrides.h.

◆ SetMemory()

void Aws::Batch::Model::ContainerOverrides::SetMemory ( int  value)
inline

The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.

Definition at line 85 of file ContainerOverrides.h.

◆ SetResourceRequirements() [1/2]

void Aws::Batch::Model::ContainerOverrides::SetResourceRequirements ( const Aws::Vector< ResourceRequirement > &  value)
inline

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

Definition at line 298 of file ContainerOverrides.h.

◆ SetResourceRequirements() [2/2]

void Aws::Batch::Model::ContainerOverrides::SetResourceRequirements ( Aws::Vector< ResourceRequirement > &&  value)
inline

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

Definition at line 305 of file ContainerOverrides.h.

◆ SetVcpus()

void Aws::Batch::Model::ContainerOverrides::SetVcpus ( int  value)
inline

The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.

Definition at line 60 of file ContainerOverrides.h.

◆ VcpusHasBeenSet()

bool Aws::Batch::Model::ContainerOverrides::VcpusHasBeenSet ( ) const
inline

The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.

Definition at line 54 of file ContainerOverrides.h.

◆ WithCommand() [1/2]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::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 job definition.

Definition at line 122 of file ContainerOverrides.h.

◆ WithCommand() [2/2]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::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 job definition.

Definition at line 128 of file ContainerOverrides.h.

◆ WithEnvironment() [1/2]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::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 job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Definition at line 246 of file ContainerOverrides.h.

◆ WithEnvironment() [2/2]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::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 job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Definition at line 256 of file ContainerOverrides.h.

◆ WithInstanceType() [1/3]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::WithInstanceType ( const Aws::String value)
inline

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

Definition at line 183 of file ContainerOverrides.h.

◆ WithInstanceType() [2/3]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::WithInstanceType ( Aws::String &&  value)
inline

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

Definition at line 189 of file ContainerOverrides.h.

◆ WithInstanceType() [3/3]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::WithInstanceType ( const char *  value)
inline

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

Definition at line 195 of file ContainerOverrides.h.

◆ WithMemory()

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::WithMemory ( int  value)
inline

The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.

Definition at line 91 of file ContainerOverrides.h.

◆ WithResourceRequirements() [1/2]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::WithResourceRequirements ( const Aws::Vector< ResourceRequirement > &  value)
inline

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

Definition at line 312 of file ContainerOverrides.h.

◆ WithResourceRequirements() [2/2]

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::WithResourceRequirements ( Aws::Vector< ResourceRequirement > &&  value)
inline

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

Definition at line 319 of file ContainerOverrides.h.

◆ WithVcpus()

ContainerOverrides& Aws::Batch::Model::ContainerOverrides::WithVcpus ( int  value)
inline

The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.

Definition at line 66 of file ContainerOverrides.h.


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