Struct aws_sdk_batch::model::ContainerOverrides

#[non_exhaustive]
pub struct ContainerOverrides {
    pub vcpus: i32,
    pub memory: 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.

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: i32

This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

memory: i32

This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

command: Option<Vec<String>>

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

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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

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 builder() -> Builder

Creates a new builder-style object to manufacture ContainerOverrides

Trait Implementations

impl Clone for ContainerOverrides

fn clone(&self) -> ContainerOverrides

Returns a copy 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<ContainerOverrides> for ContainerOverrides

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for ContainerOverrides