NAME
Paws::Batch::ContainerDetail
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::Batch::ContainerDetail object:
$service_obj->Method(Att1 => { Command => $value, ..., Volumes => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::Batch::ContainerDetail object:
$result = $service_obj->Method(...);
$result->Att1->CommandDESCRIPTION
An object representing the details of a container that's part of a job.
ATTRIBUTES
Command => ArrayRef[Str|Undef]
The command that's passed to the container.
ContainerInstanceArn => Str
The Amazon Resource Name (ARN) of the container instance that the container is running on.
Environment => ArrayRef[Paws::Batch::KeyValuePair]
The environment variables to pass to a container.
Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
ExecutionRoleArn => Str
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) in the AWS Batch User Guide.
ExitCode => Int
The exit code to return upon completion.
FargatePlatformConfiguration => Paws::Batch::FargatePlatformConfiguration
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
Image => Str
The image used to start the container.
InstanceType => Str
The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs running on Fargate resources.
JobRoleArn => Str
The Amazon Resource Name (ARN) associated with the job upon execution.
LinuxParameters => Paws::Batch::LinuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
LogConfiguration => Paws::Batch::LogConfiguration
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --log-driver option to docker run (https://docs.docker.com/engine/reference/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 (https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.
AWS 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 into 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the Amazon Elastic Container Service Developer Guide.
LogStreamName => Str
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 => Int
For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.
MountPoints => ArrayRef[Paws::Batch::MountPoint]
The mount points for data volumes in your container.
NetworkConfiguration => Paws::Batch::NetworkConfiguration
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
NetworkInterfaces => ArrayRef[Paws::Batch::NetworkInterface]
The network interfaces associated with the job.
Privileged => Bool
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 running on Fargate resources and shouldn't be provided, or specified as false.
ReadonlyRootFilesystem => Bool
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 (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --read-only option to docker run (https://docs.docker.com/engine/reference/commandline/run/).
Reason => Str
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
ResourceRequirements => ArrayRef[Paws::Batch::ResourceRequirement]
The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
Secrets => ArrayRef[Paws::Batch::Secret]
The secrets to pass to the container. For more information, see Specifying sensitive data (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the AWS Batch User Guide.
TaskArn => Str
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.
Ulimits => ArrayRef[Paws::Batch::Ulimit]
A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/).
This parameter isn't applicable to jobs running on Fargate resources.
User => Str
The user name to use inside the container. This parameter maps to User in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --user option to docker run (https://docs.docker.com/engine/reference/run/).
Vcpus => Int
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 resourceRequirement object. This parameter maps to CpuShares in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/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.
Volumes => ArrayRef[Paws::Batch::Volume]
A list of volumes associated with the job.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::Batch
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues