Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data EksContainerDetail = EksContainerDetail' {
- args :: Maybe [Text]
- command :: Maybe [Text]
- env :: Maybe [EksContainerEnvironmentVariable]
- exitCode :: Maybe Int
- image :: Maybe Text
- imagePullPolicy :: Maybe Text
- name :: Maybe Text
- reason :: Maybe Text
- resources :: Maybe EksContainerResourceRequirements
- securityContext :: Maybe EksContainerSecurityContext
- volumeMounts :: Maybe [EksContainerVolumeMount]
- newEksContainerDetail :: EksContainerDetail
- eksContainerDetail_args :: Lens' EksContainerDetail (Maybe [Text])
- eksContainerDetail_command :: Lens' EksContainerDetail (Maybe [Text])
- eksContainerDetail_env :: Lens' EksContainerDetail (Maybe [EksContainerEnvironmentVariable])
- eksContainerDetail_exitCode :: Lens' EksContainerDetail (Maybe Int)
- eksContainerDetail_image :: Lens' EksContainerDetail (Maybe Text)
- eksContainerDetail_imagePullPolicy :: Lens' EksContainerDetail (Maybe Text)
- eksContainerDetail_name :: Lens' EksContainerDetail (Maybe Text)
- eksContainerDetail_reason :: Lens' EksContainerDetail (Maybe Text)
- eksContainerDetail_resources :: Lens' EksContainerDetail (Maybe EksContainerResourceRequirements)
- eksContainerDetail_securityContext :: Lens' EksContainerDetail (Maybe EksContainerSecurityContext)
- eksContainerDetail_volumeMounts :: Lens' EksContainerDetail (Maybe [EksContainerVolumeMount])
Documentation
data EksContainerDetail Source #
The details for container properties that are returned by DescribeJobs
for jobs that use Amazon EKS.
See: newEksContainerDetail
smart constructor.
EksContainerDetail' | |
|
Instances
newEksContainerDetail :: EksContainerDetail Source #
Create a value of EksContainerDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:args:EksContainerDetail'
, eksContainerDetail_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
CMD in the
Dockerfile reference and
Define a command and arguments for a pod
in the Kubernetes documentation.
$sel:command:EksContainerDetail'
, eksContainerDetail_command
- The entrypoint for the container. For more information, see
Entrypoint
in the Kubernetes documentation.
$sel:env:EksContainerDetail'
, eksContainerDetail_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.
$sel:exitCode:EksContainerDetail'
, eksContainerDetail_exitCode
- The exit code for the job attempt. A non-zero exit code is considered
failed.
$sel:image:EksContainerDetail'
, eksContainerDetail_image
- The Docker image used to start the container.
$sel:imagePullPolicy:EksContainerDetail'
, eksContainerDetail_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.
EksContainerDetail
, eksContainerDetail_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.
$sel:reason:EksContainerDetail'
, eksContainerDetail_reason
- A short human-readable string to provide additional details for a
running or stopped container. It can be up to 255 characters long.
$sel:resources:EksContainerDetail'
, eksContainerDetail_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.
$sel:securityContext:EksContainerDetail'
, eksContainerDetail_securityContext
- The security context for a job. For more information, see
Configure a security context for a pod or container
in the Kubernetes documentation.
$sel:volumeMounts:EksContainerDetail'
, eksContainerDetail_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.
eksContainerDetail_args :: Lens' EksContainerDetail (Maybe [Text]) Source #
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
CMD in the
Dockerfile reference and
Define a command and arguments for a pod
in the Kubernetes documentation.
eksContainerDetail_command :: Lens' EksContainerDetail (Maybe [Text]) Source #
The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
eksContainerDetail_env :: Lens' EksContainerDetail (Maybe [EksContainerEnvironmentVariable]) Source #
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.
eksContainerDetail_exitCode :: Lens' EksContainerDetail (Maybe Int) Source #
The exit code for the job attempt. A non-zero exit code is considered failed.
eksContainerDetail_image :: Lens' EksContainerDetail (Maybe Text) Source #
The Docker image used to start the container.
eksContainerDetail_imagePullPolicy :: Lens' EksContainerDetail (Maybe Text) Source #
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.
eksContainerDetail_name :: Lens' EksContainerDetail (Maybe Text) Source #
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.
eksContainerDetail_reason :: Lens' EksContainerDetail (Maybe Text) Source #
A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.
eksContainerDetail_resources :: Lens' EksContainerDetail (Maybe EksContainerResourceRequirements) Source #
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.
eksContainerDetail_securityContext :: Lens' EksContainerDetail (Maybe EksContainerSecurityContext) Source #
The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.
eksContainerDetail_volumeMounts :: Lens' EksContainerDetail (Maybe [EksContainerVolumeMount]) Source #
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.