Struct ContainerOverrides

#[non_exhaustive]
pub struct ContainerOverrides {
    pub vcpus: Option<i32>,
    pub memory: Option<i32>,
    pub command: Option<Vec<String>>,
    pub instance_type: Option<String>,
    pub environment: Option<Vec<KeyValuePair>>,
    pub resource_requirements: Option<Vec<ResourceRequirement>>,
}

The overrides that should be sent to a container.

For information about using Batch overrides when you connect event sources to targets, see BatchContainerOverrides.

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.

vcpus: Option<i32>

👎Deprecated: This field is deprecated, use resourceRequirements instead.

This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

memory: Option<i32>

👎Deprecated: This field is deprecated, use resourceRequirements instead.

This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement that's specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

command: Option<Vec<String>>

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

This parameter can't contain an empty string.

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.

environment: Option<Vec<KeyValuePair>>

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.

resource_requirements: Option<Vec<ResourceRequirement>>

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 ContainerOverrides

pub fn vcpus(&self) -> Option<i32>

👎Deprecated: This field is deprecated, use resourceRequirements instead.

This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

pub fn memory(&self) -> Option<i32>

👎Deprecated: This field is deprecated, use resourceRequirements instead.

This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement that's specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

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.

This parameter can't contain an empty string.

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 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 environment(&self) -> &[KeyValuePair]

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 .environment.is_none().

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

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 ContainerOverrides

pub fn builder() -> ContainerOverridesBuilder

Creates a new builder-style object to manufacture ContainerOverrides.

Trait Implementations

impl Clone for ContainerOverrides

fn clone(&self) -> ContainerOverrides

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerOverrides

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

Formats the value using the given formatter.

impl PartialEq for ContainerOverrides

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