GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::Batch::ContainerProperties(3) User Contributed Perl Documentation Paws::Batch::ContainerProperties(3)

Paws::Batch::ContainerProperties

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::ContainerProperties 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::ContainerProperties object:

  $result = $service_obj->Method(...);
  $result->Att1->Command

Container properties are used in job definitions to describe the container that's launched as part of a job.

The command that's passed to the container. This parameter maps to "Cmd" 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 "COMMAND" parameter to docker run (https://docs.docker.com/engine/reference/run/). For more information, see https://docs.docker.com/engine/reference/builder/#cmd (https://docs.docker.com/engine/reference/builder/#cmd).

The environment variables to pass to a container. This parameter maps to "Env" 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 "--env" option to docker run (https://docs.docker.com/engine/reference/run/).

We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Environment variables must not start with "AWS_BATCH"; this naming convention is reserved for variables that are set by the AWS Batch service.

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. 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.

The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with " repository-url/image:tag ". Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to "Image" 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 "IMAGE" parameter of docker run (https://docs.docker.com/engine/reference/run/).

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

  • Images in Amazon ECR repositories use the full registry and repository URI (for example, "012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>").
  • Images in official repositories on Docker Hub use a single name (for example, "ubuntu" or "mongo").
  • Images in other repositories on Docker Hub are qualified with an organization name (for example, "amazon/amazon-ecs-agent").
  • Images in other online repositories are qualified further by a domain name (for example, "quay.io/assemblyline/ubuntu").

The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.

This parameter isn't applicable to single-node container jobs or for jobs that run on Fargate resources and shouldn't be provided.

The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the Amazon Elastic Container Service Developer Guide.

Linux-specific modifications that are applied to the container, such as details for device mappings.

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 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).

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.

This parameter indicates the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it is terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

This parameter maps to "Memory" 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 "--memory" option to docker run (https://docs.docker.com/engine/reference/run/).

This parameter is supported on EC2 resources but isn't supported on Fargate resources. For Fargate resources, you should specify the memory requirement using "resourceRequirement". You can do this for EC2 resources.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the AWS Batch User Guide.

The mount points for data volumes in your container. This parameter maps to "Volumes" 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 "--volume" option to docker run (https://docs.docker.com/engine/reference/run/).

The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the "root" user). This parameter maps to "Privileged" 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 "--privileged" option to docker run (https://docs.docker.com/engine/reference/run/). 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.

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".

The type and amount of resources to assign to a container. The supported resources include "GPU", "MEMORY", and "VCPU".

The secrets for 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.

A list of "ulimits" 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 and shouldn't be provided.

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/).

The number of vCPUs reserved for the job. Each vCPU is equivalent to 1,024 CPU shares. 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/). The number of vCPUs must be specified but can be be specified in several places. You must specify it at least once for each node.

This parameter is supported on EC2 resources but isn't supported for jobs that run on Fargate resources. For these resources, use "resourceRequirement" instead. You can use this parameter or "resourceRequirements" structure but not both.

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using "resourceRequirements".

A list of data volumes used in a job.

This class forms part of Paws, describing an object used in Paws::Batch

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>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.