Struct ContainerOverride

#[non_exhaustive]
pub struct ContainerOverride {
    pub name: Option<String>,
    pub command: Option<Vec<String>>,
    pub environment: Option<Vec<KeyValuePair>>,
    pub environment_files: Option<Vec<EnvironmentFile>>,
    pub cpu: Option<i32>,
    pub memory: Option<i32>,
    pub memory_reservation: Option<i32>,
    pub resource_requirements: Option<Vec<ResourceRequirement>>,
}

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": \[ \] }. If a non-empty container override is specified, the name parameter must be included.

You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For more information, see Retrieve secrets through environment variables in the Amazon ECS Developer Guide.

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>

The name of the container that receives the override. This parameter is required if any override is specified.

command: Option<Vec<String>>

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

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 task definition. You must also specify a container name.

environment_files: Option<Vec<EnvironmentFile>>

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

cpu: Option<i32>

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

memory: Option<i32>

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

memory_reservation: Option<i32>

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

resource_requirements: Option<Vec<ResourceRequirement>>

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

Implementations

impl ContainerOverride

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

The name of the container that receives the override. This parameter is required if any override is specified.

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. You must also specify a container name.

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) -> &[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 task definition. You must also specify a container name.

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 environment_files(&self) -> &[EnvironmentFile]

A list of files containing the environment variables to pass to a container, instead of the value from the container 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 .environment_files.is_none().

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

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

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

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

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

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

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

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

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 ContainerOverride

pub fn builder() -> ContainerOverrideBuilder

Creates a new builder-style object to manufacture ContainerOverride.

Trait Implementations

impl Clone for ContainerOverride

fn clone(&self) -> ContainerOverride

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerOverride

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

Formats the value using the given formatter.

impl PartialEq for ContainerOverride

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

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

const 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 ContainerOverride