You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Batch::Types::ContainerProperties

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ContainerProperties as input to an Aws::Client method, you can use a vanilla Hash:

{
  image: "String",
  vcpus: 1,
  memory: 1,
  command: ["String"],
  job_role_arn: "String",
  execution_role_arn: "String",
  volumes: [
    {
      host: {
        source_path: "String",
      },
      name: "String",
    },
  ],
  environment: [
    {
      name: "String",
      value: "String",
    },
  ],
  mount_points: [
    {
      container_path: "String",
      read_only: false,
      source_volume: "String",
    },
  ],
  readonly_root_filesystem: false,
  privileged: false,
  ulimits: [
    {
      hard_limit: 1, # required
      name: "String", # required
      soft_limit: 1, # required
    },
  ],
  user: "String",
  instance_type: "String",
  resource_requirements: [
    {
      value: "String", # required
      type: "GPU", # required, accepts GPU
    },
  ],
  linux_parameters: {
    devices: [
      {
        host_path: "String", # required
        container_path: "String",
        permissions: ["READ"], # accepts READ, WRITE, MKNOD
      },
    ],
    init_process_enabled: false,
    shared_memory_size: 1,
    tmpfs: [
      {
        container_path: "String", # required
        size: 1, # required
        mount_options: ["String"],
      },
    ],
    max_swap: 1,
    swappiness: 1,
  },
  log_configuration: {
    log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
    options: {
      "String" => "String",
    },
    secret_options: [
      {
        name: "String", # required
        value_from: "String", # required
      },
    ],
  },
  secrets: [
    {
      name: "String", # required
      value_from: "String", # required
    },
  ],
}

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#command ⇒ Array<String>

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

Returns:

  • (Array<String>) —

    The command that is passed to the container.

#environment ⇒ Array<Types::KeyValuePair>

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We do not 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.

Returns:

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

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.

#image ⇒ String

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 section of the Docker Remote API and the IMAGE parameter of docker run.

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

Returns:

  • (String) —

    The image used to start a container.

#instance_type ⇒ String

The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.

Returns:

  • (String) —

    The instance type to use for a multi-node parallel job.

#job_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

#linux_parameters ⇒ Types::LinuxParameters

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

Returns:

  • (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.

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 in the Amazon Elastic Container Service Developer Guide.

Returns:

#memory ⇒ Integer

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs; it must be specified for each node at least once.

If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.

Returns:

  • (Integer) —

    The hard limit (in MiB) of memory to present to the container.

#mount_points ⇒ Array<Types::MountPoint>

The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Returns:

  • (Array<Types::MountPoint>) —

    The mount points for data volumes in your container.

#privileged ⇒ Boolean

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

Returns:

  • (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. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

Returns:

  • (Boolean) —

    When this parameter is true, the container is given read-only access to its root file system.

#resource_requirements ⇒ Array<Types::ResourceRequirement>

The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.

Returns:

#secrets ⇒ Array<Types::Secret>

The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Returns:

#ulimits ⇒ Array<Types::Ulimit>

A list of ulimits 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.

Returns:

  • (Array<Types::Ulimit>) —

    A list of ulimits to set in the container.

#user ⇒ String

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.

Returns:

  • (String) —

    The user name to use inside the container.

#vcpus ⇒ Integer

The number of vCPUs reserved for the container. 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 for multi-node parallel (MNP) jobs; it must be specified for each node at least once.

Returns:

  • (Integer) —

    The number of vCPUs reserved for the container.

#volumes ⇒ Array<Types::Volume>

A list of data volumes used in a job.

Returns:

  • (Array<Types::Volume>) —

    A list of data volumes used in a job.