Struct EksContainerBuilder

#[non_exhaustive]
pub struct EksContainerBuilder { /* private fields */ }

A builder for EksContainer.

Implementations

impl EksContainerBuilder

pub fn name(self, input: impl Into<String>) -> Self

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 set_name(self, input: Option<String>) -> Self

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 get_name(&self) -> &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.

pub fn image(self, input: impl Into<String>) -> Self

The Docker image used to start the container.

This field is required.

pub fn set_image(self, input: Option<String>) -> Self

The Docker image used to start the container.

pub fn get_image(&self) -> &Option<String>

The Docker image used to start the container.

pub fn image_pull_policy(self, input: impl Into<String>) -> Self

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

pub fn set_image_pull_policy(self, input: Option<String>) -> Self

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

pub fn get_image_pull_policy(&self) -> &Option<String>

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

pub fn command(self, input: impl Into<String>) -> Self

Appends an item to command.

To override the contents of this collection use set_command.

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. 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) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can't be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.

pub fn set_command(self, input: Option<Vec<String>>) -> Self

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. 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) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can't be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.

pub fn get_command(&self) -> &Option<Vec<String>>

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. 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) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can't be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.

pub fn args(self, input: impl Into<String>) -> Self

Appends an item to args.

To override the contents of this collection use set_args.

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.

pub fn set_args(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_args(&self) -> &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.

pub fn env(self, input: EksContainerEnvironmentVariable) -> Self

Appends an item to env.

To override the contents of this collection use set_env.

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.

pub fn set_env( self, input: Option<Vec<EksContainerEnvironmentVariable>>, ) -> Self

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.

pub fn get_env(&self) -> &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.

pub fn resources(self, input: EksContainerResourceRequirements) -> Self

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 set_resources( self, input: Option<EksContainerResourceRequirements>, ) -> Self

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 get_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 volume_mounts(self, input: EksContainerVolumeMount) -> Self

Appends an item to volume_mounts.

To override the contents of this collection use set_volume_mounts.

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.

pub fn set_volume_mounts( self, input: Option<Vec<EksContainerVolumeMount>>, ) -> Self

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.

pub fn get_volume_mounts(&self) -> &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.

pub fn security_context(self, input: EksContainerSecurityContext) -> Self

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

pub fn set_security_context( self, input: Option<EksContainerSecurityContext>, ) -> Self

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

pub fn get_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.

pub fn build(self) -> EksContainer

Consumes the builder and constructs a EksContainer.

Trait Implementations

impl Clone for EksContainerBuilder

fn clone(&self) -> EksContainerBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EksContainerBuilder

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

Formats the value using the given formatter.

impl Default for EksContainerBuilder

fn default() -> EksContainerBuilder

Returns the “default value” for a type.

impl PartialEq for EksContainerBuilder

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