Struct EksContainerDetail

#[non_exhaustive]
pub struct EksContainerDetail {
    pub name: Option<String>,
    pub image: Option<String>,
    pub image_pull_policy: Option<String>,
    pub command: Option<Vec<String>>,
    pub args: Option<Vec<String>>,
    pub env: Option<Vec<EksContainerEnvironmentVariable>>,
    pub resources: Option<EksContainerResourceRequirements>,
    pub exit_code: Option<i32>,
    pub reason: Option<String>,
    pub volume_mounts: Option<Vec<EksContainerVolumeMount>>,
    pub security_context: Option<EksContainerSecurityContext>,
}

The details for container properties that are returned by DescribeJobs for jobs that use Amazon EKS.

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. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

image: Option<String>

The Docker image used to start the container.

image_pull_policy: Option<String>

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.

command: Option<Vec<String>>

The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.

args: Option<Vec<String>>

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.

env: Option<Vec<EksContainerEnvironmentVariable>>

The environment variables to pass to a container.

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. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

exit_code: Option<i32>

The exit code returned for the job attempt. A non-zero exit code is considered failed.

reason: Option<String>

A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

volume_mounts: Option<Vec<EksContainerVolumeMount>>

The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

security_context: Option<EksContainerSecurityContext>

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

Implementations

impl EksContainerDetail

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

The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

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

The Docker image used to start the container.

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

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.

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

The entrypoint for the container. For more information, see Entrypoint 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 .command.is_none().

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

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and 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 pass to a container.

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. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

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

The exit code returned for the job attempt. A non-zero exit code is considered failed.

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

A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

pub fn volume_mounts(&self) -> &[EksContainerVolumeMount]

The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes 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 .volume_mounts.is_none().

pub fn security_context(&self) -> Option<&EksContainerSecurityContext>

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

impl EksContainerDetail

pub fn builder() -> EksContainerDetailBuilder

Creates a new builder-style object to manufacture EksContainerDetail.

Trait Implementations

impl Clone for EksContainerDetail

fn clone(&self) -> EksContainerDetail

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EksContainerDetail

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

Formats the value using the given formatter.

impl PartialEq for EksContainerDetail

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