AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.Batch.Model.EksContainerDetail

Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

C#
public class EksContainerDetail

The EksContainerDetail type exposes the following members

Constructors

NameDescription
Public Method EksContainerDetail()

Properties

NameTypeDescription
Public Property Args System.Collections.Generic.List<System.String>

Gets and sets the property 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.

Public Property Command System.Collections.Generic.List<System.String>

Gets and sets the property Command.

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

Public Property Env System.Collections.Generic.List<Amazon.Batch.Model.EksContainerEnvironmentVariable>

Gets and sets the property 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.

Public Property ExitCode System.Int32

Gets and sets the property ExitCode.

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

Public Property Image System.String

Gets and sets the property Image.

The Docker image used to start the container.

Public Property ImagePullPolicy System.String

Gets and sets the property ImagePullPolicy.

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.

Public Property Name System.String

Gets and sets the property Name.

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.

Public Property Reason System.String

Gets and sets the property Reason.

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

Public Property Resources Amazon.Batch.Model.EksContainerResourceRequirements

Gets and sets the property Resources.

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.

Public Property SecurityContext Amazon.Batch.Model.EksContainerSecurityContext

Gets and sets the property SecurityContext.

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

Public Property VolumeMounts System.Collections.Generic.List<Amazon.Batch.Model.EksContainerVolumeMount>

Gets and sets the property VolumeMounts.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5