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 ContainerDetail = ContainerDetail' {
- command :: Maybe [Text]
- containerInstanceArn :: Maybe Text
- environment :: Maybe [KeyValuePair]
- executionRoleArn :: Maybe Text
- exitCode :: Maybe Int
- fargatePlatformConfiguration :: Maybe FargatePlatformConfiguration
- image :: Maybe Text
- instanceType :: Maybe Text
- jobRoleArn :: Maybe Text
- linuxParameters :: Maybe LinuxParameters
- logConfiguration :: Maybe LogConfiguration
- logStreamName :: Maybe Text
- memory :: Maybe Int
- mountPoints :: Maybe [MountPoint]
- networkConfiguration :: Maybe NetworkConfiguration
- networkInterfaces :: Maybe [NetworkInterface]
- privileged :: Maybe Bool
- readonlyRootFilesystem :: Maybe Bool
- reason :: Maybe Text
- resourceRequirements :: Maybe [ResourceRequirement]
- secrets :: Maybe [Secret]
- taskArn :: Maybe Text
- ulimits :: Maybe [Ulimit]
- user :: Maybe Text
- vcpus :: Maybe Int
- volumes :: Maybe [Volume]
- newContainerDetail :: ContainerDetail
- containerDetail_command :: Lens' ContainerDetail (Maybe [Text])
- containerDetail_containerInstanceArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_environment :: Lens' ContainerDetail (Maybe [KeyValuePair])
- containerDetail_executionRoleArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_exitCode :: Lens' ContainerDetail (Maybe Int)
- containerDetail_fargatePlatformConfiguration :: Lens' ContainerDetail (Maybe FargatePlatformConfiguration)
- containerDetail_image :: Lens' ContainerDetail (Maybe Text)
- containerDetail_instanceType :: Lens' ContainerDetail (Maybe Text)
- containerDetail_jobRoleArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_linuxParameters :: Lens' ContainerDetail (Maybe LinuxParameters)
- containerDetail_logConfiguration :: Lens' ContainerDetail (Maybe LogConfiguration)
- containerDetail_logStreamName :: Lens' ContainerDetail (Maybe Text)
- containerDetail_memory :: Lens' ContainerDetail (Maybe Int)
- containerDetail_mountPoints :: Lens' ContainerDetail (Maybe [MountPoint])
- containerDetail_networkConfiguration :: Lens' ContainerDetail (Maybe NetworkConfiguration)
- containerDetail_networkInterfaces :: Lens' ContainerDetail (Maybe [NetworkInterface])
- containerDetail_privileged :: Lens' ContainerDetail (Maybe Bool)
- containerDetail_readonlyRootFilesystem :: Lens' ContainerDetail (Maybe Bool)
- containerDetail_reason :: Lens' ContainerDetail (Maybe Text)
- containerDetail_resourceRequirements :: Lens' ContainerDetail (Maybe [ResourceRequirement])
- containerDetail_secrets :: Lens' ContainerDetail (Maybe [Secret])
- containerDetail_taskArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_ulimits :: Lens' ContainerDetail (Maybe [Ulimit])
- containerDetail_user :: Lens' ContainerDetail (Maybe Text)
- containerDetail_vcpus :: Lens' ContainerDetail (Maybe Int)
- containerDetail_volumes :: Lens' ContainerDetail (Maybe [Volume])
Documentation
data ContainerDetail Source #
An object that represents the details of a container that's part of a job.
See: newContainerDetail
smart constructor.
ContainerDetail' | |
|
Instances
newContainerDetail :: ContainerDetail Source #
Create a value of ContainerDetail
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:command:ContainerDetail'
, containerDetail_command
- The command that's passed to the container.
$sel:containerInstanceArn:ContainerDetail'
, containerDetail_containerInstanceArn
- The Amazon Resource Name (ARN) of the container instance that the
container is running on.
$sel:environment:ContainerDetail'
, containerDetail_environment
- 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:executionRoleArn:ContainerDetail'
, containerDetail_executionRoleArn
- The Amazon Resource Name (ARN) of the execution role that Batch can
assume. For more information, see
Batch execution IAM role
in the Batch User Guide.
$sel:exitCode:ContainerDetail'
, containerDetail_exitCode
- The exit code to return upon completion.
$sel:fargatePlatformConfiguration:ContainerDetail'
, containerDetail_fargatePlatformConfiguration
- The platform configuration for jobs that are running on Fargate
resources. Jobs that are running on EC2 resources must not specify this
parameter.
$sel:image:ContainerDetail'
, containerDetail_image
- The image used to start the container.
$sel:instanceType:ContainerDetail'
, containerDetail_instanceType
- The instance type of the underlying host infrastructure of a multi-node
parallel job.
This parameter isn't applicable to jobs that are running on Fargate resources.
$sel:jobRoleArn:ContainerDetail'
, containerDetail_jobRoleArn
- The Amazon Resource Name (ARN) that's associated with the job when run.
$sel:linuxParameters:ContainerDetail'
, containerDetail_linuxParameters
- Linux-specific modifications that are applied to the container, such as
details for device mappings.
$sel:logConfiguration:ContainerDetail'
, containerDetail_logConfiguration
- The log configuration specification for the container.
This parameter maps to LogConfig
in the
Create a container
section of the
Docker Remote API and the
--log-driver
option to
docker run. By default,
containers use the same logging driver that the Docker daemon uses.
However, the container might use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the
container definition. To use a different logging driver for a container,
the log system must be configured properly on the container instance.
Or, alternatively, it must be configured on a different log server for
remote logging options. For more information on the options for
different supported log drivers, see
Configure logging drivers
in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command: sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers
placed on that instance can use these log configuration options. For
more information, see
Amazon ECS container agent configuration
in the Amazon Elastic Container Service Developer Guide.
$sel:logStreamName:ContainerDetail'
, containerDetail_logStreamName
- The name of the Amazon CloudWatch Logs log stream that's associated
with the container. The log group for Batch jobs is /aws/batch/job
.
Each container attempt receives a log stream name when they reach the
RUNNING
status.
$sel:memory:ContainerDetail'
, containerDetail_memory
- For jobs running on EC2 resources that didn't specify memory
requirements using resourceRequirements
, the number of MiB of memory
reserved for the job. For other jobs, including all run on Fargate
resources, see resourceRequirements
.
$sel:mountPoints:ContainerDetail'
, containerDetail_mountPoints
- The mount points for data volumes in your container.
$sel:networkConfiguration:ContainerDetail'
, containerDetail_networkConfiguration
- The network configuration for jobs that are running on Fargate
resources. Jobs that are running on EC2 resources must not specify this
parameter.
$sel:networkInterfaces:ContainerDetail'
, containerDetail_networkInterfaces
- The network interfaces that are associated with the job.
$sel:privileged:ContainerDetail'
, containerDetail_privileged
- When this parameter is true, the container is given elevated permissions
on the host container instance (similar to the root
user). The default
value is false
.
This parameter isn't applicable to jobs that are running on Fargate
resources and shouldn't be provided, or specified as false
.
$sel:readonlyRootFilesystem:ContainerDetail'
, containerDetail_readonlyRootFilesystem
- When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs
in the
Create a container
section of the
Docker Remote API and the
--read-only
option to
docker run .
$sel:reason:ContainerDetail'
, containerDetail_reason
- A short (255 max characters) human-readable string to provide additional
details for a running or stopped container.
$sel:resourceRequirements:ContainerDetail'
, containerDetail_resourceRequirements
- The type and amount of resources to assign to a container. The supported
resources include GPU
, MEMORY
, and VCPU
.
$sel:secrets:ContainerDetail'
, containerDetail_secrets
- The secrets to pass to the container. For more information, see
Specifying sensitive data
in the Batch User Guide.
$sel:taskArn:ContainerDetail'
, containerDetail_taskArn
- The Amazon Resource Name (ARN) of the Amazon ECS task that's associated
with the container job. Each container attempt receives a task ARN when
they reach the STARTING
status.
$sel:ulimits:ContainerDetail'
, containerDetail_ulimits
- A list of ulimit
values to set in the container. This parameter maps
to Ulimits
in the
Create a container
section of the
Docker Remote API and the
--ulimit
option to
docker run.
This parameter isn't applicable to jobs that are running on Fargate resources.
$sel:user:ContainerDetail'
, containerDetail_user
- The user name to use inside the container. This parameter maps to User
in the
Create a container
section of the
Docker Remote API and the
--user
option to
docker run.
$sel:vcpus:ContainerDetail'
, containerDetail_vcpus
- The number of vCPUs reserved for the container. For jobs that run on EC2
resources, you can specify the vCPU requirement for the job using
resourceRequirements
, but you can't specify the vCPU requirements in
both the vcpus
and resourceRequirements
object. This parameter maps
to CpuShares
in the
Create a container
section of the
Docker Remote API and the
--cpu-shares
option to
docker run. Each vCPU is
equivalent to 1,024 CPU shares. You must specify at least one vCPU. This
is required but can be specified in several places. It must be specified
for each node at least once.
This parameter isn't applicable to jobs that run on Fargate resources.
For jobs that run on Fargate resources, you must specify the vCPU
requirement for the job using resourceRequirements
.
$sel:volumes:ContainerDetail'
, containerDetail_volumes
- A list of volumes that are associated with the job.
containerDetail_command :: Lens' ContainerDetail (Maybe [Text]) Source #
The command that's passed to the container.
containerDetail_containerInstanceArn :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container instance that the container is running on.
containerDetail_environment :: Lens' ContainerDetail (Maybe [KeyValuePair]) 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.
containerDetail_executionRoleArn :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
containerDetail_exitCode :: Lens' ContainerDetail (Maybe Int) Source #
The exit code to return upon completion.
containerDetail_fargatePlatformConfiguration :: Lens' ContainerDetail (Maybe FargatePlatformConfiguration) Source #
The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
containerDetail_image :: Lens' ContainerDetail (Maybe Text) Source #
The image used to start the container.
containerDetail_instanceType :: Lens' ContainerDetail (Maybe Text) Source #
The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs that are running on Fargate resources.
containerDetail_jobRoleArn :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) that's associated with the job when run.
containerDetail_linuxParameters :: Lens' ContainerDetail (Maybe LinuxParameters) Source #
Linux-specific modifications that are applied to the container, such as details for device mappings.
containerDetail_logConfiguration :: Lens' ContainerDetail (Maybe LogConfiguration) Source #
The log configuration specification for the container.
This parameter maps to LogConfig
in the
Create a container
section of the
Docker Remote API and the
--log-driver
option to
docker run. By default,
containers use the same logging driver that the Docker daemon uses.
However, the container might use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the
container definition. To use a different logging driver for a container,
the log system must be configured properly on the container instance.
Or, alternatively, it must be configured on a different log server for
remote logging options. For more information on the options for
different supported log drivers, see
Configure logging drivers
in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command: sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers
placed on that instance can use these log configuration options. For
more information, see
Amazon ECS container agent configuration
in the Amazon Elastic Container Service Developer Guide.
containerDetail_logStreamName :: Lens' ContainerDetail (Maybe Text) Source #
The name of the Amazon CloudWatch Logs log stream that's associated
with the container. The log group for Batch jobs is /aws/batch/job
.
Each container attempt receives a log stream name when they reach the
RUNNING
status.
containerDetail_memory :: Lens' ContainerDetail (Maybe Int) Source #
For jobs running on EC2 resources that didn't specify memory
requirements using resourceRequirements
, the number of MiB of memory
reserved for the job. For other jobs, including all run on Fargate
resources, see resourceRequirements
.
containerDetail_mountPoints :: Lens' ContainerDetail (Maybe [MountPoint]) Source #
The mount points for data volumes in your container.
containerDetail_networkConfiguration :: Lens' ContainerDetail (Maybe NetworkConfiguration) Source #
The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
containerDetail_networkInterfaces :: Lens' ContainerDetail (Maybe [NetworkInterface]) Source #
The network interfaces that are associated with the job.
containerDetail_privileged :: Lens' ContainerDetail (Maybe Bool) Source #
When this parameter is true, the container is given elevated permissions
on the host container instance (similar to the root
user). The default
value is false
.
This parameter isn't applicable to jobs that are running on Fargate
resources and shouldn't be provided, or specified as false
.
containerDetail_readonlyRootFilesystem :: Lens' ContainerDetail (Maybe Bool) Source #
When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs
in the
Create a container
section of the
Docker Remote API and the
--read-only
option to
docker run .
containerDetail_reason :: Lens' ContainerDetail (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
containerDetail_resourceRequirements :: Lens' ContainerDetail (Maybe [ResourceRequirement]) Source #
The type and amount of resources to assign to a container. The supported
resources include GPU
, MEMORY
, and VCPU
.
containerDetail_secrets :: Lens' ContainerDetail (Maybe [Secret]) Source #
The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
containerDetail_taskArn :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated
with the container job. Each container attempt receives a task ARN when
they reach the STARTING
status.
containerDetail_ulimits :: Lens' ContainerDetail (Maybe [Ulimit]) Source #
A list of ulimit
values to set in the container. This parameter maps
to Ulimits
in the
Create a container
section of the
Docker Remote API and the
--ulimit
option to
docker run.
This parameter isn't applicable to jobs that are running on Fargate resources.
containerDetail_user :: Lens' ContainerDetail (Maybe Text) Source #
The user name to use inside the container. This parameter maps to User
in the
Create a container
section of the
Docker Remote API and the
--user
option to
docker run.
containerDetail_vcpus :: Lens' ContainerDetail (Maybe Int) Source #
The number of vCPUs reserved for the container. For jobs that run on EC2
resources, you can specify the vCPU requirement for the job using
resourceRequirements
, but you can't specify the vCPU requirements in
both the vcpus
and resourceRequirements
object. This parameter maps
to CpuShares
in the
Create a container
section of the
Docker Remote API and the
--cpu-shares
option to
docker run. Each vCPU is
equivalent to 1,024 CPU shares. You must specify at least one vCPU. This
is required but can be specified in several places. It must be specified
for each node at least once.
This parameter isn't applicable to jobs that run on Fargate resources.
For jobs that run on Fargate resources, you must specify the vCPU
requirement for the job using resourceRequirements
.
containerDetail_volumes :: Lens' ContainerDetail (Maybe [Volume]) Source #
A list of volumes that are associated with the job.