You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Batch::Types::ContainerDetail
- Inherits:
-
Struct
- Object
- Struct
- Aws::Batch::Types::ContainerDetail
- Defined in:
- (unknown)
Overview
An object representing the details of a container that is part of a job.
Returned by:
Instance Attribute Summary collapse
-
#command ⇒ Array<String>
The command that is passed to the container.
-
#container_instance_arn ⇒ String
The Amazon Resource Name (ARN) of the container instance on which the container is running.
-
#environment ⇒ Array<Types::KeyValuePair>
The environment variables to pass to a container.
-
#execution_role_arn ⇒ String
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
-
#exit_code ⇒ Integer
The exit code to return upon completion.
-
#image ⇒ String
The image used to start the container.
-
#instance_type ⇒ String
The instance type of the underlying host infrastructure of a multi-node parallel job.
-
#job_role_arn ⇒ String
The Amazon Resource Name (ARN) associated with the job upon execution.
-
#linux_parameters ⇒ Types::LinuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
-
#log_configuration ⇒ Types::LogConfiguration
The log configuration specification for the container.
-
#log_stream_name ⇒ String
The name of the CloudWatch Logs log stream associated with the container.
-
#memory ⇒ Integer
The number of MiB of memory reserved for the job.
-
#mount_points ⇒ Array<Types::MountPoint>
The mount points for data volumes in your container.
-
#network_interfaces ⇒ Array<Types::NetworkInterface>
The network interfaces associated with the job.
-
#privileged ⇒ Boolean
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
root
user). -
#readonly_root_filesystem ⇒ Boolean
When this parameter is true, the container is given read-only access to its root file system.
-
#reason ⇒ String
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
-
#resource_requirements ⇒ Array<Types::ResourceRequirement>
The type and amount of a resource to assign to a container.
-
#secrets ⇒ Array<Types::Secret>
The secrets to pass to the container.
-
#task_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.
-
#ulimits ⇒ Array<Types::Ulimit>
A list of
ulimit
values to set in the container. -
#user ⇒ String
The user name to use inside the container.
-
#vcpus ⇒ Integer
The number of VCPUs allocated for the job.
-
#volumes ⇒ Array<Types::Volume>
A list of volumes associated with the job.
Instance Attribute Details
#command ⇒ Array<String>
The command that is passed to the container.
#container_instance_arn ⇒ String
The Amazon Resource Name (ARN) of the container instance on which the container is running.
#environment ⇒ Array<Types::KeyValuePair>
The environment variables to pass to a container.
AWS_BATCH
; this naming
convention is reserved for variables that are set by the AWS Batch
service.
#execution_role_arn ⇒ String
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role.
#exit_code ⇒ Integer
The exit code to return upon completion.
#image ⇒ String
The image used to start the container.
#instance_type ⇒ String
The instance type of the underlying host infrastructure of a multi-node parallel job.
#job_role_arn ⇒ String
The Amazon Resource Name (ARN) associated with the job upon execution.
#linux_parameters ⇒ Types::LinuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
#log_configuration ⇒ Types::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 may 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 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.
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 into your container instance and run the
following command: sudo docker version | grep "Server API version"
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.
#log_stream_name ⇒ String
The name of the CloudWatch Logs log stream associated with the
container. The log group for AWS Batch jobs is /aws/batch/job
. Each
container attempt receives a log stream name when they reach the
RUNNING
status.
#memory ⇒ Integer
The number of MiB of memory reserved for the job. This is a required parameter.
#mount_points ⇒ Array<Types::MountPoint>
The mount points for data volumes in your container.
#network_interfaces ⇒ Array<Types::NetworkInterface>
The network interfaces associated with the job.
#privileged ⇒ Boolean
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root
user).
#readonly_root_filesystem ⇒ Boolean
When this parameter is true, the container is given read-only access to its root file system.
#reason ⇒ String
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
#resource_requirements ⇒ Array<Types::ResourceRequirement>
The type and amount of a resource to assign to a container. Currently,
the only supported resource is GPU
.
#secrets ⇒ Array<Types::Secret>
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
#task_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated
with the container job. Each container attempt receives a task ARN when
they reach the STARTING
status.
#ulimits ⇒ Array<Types::Ulimit>
A list of ulimit
values to set in the container.
#user ⇒ String
The user name to use inside the container.
#vcpus ⇒ Integer
The number of VCPUs allocated for the job. This is a required parameter.
#volumes ⇒ Array<Types::Volume>
A list of volumes associated with the job.