Struct EksContainerOverride

#[non_exhaustive]
pub struct EksContainerOverride {
    pub name: Option<String>,
    pub image: Option<String>,
    pub command: Option<Vec<String>>,
    pub args: Option<Vec<String>>,
    pub env: Option<Vec<EksContainerEnvironmentVariable>>,
    pub resources: Option<EksContainerResourceRequirements>,
}

Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

A pointer to the container that you want to override. The name must match a unique container name that you wish to override.

image: Option<String>

The override of the Docker image that's used to start the container.

command: Option<Vec<String>>

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

args: Option<Vec<String>>

The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see Dockerfile reference: CMD and Define a command an arguments for a pod in the Kubernetes documentation.

env: Option<Vec<EksContainerEnvironmentVariable>>

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 cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

resources: Option<EksContainerResourceRequirements>

The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

Implementations

impl EksContainerOverride

pub fn name(&self) -> Option<&str>

A pointer to the container that you want to override. The name must match a unique container name that you wish to override.

pub fn image(&self) -> Option<&str>

The override of the Docker image that's used to start the container.

pub fn command(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .command.is_none().

pub fn args(&self) -> &[String]

The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see Dockerfile reference: CMD and Define a command an arguments for a pod in the Kubernetes documentation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .args.is_none().

pub fn env(&self) -> &[EksContainerEnvironmentVariable]

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 cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .env.is_none().

pub fn resources(&self) -> Option<&EksContainerResourceRequirements>

The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

impl EksContainerOverride

pub fn builder() -> EksContainerOverrideBuilder

Creates a new builder-style object to manufacture EksContainerOverride.

Trait Implementations

impl Clone for EksContainerOverride

fn clone(&self) -> EksContainerOverride

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EksContainerOverride

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for EksContainerOverride

fn eq(&self, other: &EksContainerOverride) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EksContainerOverride