Struct BatchContainerOverrides

#[non_exhaustive]
pub struct BatchContainerOverrides {
    pub command: Option<Vec<String>>,
    pub environment: Option<Vec<BatchEnvironmentVariable>>,
    pub instance_type: Option<String>,
    pub resource_requirements: Option<Vec<BatchResourceRequirement>>,
}

The overrides that are sent to a container.

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.

command: Option<Vec<String>>

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

environment: Option<Vec<BatchEnvironmentVariable>>

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.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

instance_type: Option<String>

The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

resource_requirements: Option<Vec<BatchResourceRequirement>>

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

Implementations

impl BatchContainerOverrides

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

The command to send to the container that overrides the default command from the Docker image or the task 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 environment(&self) -> &[BatchEnvironmentVariable]

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.

Environment variables cannot start with "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 .environment.is_none().

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

The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

pub fn resource_requirements(&self) -> &[BatchResourceRequirement]

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

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

impl BatchContainerOverrides

pub fn builder() -> BatchContainerOverridesBuilder

Creates a new builder-style object to manufacture BatchContainerOverrides.

Trait Implementations

impl Clone for BatchContainerOverrides

fn clone(&self) -> BatchContainerOverrides

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchContainerOverrides

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

Formats the value using the given formatter.

impl PartialEq for BatchContainerOverrides

fn eq(&self, other: &BatchContainerOverrides) -> 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 BatchContainerOverrides