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", # required
  vcpus: 1, # required
  memory: 1, # required
  command: ["String"],
  job_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",
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

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

#environmentArray<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:

#imageString

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.

#job_role_arnString

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.

#memoryInteger

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.

Returns:

  • (Integer)

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

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

#privilegedBoolean

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_filesystemBoolean

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.

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

#userString

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.

#vcpusInteger

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.

Returns:

  • (Integer)

    The number of vCPUs reserved for the container.

#volumesArray<Types::Volume>

A list of data volumes used in a job.

Returns:

  • (Array<Types::Volume>)

    A list of data volumes used in a job.